Setup parameters reference

  • Article

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, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

This topic lists the parameters that can be used for a silent installation. You can install any Microsoft Dynamics AX component in silent mode. For more information about how to install Microsoft Dynamics AX by using parameters, see Run Setup in silent mode.

The following installation parameters are included in this topic:

  • Common parameters

  • Analysis Services configuration parameters

  • Application Object Server parameters

  • Client parameters

  • Commerce Data Exchange: Async Client parameters

  • Commerce Data Exchange: Async Server parameters

  • Commerce Data Exchange: Real-time Service parameters

  • Commerce Data Exchange: Synch Service parameters

  • Connector parameters

  • Data Import Export Framework parameters

  • Database parameters

  • Debugger parameters

  • Enterprise Portal parameters

  • Enterprise Search parameters

  • Help Server parameters

  • Management Reporter parameters

  • Management utilities parameters

  • Modern POS parameters

  • .NET Business Connector parameters

  • Office add-ins parameters

  • Remote Desktop Services integration parameters

  • Report Designer parameters

  • Reporting Services extensions parameters

  • Retail channel database parameters

  • Retail Hardware Station parameters

  • Retail Headquarters parameters

  • Retail mass deployment toolkit

  • Retail online channel parameters

  • Retail POS parameters

  • Retail SDK parameters

  • Retail Server parameters

  • Retail Store Connect parameters

  • Retail Store Database Utility parameters

  • Retail Transaction Service parameters

  • Synchronization service and synchronization proxy parameters

  • Trace Parser parameters

  • Visual Studio Tools parameters

  • VSS writer parameters

  • Warehouse Mobile Devices Portal parameters

  • Web services on IIS parameters

Common parameters

The following table lists the parameters that control the general behavior of Setup. For example, the parameters are used to specify a parameter file, display or hide the Setup wizard, and specify the location of all related files.

Parameter

Default value

Description

AcceptLicenseTerms

0

Specify whether you want to accept the terms of the license agreement.

  • 0 – Don’t accept the license terms.

  • 1 – Accept the license terms.

If HideUI=1, AcceptLicenseTerms must be set to 1. If AcceptLicenseTerms=0, an error message is displayed, and installation can’t continue.

If HideUI=0, the License Terms screen is displayed, regardless of the setting of AcceptLicenseTerms.

Important

Only models that are published by Microsoft are covered under the license terms for Microsoft Dynamics AX.

LogDir

See the description.

Specify where the log files for the Setup, Setup Support, and Windows installers are saved.

By default, the following path is used:

%<Program Files>%\Microsoft Dynamics AX\60\Setup Logs\YYYY-MM-DD HH:MM-SS

Note

When log files are saved to the default location, they are arranged in dated folders to protect existing log files from being overwritten. If you override the default LogDir value, the logs are saved to the exact folder that you specify. Any existing log file in that folder is overwritten.

The path can be fully qualified, or it can be relative to the location of the Setup.exe file. Relative paths can include upward qualifiers, such as "..\..\".

InstallPath

%ProgramFiles%\Microsoft Dynamics AX\60

Specify the root path for all Microsoft Dynamics AX files that are installed on a computer.

InstallPath32Bit

%ProgramFiles(x86)%\Microsoft Dynamics AX\60

Specify the root path for all 32-bit Microsoft Dynamics AX files that are installed on a computer. This parameter is valid only when you install Microsoft Dynamics AX components on a 64-bit operating system. You can’t specify the same path for both 64-bit and 32-bit files.

ResetIIS

1

Specify whether you want Internet Information Services (IIS) to be restarted after Microsoft Dynamics AX is installed.

  • 0 – Restart IIS after installation.

  • 1 – Don’t restart IIS after installation.

This parameter is used when you install web services on IIS, reporting extensions, and Enterprise Portal for Microsoft Dynamics AX.

UpdatesPath

<DVD directory>\Updates

Specify the location of updates that have been downloaded for Microsoft Dynamics AX. This includes updates for the Setup application.

ConfigurePrerequisites

0

Specify whether mandatory prerequisites are installed and configured automatically as part of Setup.

  • 0 – Don’t install and configure mandatory prerequisites.

  • 1 – Install and configure all mandatory prerequisites.

Setup doesn’t automatically configure optional prerequisites.

HideUI

0

Specify whether the Setup wizard is displayed.

  • 0 – Display the wizard.

  • 1 – Hide the wizard, and run Setup in silent mode.

OptInCEIP

1

Specify whether you want to participate in the Customer Experience Improvement Program.

  • 0 – Opt in to the Customer Experience Improvement Program.

  • 1 – Don’t opt in to the Customer Experience Improvement Program.

For more information about the Customer Experience Improvement Program, see https://go.microsoft.com/fwlink/?LinkId=221577.

UseMicrosoftUpdate

0

Specify whether you want the current computer to participate in Microsoft Update.

  • 0 – Opt in to Microsoft Update.

  • 1 – Don’t opt in to Microsoft Update.

If the current computer already participates in Microsoft Update, this parameter is ignored.

ParmFile

None

Specify the path of a file that contains other parameters.

If you use this parameter, it must be the only parameter, and the parameter file must contain all the other parameters that you want to specify.

In the parameter file, each parameter's Name=Value combination must be on a separate line. You can use ExampleParmFile.txt, which is available in the DVD\Support folder, as an example.

Note

Don’t include double quotation marks in parameter files. Because line returns are used as delimiters in a parameter file, values that otherwise require double quotation marks don’t require them here.

To prevent a line in a parameter file from being run, type a number sign (#) before the line.

The path can be fully qualified, or it can be relative to the location of the Setup.exe file. Relative paths can include upward qualifiers, such as "..\..\".

AcceptBestPracticesList

This option is available only with AX 2012 R3.

0

Specify that recommended best practices have been followed.

  • 0 – Don’t accept best practices.

  • 1 – Accept best practices.

This parameter is required if InstallWarehouseServer=1.

Analysis Services configuration parameters

The following table lists the parameters that control how Setup configures Microsoft SQL Server Analysis Services for Microsoft Dynamics AX.

Parameter

Default value

Description

ConfigureAnalysisServices

0

Specify whether Analysis Services is configured for Microsoft Dynamics AX.

  • 0 – Don’t configure Analysis Services.

  • 1 – Configure Analysis Services.

AnalysisServicesInstance

<ServerName>$MSSQLServerOLAPService

Specify the instance of Analysis Services to connect to. The instance can be specified as a server, or as a fully qualified server and instance.

To specify a named instance, use the format <ServerName>$MSOLAP$<InstanceName>.

AnalysisServicesOLAPAccounts

None

Specify the account that the Analysis Services service uses to access the Microsoft Dynamics AX OLTP database. Usually, this account is the service logon account for the selected Analysis Services instance.

If you specify an account, the value must be in the format domain\account.

RemoveAnalysisServices

0

Specify whether the configuration of Analysis Services for Microsoft Dynamics AX is removed.

  • 0 – Don’t remove the Analysis Services configuration.

  • 1 – Remove the Analysis Services configuration.

Application Object Server parameters

The following table lists the parameters that control how Setup installs and removes Application Object Server (AOS).

Parameter

Default value

Description

InstallAos

0

Specify whether an instance of AOS is installed.

  • 0 – Don’t install an instance of AOS.

  • 1 – Install an instance of AOS.

If the setting of AosInstanceName matches the name of an instance that was previously installed, and InstallAos=1, the Windows installer runs in maintenance mode and doesn’t change any settings.

Up to 99 AOS instances can be installed.

AosInstanceName

MicrosoftDynamicsAx

Specify the name of the AOS instance. The name must be unique.

This parameter is required if InstallAOS=1.

You can optionally specify this parameter when you install components that require an AOS connection, such as the client.

AosPort

None

Specify the TCP/IP port number on which the AOS instance receives requests from the client or .NET Business Connector.

This parameter must be set to a numeric value between 1 and 65535.

You can optionally specify this parameter when you install components that require an AOS connection, such as the client.

AosWsdlPort

None

Specify the port number on which the AOS instance receives WSDL requests.

This parameter must be set to a numeric value between 1 and 65535.

You can optionally specify this parameter when you install components that require an AOS connection, such as the client.

AosStart

1

Specify whether Setup starts the AOS service after the AOS instance is installed.

  • 0 – Don’t start the AOS service.

  • 1 – Start the AOS service.

UpgradeAos

This option is available only with AX 2012 R3 and AX 2012 R2.

0

Specify whether an instance of AOS is upgraded.

  • 0 – Don’t upgrade an instance of AOS.

  • 1 – Upgrade an instance of AOS.

This parameter is valid only if InstallAOS=1.

When you use this parameter, you must also supply the name of an existing AOS instance by using the AosInstanceName parameter. Setup uses the registry to obtain port information for the specified AOS instance. Therefore, you don’t have to include parameters for port numbers.

AosAccount

The Network Service account

Specify the account that the Windows service for AOS runs as. The AOS instance uses this account to connect to the Microsoft Dynamics AX database.

If you specify an account, the value must be in the format domain\account. You can’t specify your own account or a local computer account. You can specify a managed service account that is installed on the computer. To specify a managed service account, use the format domain\ServiceAccountName$.

AosAccountPassword

None

Specify the password that is associated with the AOS account.

If you use a managed service account, this parameter isn’t required.

If you use a standard domain account, you must specify a value for this parameter if you specify a value for the AosAccount parameter.

AosNetTcpPort

None

Specify the port number on which the AOS instance receives net.tcp requests.

This parameter must be set to a numeric value between 1 and 65535.

AOSStartupTimeout

300

Specify how long, in seconds, Setup must wait for the AOS instance to start. Specify a value for this parameter if Setup can’t continue until the AOS instance starts, such as when you install Enterprise Portal at the same time.

Make sure that the value that you specify is large enough so that the AOS instance has time to start. If the value for this parameter is too small, some components can’t be installed.

RemoveAos

0

Specify whether an installed instance of AOS is removed.

  • 0 – Don’t remove the AOS instance.

  • 1 – Remove the AOS instance.

Client parameters

The following table lists the parameters that control how Setup installs and removes the Microsoft Dynamics AX client. You can use Setup.exe and setup parameters to perform mass deployments of clients. For more information, see Mass deployment of the Microsoft Dynamics AX Windows client.

Parameter

Default value

Description

InstallClientUI

0

Specify whether the user interface for the client is installed.

  • 0 – Don’t install the client user interface.

  • 1 – Install the client user interface.

ClientConfig

1

Specify whether the Microsoft Dynamics AX Configuration utility is installed together with the client.

If .NET Business Connector is installed, the Microsoft Dynamics AX Configuration utility is always installed.

  • 0 – Don’t install the Microsoft Dynamics AX Configuration utility.

  • 1 – Install the Microsoft Dynamics AX Configuration utility.

If ClientConfig=0, you must also specify a value for the ClientConfigFile parameter.

ClientConfigFile

None

Specify the path of a shared configuration file for the client. This path can be local or in a shared folder that has restricted permissions. When you specify this parameter, Setup configures a desktop shortcut to the client that uses the shared configuration file.

ClientLanguage

en-US

Specify the default language that is used for the client the first time that it is started, if the database hasn’t yet been initialized by the administrator.

This parameter is recognized only if the client user interface is being installed.

This parameter is ignored if the database has been initialized.

ClientAosServer

See the description.

Specify the computer that hosts the AOS instance that the client connects to.

This parameter is required if one of the following parameters is used:

  • InstallClientUI

  • InstallNetBusinessConnector

  • InstallOfficeAddins

  • InstallVisualStudioTools

  • InstallAifWebServices

  • InstallSyncService

  • InstallSynchronizationProxy

  • InstallManagementUtilities

  • ConfigureAnalysisServices

  • InstallReportingServicesExtensions

  • InstallHelpServer

  • InstallSearch

  • InstallEnterprisePortal

If an AOS instance has been specified for a component that is already installed on the computer, the registry settings that contain this information already exist. Therefore, this parameter is ignored.

If InstallAos=1, the name of the current computer is used.

If you use this parameter, you must also specify a value for AosPort and AosWsdlPort. You can optionally specify a value for AosInstance.

ClientInstallType

0

Specify the type of client that is installed.

  • 0 – Install the business user client.

  • 1 – Install the developer client.

  • 2 – Install the administrator client.

CreateClientDesktopShortcut

0

Specify whether a shortcut to the client is created on the desktop.

  • 0 – Don’t create a client shortcut on the desktop.

  • 1 – Create a client shortcut on the desktop.

RemoveClientUI

0

Specify whether components for the client user interface are removed.

  • 0 – Don’t remove components for the client user interface.

  • 1 – Remove components for the client user interface.

Commerce Data Exchange: Async Client parameters

The following table lists the parameters that control how Setup installs and removes Async Client.

Note

Async Client is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallSynchServiceClient

0

Specify whether Async Client is installed.

  • 0 – Don’t install Async Client.

  • 1 – Install Async Client.

SynchServiceClientDatabase

None

Specify the name of the message database for Async Client.

If you specify a message database name that doesn’t exist, Setup creates a new message database.

SynchServiceClientDatabaseServerName

None

Specify the name of the server that will host the message database for Async Client.

SynchServiceClientDatabaseServerInstanceName

None

If needed, specify the name of the instance of SQL Server that will host the message database for Async Client.

SynchServiceHeadOfficeUrl

None

Specify the URL for the instance of Async Server. Typically, the URL is in the format https://<ServerName>:port/<WebApplicationName>.

If Async Server is installed in a cluster that has a load balancer, enter the URL to the service on the load balancer.

SynchServiceHOUserName

None

Specify the name of the user that connects to Async Server. The user name must match the user name that is specified in the channel database profile.

If you specify a value for this parameter, you must also specify a value for the SynchServiceHOPassword parameter.

SynchServiceHOPassword

None

Specify the password for the user that connects to Async Server. The password must match the password that is specified in the channel database profile.

SynchServiceClientServiceUserName

None

Specify the user name for the user that runs the Windows service for Async Client. The user doesn’t have to be a domain account. The user can be a member of a workgroup on the local computer.

If you specify a value for this parameter, you must also specify a value for the SynchServiceClientServicePassword parameter.

SynchServiceClientServicePassword

None

Specify the password for the user that runs the Windows service for Async Client.

ChannelDatabase

None

Specify the name of the channel database that is used with this instance of Async Client.

You can connect to an existing channel database only. Setup doesn’t create a new channel database if you enter a channel database name that doesn’t exist.

ChannelDatabaseServer

None

Specify the name of the server that hosts the channel database that is used with this instance of Async Client.

ChannelDatabaseServerNamedInstanceName

None

If needed, specify the name of the instance of SQL Server that hosts the channel database that is used with this instance of Async Client.

DataStore

None

Specify the identifier in Microsoft Dynamics AX for the channel database that is used by tposhe selected instance of Async Client.

RemoveSynchServiceClient

0

Specify whether Async Client is removed.

  • 0 – Don’t remove Async Client.

  • 1 – Remove Async Client.

Commerce Data Exchange: Async Server parameters

The following table lists the parameters that control how Setup installs and removes Async Server.

Note

Async Server is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallSynchServiceHeadOffice

0

Specify whether Async Server is installed.

  • 0 – Don’t install Async Server.

  • 1 – Install Async Server.

SynchServiceHeadOfficeHttpsPort

None

Specify the port on which Async Server receives HTTPS requests.

SynchServiceHeadOfficeApplicationName

None

Specify the name of the web application that hosts Async Server.

SynchServiceHeadOfficeAppPoolName

None

Specify the name of the application pool that the web application runs under.

SynchServiceHeadOfficeWebsiteName

None

Specify the name of the website that Async Server runs on.

SynchServiceHeadOfficeUsername

None

Specify the name of the user that runs the application pool for Async Server.

If you specify a value for this parameter, you must also specify a value for the SynchServiceHeadOfficePassword parameter.

SynchServiceHeadOfficePassword

None

Specify the password of the user that runs the application pool for Async Server.

This parameter is required if you specify a value for the SynchServiceHeadOfficeUsername parameter.

SynchServiceHeadOfficeSslCertThumbprint

None

Specify the thumbprint for the Secure Sockets Layer (SSL) encryption certificate. You must obtain a valid, registered certificate from a provider.

SynchServiceHeadOfficeDatabase

None

Specify the name of the message database that is used with this instance of Async Server.

SynchServiceHeadOfficeDatabaseServerName

None

Specify the name of the server that hosts the message database that is used with this instance of Async Server.

SynchServiceDatabaseServerInstanceName

None

If needed, specify the name of the instance of SQL Server that hosts the message database that is used with this instance of Async Server.

SynchServiceHeadOfficeTcpPort

None

(Optional) Specify the port on which Async Server receives TCP requests. Specify a TCP port if your environment uses high-performance data synchronization.

SynchServiceHeadOfficeAOSServiceUser

None

Specify the user account that the instance of Microsoft Dynamics AX AOS runs as.

RemoveSynchServiceHeadOffice

0

Specify whether Async Server is removed.

  • 0 – Don’t remove Async Server.

  • 1 – Remove Async Server.

Commerce Data Exchange: Real-time Service parameters

The following table lists the parameters that control how Setup installs and removes Real-time Service.

These parameters apply only to Real-time Service in Microsoft Dynamics AX 2012 R2 or AX 2012 R3. In Microsoft Dynamics AX 2012 Feature Pack, Real-time Service is called Retail Transaction Service, and the parameter names are different. For more information, see Retail Transaction Service parameters.

Parameter

Default value

Description

InstallCDERS

0

Specify whether Real-time Service is installed.

  • 0 – Don’t install Real-time Service.

  • 1 – Install Real-time Service.

RealtimeServiceApplicationName

None

Specify the name of the web application that hosts Real-time Service.

RealtimeServiceWebsiteName

None

Specify the name of the website that Real-time Service runs on.

RealtimeServiceAppPoolName

None

Specify the name of the application pool that the web application runs under.

RealtimeServiceAppPoolUsername

None

Specify the name of the user that runs the application pool for Real-time Service.

If you specify a value for this parameter, you must also specify a value for the RealtimeServiceAppPoolPassword parameter.

RealtimeServiceAppPoolPassword

None

Specify the password that is associated with the account that runs the application pool.

You must specify a value for this parameter if you specify a value for the RealtimeServiceAppPoolUsername parameter.

RealtimeServiceHttpsPort

None

Specify the port on which Real-time Service receives HTTPS requests.

RealtimeServiceSslCertThumbprint

None

Specify the thumbprint for the Secure Sockets Layer (SSL) encryption certificate. You must obtain a valid, registered certificate from a provider.

RealtimeServiceTcpPort

None

Specify the port number on which Real-time Service receives net.tcp requests.

RemoveCDERS

0

Specify whether Real-time Service is removed.

  • 0 – Don’t remove Real-time Service.

  • 1 – Remove Real-time Service.

Commerce Data Exchange: Synch Service parameters

The following table lists the parameters that control how Setup installs and removes Synch Service.

These parameters apply only to Synch Service in Microsoft Dynamics AX 2012 R2. In Microsoft Dynamics AX 2012 Feature Pack, Synch Service is called Retail Store Connect, and the parameter names are different. For more information, see Retail Store Connect parameters.

Parameter

Default value

Description

InstallCDESS

0

Specify whether Synch Service is installed.

  • 0 – Don’t install Synch Service.

  • 1 – Install Synch Service.

CDESSDBServerName

None

Specify the name of the server where the message database for Synch Service will be created.

CDESSDatabaseName

None

Specify the name of the SQL Server database to create for Synch Service messages.

CDESSUsername

None

Specify the account that the Windows service for Synch Service runs as.

If you specify a value for this parameter, you must also specify a value for the CDESSPassword parameter.

CDESSPassword

None

Specify the password that is associated with the account that runs the Windows service for Synch Service.

This parameter is required if you specify a value for the CDESSUsername parameter.

RemoveCDESS

0

Specify whether Synch Service is removed.

  • 0 – Don’t remove Synch Service.

  • 1 – Remove Synch Service.

Connector parameters

The following table lists the parameters that control how Setup installs and removes Connector for Microsoft Dynamics.

Note

Connector is available through Setup only in Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012 R2.

Parameter

Default value

Description

InstallConnector

0

Specify whether Connector is installed.

  • 0 – Don’t install Connector.

  • 1 – Install Connector.

ConnectorAosName

None

Specify the name of the server that hosts the AOS instance that Connector will connect to.

ConnectorAosPort

None

Specify the port number on which the AOS instance that is used by Connector receives TCP/IP requests.

This parameter must be set to a numeric value between 1 and 65535.

IntegrationUserAccount

None

Specify the account that is used to run integrations between Microsoft Dynamics CRM and Microsoft Dynamics AX.

If you specify an account, the value must be in the format domain\account.

If you specify a value for this parameter, you must also specify a value for the IntegrationUserPassword parameter.

IntegrationUserPassword

None

Specify the password that is associated with the Connector integration account.

You must specify a value for this parameter if you specify a value for the IntegrationUserAccount parameter.

IntegrationUserId

AXIntUsr

Enter the Microsoft Dynamics AX user ID of the integration user.

UseExistingAccount

0

Specify whether the integration user account already exists in Microsoft Dynamics AX.

  • 0 – Don’t use an existing account.

  • 1 – Use an existing account.

ConnectorServerName

None

Specify the name of the database server that will host the Microsoft Dynamics Integration (MSDI) database.

Note

The MSDI database isn’t required to be on the same computer as Connector for Microsoft Dynamics.

RemoveConnector

0

Specify whether Connector is removed.

  • 0 – Don’t remove Connector.

  • 1 – Remove Connector.

Data Import Export Framework parameters

The following table lists the parameters that control how Setup installs and removes the components of Data Import Export Framework.

Note

Data Import Export Framework is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallDIXFService

0

Specify whether the Data Import Export Framework service is installed.

  • 0 – Don’t install the Data Import Export Framework service.

  • 1 – Install the Data Import Export Framework service.

DIXFServiceAccount

None

Specify the account that is used to run the Data Import Export Framework service. We recommend that you use the same service account as that used for the AOS service.

If you specify an account, the value must be in the format domain\account.

If you specify a value for this parameter, you must also specify a value for the DIXFServiceAccountPassword parameter.

DIXFServiceAccountPassword

None

Specify the password that is associated with the Data Import Export Framework service account.

You must specify a value for this parameter if you specify a value for the DIXFServiceAccount parameter.

DIXFHostName

None

Specify the name of the server that runs the Data Import Export Framework service.

This parameter is required if InstallDIXFServer=1 or InstallDIXFClient=1.

InstallDIXFServer

0

Specify whether the AOS component of Data Import Export Framework is installed.

  • 0 – Don’t install the AOS component of Data Import Export Framework.

  • 1 – Install the AOS component of Data Import Export Framework.

InstallDIXFClient

0

Specify whether the client component of Data Import Export Framework is installed.

  • 0 – Don’t install the client component of Data Import Export Framework.

  • 1 – Install the client component of Data Import Export Framework.

RemoveDIXFService

0

Specify whether the Data Import Export Framework service is removed.

  • 0 – Don’t remove the Data Import Export Framework service.

  • 1 – Remove the Data Import Export Framework service.

RemoveDIXFServer

0

Specify whether the AOS component of Data Import Export Framework is removed.

  • 0 – Don’t remove the AOS component of Data Import Export Framework.

  • 1 – Remove the AOS component of Data Import Export Framework.

RemoveDIXFClient

0

Specify whether the client component of Data Import Export Framework is removed.

  • 0 – Don’t remove the client component of Data Import Export Framework.

  • 1 – Remove the client component of Data Import Export Framework.

Database parameters

The following table lists the parameters that control how Setup interacts with the Microsoft Dynamics AX databases.

Parameter

Default value

Description

InstallDatabase

0

Specify whether the Microsoft Dynamics AX database is created.

  • 0 – Don’t create the database.

  • 1 – Create the database, unless a database of the same name already exists.

  • 2 – Create or replace the database.

DbSqlServer

The default database instance on the local computer

Specify the instance of SQL Server to connect to. The instance can be specified as a server, or as a fully qualified server and instance.

This parameter is valid and required only if InstallDatabase > 0, or if InstallAos=1.

DbSqlDatabaseName

MicrosoftDynamicsAx

Specify the name of the SQL Server database.

The database name must not include spaces or any of the following characters: backslashes (\), slashes (/), periods (.), commas (,), colons (:), brackets ([ ]), parentheses (( )), or hyphens (-).

This parameter is valid and required only if InstallDatabase > 0.

SkipSignatureVerification

0

Specify whether digital signatures for model files are verified.

  • 0 – Verify digital signatures for model files.

  • 1 – Don’t verify digital signatures for model files.

Security noteSecurity Note

If you import an unsigned model file to the model store, you create a security risk. We recommend that you not use this parameter unless you are confident that a model file is safe to install.

DbSqlModelStoreBaseline

MicrosoftDynamicsAxBaseline

Specify the name of the database that is used for the baseline model store.

Warning

Don’t use this parameter. We recommend that you install the baseline model store by using the Setup wizard.

DbConnectionTimeout

The default value for the database

Specify the time-out value for the database connection. The value that you set overrides the default value for the database connection time-out, 30 seconds. In most cases, we recommend that you not change this value. However, if the database server is on a remote computer, you may have to increase the time that is allowed for Setup to connect to the database.

AdditionalModelFiles

None

Specify the optional models to install. To include multiple model files, separate the values by using a semicolon (;). If this parameter isn’t specified, no optional models are installed.

If an optional model file isn’t located in the DVD\Models folder, you must specify the full path of the file.

For example: AdditionalModelFiles=<Drive>:\<FolderLocation>\<model>.model

Important

Only models that are published by Microsoft are covered under the license terms for Microsoft Dynamics AX.

UpgradeDB

0

Specify whether the database that an AOS instance connects to is marked for upgrade.

  • 0 – Don’t mark the database for an upgrade.

  • 1 – Mark the database for an upgrade.

When you use this parameter, you must also supply the name of an AOS instance by using the AosInstanceName parameter. Setup uses the registry to obtain port information for the specified AOS instance. Therefore, you don’t have to include parameters for port numbers.

ModelStoreBackupDir

This option is available only with AX 2012 R3 and AX 2012 R2.

None

Specify the location where the model store backup file is created during a database upgrade.

Make sure to select a drive with sufficient disk space for the model store backup.

If you specify a value for this parameter, you don’t have to specify a value for the parameter ModelStoreBackupFile.

ModelStoreBackupFile

This option is available only with AX 2012 R3 and AX 2012 R2.

None

Use this parameter to import an existing model store backup file that has already been upgraded. Setup will import the backup file into the model store.

If you specify a value for this parameter, you don’t have to specify a value for the parameter ModelStoreBackupDir.

Debugger parameters

The following table lists the parameters that control how Setup installs and removes the Microsoft Dynamics AX debugger.

Parameter

Default value

Description

InstallDebugger

0

Specify whether the debugger is installed.

  • 0 – Don’t install the debugger.

  • 1 – Install the debugger.

The debugger can be installed only one time.

RemoveDebugger

0

Specify whether the debugger is removed.

  • 0 – Don’t remove the debugger.

  • 1 – Remove the debugger.

Enterprise Portal parameters

The following table lists the parameters that control how Setup installs and removes Enterprise Portal.

Parameter

Default value

Description

InstallEnterprisePortal

0

Specify whether components for Enterprise Portal are installed.

  • 0 – Don’t install Enterprise Portal.

  • 1 – Install Enterprise Portal.

EnterprisePortalWebSite

None

Specify the website that is configured for Enterprise Portal on the local computer. This parameter is required if InstallEnterprisePortal=1.

EnterprisePortalCreateWebSite

1

Specify whether a website for Enterprise Portal is configured by using Microsoft SharePoint 2013 Products:

  • 0 – Don’t create a site.

  • 1 – Create a site.

  • 2 – Overwrite the existing site.

Note

If you use this parameter when you install Enterprise Portal, you can use only one URL per website. If you want to use multiple URLs for a website, you must install Enterprise Portal by using the Setup wizard.

EnterprisePortalConfigureForWss

1

Specifies whether to configure the virtual server for Enterprise Portal.

  • 0 – Don’t configure the virtual server.

  • 1 – Configure the virtual server.

If this parameter is set to 1, Setup configures the application pool to run as the user of the .NET Business Connector proxy. Additionally, Setup verifies that NTLM authentication is enabled.

RemoveEnterprisePortal

0

Specify whether an installed instance of Enterprise Portal is removed.

  • 0 – Don’t remove Enterprise Portal.

  • 1 – Remove Enterprise Portal.

Enterprise Search parameters

The following table lists the parameters that control how Setup installs and removes Enterprise Search.

Parameter

Default value

Description

InstallSearch

0

Specify whether Enterprise Search is installed.

  • 0 – Don’t install Enterprise Search.

  • 1 – Install Enterprise Search.

ContentAccessAccount

None

Specify the account that the search service runs as. Enterprise Search uses this account to crawl the data in the Microsoft Dynamics AX database.

If you specify an account, the value must be in the format domain\account.

You can’t specify your own account or a local computer account.

If you specify a value for this parameter, you must also specify a value for the ContentAccessAccountPassword parameter.

ContentAccessAccountPassword

None

Specify the password that is associated with the account for the search crawler.

If you use a standard domain account, you must specify a value for this parameter if you specify a value for the ContentAccessAccount parameter.

RemoveSearch

0

Specify whether an installed instance of Enterprise Search is removed.

  • 0 – Don’t remove Enterprise Search.

  • 1 – Remove Enterprise Search.

Help Server parameters

The following table lists the parameters that control how Setup installs and removes Help Server.

Parameter

Default value

Description

InstallHelpServer

0

Specify whether Help Server is installed.

  • 0 – Don’t install Help Server.

  • 1 – Install Help Server.

If you install Help Server, you must also specify a value for ClientAosServer.

HelpServerWebSite

0

Specify the website that is configured for Help Server on the local computer. This parameter is required if InstallHelpServer=1.

HelpServerPhysicalDirectory

0

Specify the location of the physical directory of the website.

HelpServerAccount

0

Specify the account that is used for the application pool of the Help Server website.

If you specify an account, the value must be in the format domain\account.

You can’t specify your own account or a local computer account.

If you specify a value for this parameter, you must also specify a value for the HelpServerAccountPassword parameter.

HelpServerAccountPassword

0

Specify the password that is associated with the account for the Help Server application pool. Help Server uses this account to access the Help content on the web server.

If you use a standard domain account, you must specify a value for this parameter if you specify a value for the HelpServerAccount parameter.

HelpServerInstallContent

None

Specify the Help collections and languages that are installed.

To include multiple collections or languages, separate the values by using a semicolon (;).

The U.S. English (en) version of the Application user Help collection is required. If you install another language, and the required collection was not previously installed, the collection is automatically installed together with the language that you install.

RemoveHelpServer

0

Specify whether Help Server is removed.

  • 0 – Don’t remove Help Server.

  • 1 – Remove Help Server and all Help content that was provided by Microsoft. Customized Help content that was created for your organization isn’t removed.

Management Reporter parameters

The following table lists the parameters that control how Setup installs and removes Management Reporter for Microsoft Dynamics ERP.

Note

Management Reporter for Microsoft Dynamics ERP is available through Setup only in Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012 R2.

Parameter

Default value

Description

InstallManagementReporter

0

Specify whether Management Reporter is installed.

  • 0 – Don’t install Management Reporter

  • 1 – Install Management Reporter.

When you install Management Reporter, you must specify values for the parameters DbSqlServer and DbSqlDatabaseName.

ManagementReporterServerPort

4712

Specify the port that Management Reporter uses for communication.

ManagementAosServer

None

Specify the name of the server that hosts the AOS instance that Management Reporter will connect to.

ManagementAosPort

None

Specify the port number on which the AOS instance that is used by Management Reporter receives TCP/IP requests.

This parameter must be set to a numeric value between 1 and 65535.

ManagementAosNetTcpPort

None

Specify the port number on which the AOS instance that is used by Management Reporter receives net.tcp requests.

This parameter must be set to a numeric value between 1 and 65535.

DataMartDbName

ManagementReporterDM

Specify the name of the database that hosts the data mart for the Management Reporter integration.

ManagementReporterDbName

ManagementReporter

Specify the name of the Management Reporter database.

IntegrationUserAccount

None

Specify the account that is used to run integrations between Management Reporter and Microsoft Dynamics AX.

If you specify an account, the value must be in the format domain\account.

If you specify a value for this parameter, you must also specify a value for the IntegrationUserPassword parameter.

IntegrationUserPassword

None

Specify the password that is associated with the Management Reporter integration account.

You must specify a value for this parameter if you specify a value for the IntegrationUserAccount parameter.

IntegrationUserId

AXIntUsr

Enter the Microsoft Dynamics AX user ID of the integration user.

UseExistingAccount

0

Specify whether the integration user account already exists in Microsoft Dynamics AX.

  • 0 – Don’t use an existing account.

  • 1 – Use an existing account.

ManagementServiceUserAccount

None

Specify the service account for Management Reporter. We recommend that you use the AOS service account.

If you specify an account, the value must be in the format domain\account.

If you specify a value for this parameter, you must also specify a value for the ManagementServiceUserPassword parameter.

ManagementServiceUserPassword

None

Specify the password that is associated with the Management Reporter service account.

You must specify a value for this parameter if you specify a value for the ManagementServiceUserAccount parameter.

RemoveManagementReporter

0

Specify whether Management Reporter is removed.

  • 0 – Don’t remove Management Reporter.

  • 1 – Remove Management Reporter.

Management utilities parameters

The following table lists the parameters that control how Setup installs and removes the management utilities.

Parameter

Default value

Description

InstallManagementUtilities

0

Specify whether the management utilities are installed.

  • 0 – Don’t install the management utilities.

  • 1 – Install the management utilities.

RemoveManagementUtilities

0

Specify whether the management utilities are removed.

  • 0 – Don’t remove the management utilities.

  • 1 – Remove the management utilities.

Retail Modern POS parameters

The following table lists the parameters that control how Setup installs and removes Retail Modern POS.

Note

Retail Modern POS is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallRetailModernPOS

0

Specify whether Retail Modern POS files are installed.

  • 0 – Don’t install Retail Modern POS files.

  • 1 – Install Retail Modern POS files.

If InstallRetailModernPOS=1, the installation files are extracted, but the app isn’t installed or configured. To fully install and configure Retail Modern POS, you must also include the parameter RetailModernPOSIsConfigured=True.

RetailModernPOSIsConfigured

None

Specify whether the Retail Modern POS app is configured.

Set this parameter to True to configure the Retail Modern POS app. Always use this parameter together with the InstallRetailModernPOS parameter.

Omit this parameter if you don’t want to configure the Retail Modern POS app.

RetailModernPOSSideloadingKey

None

If necessary, specify a sideloading key to deploy the app.

A sideloading key may be required when you install Retail Modern POS on devices that are not joined to a domain.

RemoveRetailModernPOS

0

Specify whether Retail Modern POS is removed.

  • 0 – Don’t remove Retail Modern POS.

  • 1 – Remove Retail Modern POS.

.NET Business Connector parameters

The following table lists the parameters that control how Setup installs and removes components for .NET Business Connector.

Parameter

Default value

Description

InstallNetBusinessConnector

0

Specify whether .NET Business Connector is installed.

  • 0 – Don’t install .NET Business Connector.

  • 1 – Install .NET Business Connector.

.NET Business Connector can be installed only one time.

BusinessConnectorProxyAccount

None

Specify the account that is used as the .NET Business Connector proxy.

This parameter is required if InstallTraceParser=1.

If you specify a value for this parameter, you must also specify a value for the BusinessConnectorProxyAccountPassword parameter.

BusinessConnectorProxyAccountPassword

None

Specify the password that is associated with the account for the .NET Business Connector proxy.

If you use a standard domain account, this parameter is required if the BusinessConnectorProxyAccount parameter is required. If a value is specified for this parameter, the value can’t be blank.

RemoveNetBusinessConnector

0

Specify whether .NET Business Connector is removed.

  • 0 – Don’t remove .NET Business Connector.

  • 1 – Remove .NET Business Connector.

Office Add-ins parameters

The following table lists the parameters that control how Setup installs and removes Office Add-ins for Microsoft Dynamics AX.

Parameter

Default value

Description

InstallOfficeAddins

0

Specify whether Office Add-ins are installed.

  • 0 – Don’t install Office Add-ins.

  • 1 – Install Office Add-ins.

If InstallOfficeAddins=1, the components for the Remote Desktop Services integration are also installed automatically.

RemoveOfficeAddins

0

Specify whether Office Add-ins are removed.

  • 0 – Don’t remove Office Add-ins.

  • 1 – Remove Office Add-ins.

Remote Desktop Services integration parameters

The following table lists the parameters that control how Setup installs and removes the Remote Desktop Services integration.

Parameter

Default value

Description

InstallRemoteDesktopServicesIntegration

0

Specify whether the Remote Desktop Services integration is installed.

  • 0 – Don’t install the Remote Desktop Services integration.

  • 1 – Install the Remote Desktop Services integration.

If InstallOfficeAddins=1, the components for the Remote Desktop Services integration are installed automatically.

RemoveRemoteDesktopServicesIntegration

0

Specify whether the Remote Desktop Services integration is removed.

  • 0 – Don’t remove the Remote Desktop Services integration.

  • 1 – Remove the Remote Desktop Services integration.

Report Designer parameters

The following table lists the parameters that control how Setup installs and removes Report Designer for Management Reporter.

Note

Report Designer is available through Setup only in Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012 R2.

Parameter

Default value

Description

InstallReportDesigner

0

Specify whether Report Designer is installed.

  • 0 – Don’t install Report Designer

  • 1 – Install Report Designer.

ManagementReporterServer

None

Specify the name of the server where Management Reporter is installed. This parameter is required only if InstallReportDesigner = 1.

If you specify a value for this parameter, you must also specify a value for ManagementReporterServerPort.

RemoveReportDesigner

0

Specify whether Report Designer is removed.

  • 0 – Don’t remove Report Designer.

  • 1 – Remove Report Designer.

Reporting Services extensions parameters

The following table lists the parameters that control how Setup installs and removes the reporting extensions for Microsoft SQL Server Reporting Services.

Parameter

Default value

Description

InstallReportingServicesExtensions

0

Specify whether the reporting extensions are installed.

  • 0 – Don’t install the reporting extensions.

  • 1 – Install the reporting extensions.

Reporting Services extensions can be installed only one time.

ReportingServicesInstance

The first instance of Reporting Services

Specify the instances of Reporting Services that are configured. This parameter is required if more than one instance of Reporting Services is installed on a computer.

Note

If you specify a named instance, you must type the name by using all uppercase letters.

RemoveReportingServicesExtensions

0

Specify whether the reporting extensions are removed.

  • 0 – Don’t remove the reporting extensions.

  • 1 – Remove the reporting extensions.

Retail Channel Configuration Utility (Retail Store Database Utility) parameters

The following table lists the parameters that control how Setup installs and removes the Retail Channel Configuration Utility.

Note

In AX 2012 R2 and AX 2012 Feature Pack, the Retail Channel Configuration Utility is called the Retail Store Database Utility.

Parameter

Default value

Description

InstallRetailStoreDBUtil

0

Specify whether the Retail Channel Configuration Utility is installed.

  • 0 – Don’t install the Retail Channel Configuration Utility.

  • 1 – Install the Retail Channel Configuration Utility.

RemoveRetailStoreDBUtil

0

Specify whether the Retail Channel Configuration Utility is removed.

  • 0 – Don’t remove the Retail Channel Configuration Utility.

  • 1 – Remove the Retail Channel Configuration Utility.

Retail channel database parameters

The following table lists the parameters that control how Setup installs and removes a retail channel database.

Note

Retail channel database is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallRetailChannelDatabase

0

Specify whether a retail channel database is installed.

  • 0 – Don’t install a retail channel database.

  • 1 – Install a retail channel database.

ChannelDatabaseName

None

Specify the name of the SQL Server database.

This parameter is required if InstallRetailChannelDatabase=1.

ChannelDatabaseServerName

None

Specify the name of the server that hosts the channel database.

ChannelDatabaseServerInstanceName

None

If needed, specify the name of the instance of SQL Server that will host the channel database.

RemoveRetailChannelDatabase

0

Specify whether a retail channel database is removed.

  • 0 – Don’t remove a retail channel database.

  • 1 – Remove a retail channel database

Retail Hardware Station parameters

The following table lists the parameters that control how Setup installs and removes Retail Hardware Station.

Note

Retail Hardware Station is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallRetailHardwareStation

0

Specify whether a Retail Hardware Station is installed.

  • 0 – Don’t install a Retail Hardware Station.

  • 1 – Install a Retail Hardware Station.

RetailHardwareStationHttpsPort

None

Specify the port on which Retail Hardware Station receives HTTPS requests.

RetailHardwareStationHttpPort

None

Specify the port on which Retail Hardware Station receives HTTP requests.

RetailHardwareStationApplicationName

None

Specify the name of the web application that hosts Retail Hardware Station.

RetailHardwareStationAppPoolName

None

Specify the name of the application pool that the web application runs under.

RetailHardwareStationWebsiteName

None

Specify the name of the website that Retail Hardware Station runs on.

RetailHardwareStationAppPoolUsername

None

Specify the name of the user that runs the application pool for Retail Hardware Station.

If you specify a value for this parameter, you must also specify a value for the RetailHardwareStationAppPoolPassword parameter.

RetailHardwareStationAppPoolPassword

None

Specify the password that is associated with the account that runs the application pool.

You must specify a value for this parameter if you specify a value for the RetailHardwareStationAppPoolUsername parameter.

RetailHardwareStationSslCertThumbprint

None

Specify the thumbprint for the Secure Sockets Layer (SSL) encryption certificate. You must obtain a valid, registered certificate from a provider.

RemoveRetailHardwareStation

0

Specify whether a Retail Hardware Station is removed.

  • 0 – Don’t remove a Retail Hardware Station.

  • 1 – Remove a Retail Hardware Station.

Retail headquarters parameters

The following table lists the parameters that control how Setup installs and removes Retail Headquarters.

Parameter

Default value

Description

InstallRetailHQ

0

Specify whetherRetail Headquarters is installed.

  • 0 – Don’t install Retail Headquarters.

  • 1 – Install Retail Headquarters.

UninstallRetailHQ

0

Specify whether Retail Headquarters is removed.

  • 0 – Don’t remove Retail Headquarters.

  • 1 – Remove Retail Headquarters.

Retail mass deployment toolkit parameters

The following table lists the parameters that control how Setup installs and removes the Retail mass deployment toolkit.

Note

Retail mass deployment toolkit is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallRetailScaleOutDeployment

0

Specify whether the Retail mass deployment toolkit is installed.

  • 0 – Don’t install the Retail mass deployment toolkit.

  • 1 – Install the Retail mass deployment toolkit.

RemoveRetailScaleoutDeployment

0

Specify whether the Retail mass deployment toolkit is removed.

  • 0 – Don’t remove the Retail mass deployment toolkit.

  • 1 – Remove the Retail mass deployment toolkit.

Retail online channel parameters

The following table lists the parameters that control how Setup installs and removes Retail online channel.

Note

Retail online channel is available through Setup only in Microsoft Dynamics AX 2012 R2 or AX 2012 R3. In AX 2012 R2, only the InstallRetailOC and RemoveRetailOC parameters are available.

Parameter

Default value

Description

InstallRetailOC

0

Specify whether Retail online channel is installed.

  • 0 – Don’t install Retail online channel.

  • 1 – Install Retail online channel.

RetailOCChannelOperatingUnitNumber

None

Specify the identifier of the channel operating unit.

A channel operating unit number is specified when you create an online channel in Microsoft Dynamics AX. You must create the channel before you deploy the Retail online store. To locate the operating unit number, click Retail > Retail channels > Online stores.

RetailOCSSLCertPassword

None

Specify the password for the .pfx file.

RetailOCSSLCertPath

None

Specify the path of the .pfx file for the SSL certificate.

RetailOCPassword

None

Specify the password that is associated with the account.

You must specify a value for this parameter if you specify a value for the RetailOCUserName parameter.

RetailOCUserName

None

Specify the name of a domain user that has permission to create web applications and run Windows PowerShell scripts in SharePoint.

If you specify a value for this parameter, you must also specify a value for the RetailOCPassword parameter.

RetailOCChannelDBName

None

Specify the name of the channel database that is used with the online store.

You can connect to an existing channel database only. Setup doesn’t create a new channel database if you enter a channel database name that doesn’t exist.

RetailOCDBServer

None

Specify the name of the server that hosts the channel database.

RetailOCDBServerNamedInstanceName

If needed, specify the name of the instance of SQL Server that hosts the channel database that is used with this instance of online store.

RetailOCStorefrontName

None

Specify a Retail starter store to deploy.

  • Contoso – Deploy the Contoso store. The Contoso starter store is modeled after an online electronics retailer.

  • Fabrikam – Deploy the Fabrikam store. The Fabrikam starter store is modeled after an online clothing retailer.

RemoveRetailOC

0

Specify whether Retail online channel is removed.

  • 0 – Don’t remove Retail online channel.

  • 1 – Remove Retail online channel.

Retail POS parameters

The following table lists the parameters that control how Setup installs and removes Retail POS (point of sale).

Parameter

Default value

Description

InstallRetailPOS

0

Specify whether Retail POS is installed.

  • 0 – Don’t install Retail POS.

  • 1 – Install Retail POS.

UninstallRetailPOS

0

Specify whether Retail POS is removed.

  • 0 – Don’t remove Retail POS.

  • 1 – Remove Retail POS.

Retail SDK parameters

The following table lists the parameters that control how Setup installs and removes the Retail SDK.

Parameter

Default value

Description

InstallRetailSDK

0

Specify whether the Retail SDK is installed.

  • 0 – Don’t install the Retail SDK.

  • 1 – Install the Retail SDK.

RemoveRetailSDK

0

Specify whether the Retail SDK is removed.

  • 0 – Don’t remove the Retail SDK.

  • 1 – Remove the Retail SDK.

Retail Server parameters

The following table lists the parameters that control how Setup installs and removes Retail Server.

Note

Retail Server is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallRetailServer

0

Specify whether Retail Server is installed.

  • 0 – Don’t install Retail Server.

  • 1 – Install Retail Server.

RetailServerHttpsPort

None

Specify the port on which Retail Server receives HTTPS requests.

RetailServerHttpPort

None

Specify the port on which Retail Server receives HTTP requests.

RetailServerApplicationName

None

Specify the name of the web application that hosts Retail Server.

RetailServerAppPoolName

None

Specify the name of the application pool that the web application runs under.

RetailServerWebsiteName

None

Specify the name of the website that Retail Server runs on.

RetailServerAppPoolUsername

None

Specify the name of the user that runs the application pool for Retail Server.

If you specify a value for this parameter, you must also specify a value for the RetailServerAppPoolPassword parameter.

RetailServerAppPoolPassword

None

Specify the password that is associated with the account that runs the application pool.

You must specify a value for this parameter if you specify a value for the RetailServerAppPoolUsername parameter.

RetailServerSslCertThumbprint

None

Specify the thumbprint for the Secure Sockets Layer (SSL) encryption certificate. You must obtain a valid, registered certificate from a provider.

RetailServerDatabase

None

Specify the name of the channel database that is used with Retail Server.

You can connect to an existing channel database only. Setup doesn’t create a new channel database if you enter a channel database name that doesn’t exist.

RetailServerDatabaseServerName

None

Specify the name of the server that hosts the channel database.

RetailServerDatabaseServerInstanceName

None

If needed, specify the name of the instance of SQL Server that hosts the channel database.

RemoveRetailServer

0

Specify whether Retail Server is removed.

  • 0 – Don’t remove Retail Server.

  • 1 – Remove Retail Server.

Retail Store Connect parameters

The following table lists the parameters that control how Setup installs and removes Retail Store Connect.

These parameters apply only to Retail Store Connect in Microsoft Dynamics AX 2012 Feature Pack. In AX 2012 R3 and AX 2012 R2, Retail Store Connect is called Commerce Data Exchange: Synch Service, and the parameter names are different. For more information, see Commerce Data Exchange: Synch Service parameters.

Parameter

Default value

Description

InstallRetailSC

0

Specify whether Retail Store Connect is installed.

  • 0 – Don’t install Retail Store Connect.

  • 1 – Install Retail Store Connect.

UninstallRetailSC

0

Specify whether Retail Store Connect is removed.

  • 0 – Don’t remove Retail Store Connect.

  • 1 – Remove Retail Store Connect.

Retail Transaction Service parameters

The following table lists the parameters that control how Setup installs and removes Retail Transaction Service.

These parameters apply only to Retail Transaction Service in Microsoft Dynamics AX 2012 Feature Pack. In AX 2012 R3 and AX 2012 R2, Retail Transaction Service is called Commerce Data Exchange: Real-time Service, and the parameter names are different. For more information, see Commerce Data Exchange: Real-time Service parameters.

Parameter

Default value

Description

InstallRetailTS

0

Specify whether Retail Transaction Service is installed.

  • 0 – Don’t install Retail Transaction Service.

  • 1 – Install Retail Transaction Service.

UninstallRetailTS

0

Specify whether Retail Transaction Service is removed.

  • 0 – Don’t remove Retail Transaction Service.

  • 1 – Remove Retail Transaction Service.

Synchronization service and synchronization proxy parameters

The following table lists the parameters that control how Setup installs and removes the synchronization service and synchronization proxy for Microsoft Project Server.

Parameter

Default value

Description

InstallSynchronizationService

0

Specify whether the synchronization service is installed.

  • 0 – Don’t install the synchronization service.

  • 1 – Install the synchronization service, and create a new message queue.

  • 2 – Install the synchronization service, and use an existing message queue.

The synchronization service can be installed only one time.

SynchronizationServiceMSMQAddress

None

Specify the address of the message queue that is used together with the synchronization service. This parameter is valid only if InstallSynchronizationService=2.

SynchronizationServiceMSMQType

0

Specify the type of message queue that is created.

  • 0 – Create a private queue.

  • 1 – Create a public queue.

SynchronizationServiceAccount

None

Specify the account that the synchronization service runs as.

The synchronization service uses this account to connect to Microsoft Dynamics AX and to access the Project Server database.

Enter the account in the format domain\account.

This parameter is optional when you install the synchronization service, because Setup can retrieve the value from the database. The parameter is required when you install the synchronization proxy.

If you specify a value for this parameter, you must also specify a value for the SynchronizationServiceAccountPassword parameter.

SynchronizationServiceAccountPassword

None

Specify the password that is associated with the account for the synchronization service.

If you use a standard domain account, this parameter is required if InstallSynchronizationService is set to 1 or 2.

SynchronizationServiceMsmqAccounts

None

Specify the accounts to which permissions for the message queues are granted. You must specify two types of accounts:

  • The account that is used by the Project Server event service

  • The service accounts for all AOS instances that you want to use for synchronization

Enter the value in the format domain\account or account. If you don’t specify a domain, the domain that the local computer belongs to is used. If you specify a local account, use the name of the local computer as the domain. For example, use ComputerName\LocalAccount or NT AUTHORITY\NETWORK SERVICE.

To include multiple service accounts, separate the values by using a semicolon (;).

Note

The spelling of built-in accounts must match the spelling that is used by the language version of the operating system.

InstallSynchronizationProxy

0

Specify whether the synchronization proxy is installed.

  • 0 – Don’t install the synchronization proxy.

  • 1 – Install the synchronization proxy.

The synchronization proxy can be installed only one time.

SynchronizationProxySqlServer

None

Specify the SQL Server instance that Project Server uses for reporting. This parameter is required if InstallSynchronizationProxy=1.

SynchronizationProxySqlDatabaseName

ProjectServer_Reporting, if the database exists on the SQL Server instance and HideUI=1. Otherwise, there is no default value.

Specify the SQL Server database that the Project Server uses for reporting. This parameter is required if InstallSynchronizationProxy=1.

SynchronizationProxyUrl

None

Specify the URL for Project Web access. This parameter is required if InstallSynchronizationProxy=1.

RemoveSynchronizationService

0

Specify whether an installed instance of the synchronization service is removed.

  • 0 – Don’t remove the synchronization service.

  • 1 – Remove the synchronization service.

RemoveSynchronizationProxy

0

Specify whether an installed instance of the synchronization proxy is removed.

  • 0 – Don’t remove the synchronization proxy.

  • 1 – Remove the synchronization proxy.

Trace Parser parameters

The following table lists the parameters that control how Setup installs and removes Trace Parser.

Parameter

Default value

Description

InstallTraceParser

0

Specify whether Trace Parser is installed.

  • 0 – Don’t install Trace Parser.

  • 1 – Install Trace Parser.

RemoveTraceParser

0

Specify whether Trace Parser is removed.

  • 0 – Don’t remove Trace Parser.

  • 1 – Remove Trace Parser.

Visual Studio Tools parameters

The following table lists the parameters that control how Setup installs and removes the Visual Studio Tools.

Parameter

Default value

Description

InstallVisualStudioTools

0

Specify whether Visual Studio Tools are installed.

  • 0 – Don’t install Visual Studio Tools.

  • 1 – Install Visual Studio Tools.

If InstallVisualStudioTools=1, you must also specify a value for ClientAosServer, AosPort, and AosWsdlPort. You can optionally specify a value for AosInstance.

RemoveVisualStudioTools

0

Specify whether Visual Studio Tools are removed.

  • 0 – Don’t remove Visual Studio Tools.

  • 1 – Remove Visual Studio Tools.

VSS writer parameters

The following table lists the parameters that control how Setup installs and removes VSS writer.

Note

The VSS writer is available through Setup only in Microsoft Dynamics AX 2012 R3 or cumulative update 7 or later for AX 2012 R2.

Parameter

Default value

Description

InstallVss

0

Specify whether VSS writer is installed.

  • 0 – Don’t install VSS writer.

  • 1 – Install VSS writer.

DpmServer

None

Specify the server where System Center Data Protection Manager (DPM) is installed.

TempBackupPath

None

Specify the location where temporary backups will be stored.

VssServiceAccount

None

Specify the account that the Windows service for the VSS writer runs as.

If you specify an account, the value must be in the format domain\account. The account must be a domain account. You can’t specify your own account or a local computer account.

If you specify a value for this parameter, you must also specify a value for the VssServicePassword parameter.

VssServicePassword

None

Specify the password that is associated with the VSS writer service account.

If you use a standard domain account, you must specify a value for this parameter if you specify a value for the VssServiceAccount parameter.

ProtectAos

0

Specify whether to protect an AOS instance with VSS writer.

  • 0 – Don’t protect an AOS instance.

  • 1 – Protect an AOS instance.

VssAosInstanceNumber

None

Specify the instance number of the AOS instance to protect.

This parameter is required if ProtectAos=1.

ProtectSsas

0

Specify whether to protect an instance of Analysis Services with VSS writer.

  • 0 – Don’t protect an instance of Analysis Services.

  • 1 – Protect an instance of Analysis Services.

VssAnalysisInstance

None

Specify the instance of Analysis Services to protect.

This parameter is required if ProtectSsas=1.

ProtectSsrs

0

Specify whether to protect an instance of Reporting Services with VSS writer.

  • 0 – Don’t protect an instance of Reporting Services.

  • 1 – Protect an instance of Reporting Services.

VssReportingDbName

None

Specify the reporting database to protect.

VssReportingInstance

None

Specify the instance of Reporting Services to protect.

This parameter is required if ProtectSsrs=1.

VssReportingInstanceRemote

None

Specify the SQL Server instance that hosts the Reporting Services database.

This parameter is required if ProtectSsrs=1.

VssReportingMachine

None

Specify the computer that hosts the Reporting Services database.

This parameter is required if ProtectSsrs=1.

ProtectDb

0

Specify whether to protect the Microsoft Dynamics AX database by using VSS writer.

  • 0 – Don’t protect the Microsoft Dynamics AX database.

  • 1 – Protect the Microsoft Dynamics AX database.

VssDbName

None

Specify the name of the Microsoft Dynamics AX database to protect.

This parameter is required only if ProtectDb=1.

VssDbInstance

None

Specify the SQL Server instance that hosts the Microsoft Dynamics AX database.

This parameter is required only if ProtectDb=1.

RemoveVss

0

Specify whether VSS writer is removed.

  • 0 – Don’t remove VSS writer.

  • 1 – Remove VSS writer.

Warehouse Mobile Devices Portal parameters

The following table lists the parameters that control how Setup installs and removes the Warehouse Mobile Devices Portal.

Note

Warehouse Mobile Devices Portal is available through Setup only in AX 2012 R3.

Parameter

Default value

Description

InstallWarehouseServer

0

Specify whether Warehouse Mobile Devices Portal is installed.

  • 0 – Don’t install Warehouse Mobile Devices Portal.

  • 1 – Install Warehouse Mobile Devices Portal.

If InstallWarehouseServer=1, you must also include the parameter AcceptBestPracticesList=1.

WarehouseAccount

None

Optionally, use this parameter instead of the WarehouseUserDomain and WarehouseUserName parameters.

Enter the value in the format Domain\account.

WarehouseUserName

None

Specify the name of the user that runs the application pool for Warehouse Mobile Devices Portal.

If you specify a value for this parameter, you must also specify a value for the WarehouseUserDomain parameter and the WarehouseUserPassword parameter.

WarehouseUserDomain

None

Specify the domain of the user that runs the application pool for Warehouse Mobile Devices Portal.

If you specify a value for this parameter, you must also specify a value for the WarehouseUserName parameter and the WarehouseUserPassword parameter.

WarehouseUserPassword

None

Specify the password that is associated with the account that runs the application pool.

You must specify a value for this parameter if you specify a value for the WarehouseUserName parameter.

WarehouseSitePort

None

Enter the port number that the website will run on.

RemoveWarehouseServer

0

Specify whether Warehouse Mobile Devices Portal is removed.

  • 0 – Don’t remove Warehouse Mobile Devices Portal.

  • 1 – Remove Warehouse Mobile Devices Portal.

WarehouseInstanceNumber

None

Specify the number of the Warehouse Mobile Devices Portal instance to remove.

Specify a value for this parameter only when you uninstall Warehouse Mobile Devices Portal.

Web services on IIS parameters

The following table lists the parameters that control how Setup installs and removes web services on Internet Information Services (IIS).

Parameter

Default value

Description

InstallAifWebServices

0

Specify whether web services are installed on IIS.

  • 0 – Don’t install web services on IIS.

  • 1 – Install web services on IIS.

Web services on IIS can be installed only one time.

AifWebServicesWebSite

None

Specify the website where Setup creates the virtual directory for web services on IIS.

AifWebServicesApplicationPool

MicrosoftDynamicsAXAif60

Specify the name of the application pool that is created. The name can’t include the following characters: asterisks (*), backslashes (\), pipes (|), question marks (?), or slashes (/).

AifWebServicesVirtualDirectory

MicrosoftDynamicsAXAif60

Specify the name of the virtual directory that is created. The name can’t include the following characters: asterisks (*), backslashes (\), pipes (|), question marks (?), or slashes (/).

AifWebServicesAosAccounts

See the description.

Specify the AOS service accounts that are added to the shared directory. If an AOS instance is already installed on this computer, the default account is the service account of the AOS instance that was most recently installed.

Enter the value in the format Domain\account or account. If you don’t specify a domain, the domain that the local computer belongs to is used. If you specify a local account, use the name of the local computer as the domain. For example, use ComputerName\LocalAccount or NT AUTHORITY\NETWORK SERVICE.

To include multiple service accounts, separate the values by using a semicolon (;).

Note

The spelling of built-in accounts must match the spelling that is used by the language version of the operating system.

RemoveAifWebServices

0

Specify whether web services on IIS are removed.

  • 0 – Don’t remove web services on IIS.

  • 1 – Remove web services on IIS.