AX 2012: Client Configuration Commands

AX 2012: ClientConfiguration Commands

Updated: October 22, 2013

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Configuration commands set the options that are used when a Microsoft Dynamics AX client starts. Configuration commands can be run directly from the following locations:

·         In a configuration file

·         In the Configuration Command to run at kernel startup field in the Microsoft Dynamics AX 2012 Configuration utility

·         From a command prompt using Ax32.exe, which is located in the Drive:\Program Files (x86)\Microsoft Dynamics AX\60\Client\Bin directory

General Options

Configuration commands use different syntax depending on where you execute command. The syntax variations are provided in the following sections.

Command in configuration file	Command in command line	Configuration utility option	Description
Company, Text, <string>	-company=<string>	Company	Specify the company that opens when the client starts.
Log, Text, <path>	-log=<path>	Log directory	Specify an alternate directory for the log files generated when you make changes in the Application Object Tree (AOT). When you execute this command from a command prompt, insert an underscore wherever a path name includes space breaks.
This command cannot be set in a file	-regConfig=< name of configuration >	Configuration	Specify the configuration to use when the client starts.
Startupcmd, Text, <command>	-startupCmd= <command>	Command to run at application startup	Enter a SysStartupCmd method to run when the client starts. To view SysStartupCmd methods, expand the Classes node in the AOT, expand SystStartuoCmd, and double-click Construct. Available commands are listed in the Switch function Note: No syntax checking is performed before commands are passed to the client. Test any command before using it.
Startupmsc, Text, <string>	-startupmsg=<string>	Startup message	Specify text to display in a message box when the client starts.
This command cannot be set in a file.	-language=<string>	This command does not have a corresponding user interface value.	Specify the language to use when the client starts. You must specify an alphabetical language code such as da, de, fr-ca, en-us, etc. These codes correspond to a file in the following directory: Drive\:Program Files (x86)\Microsoft Dynamics AX\60\Client\Bin. You must also have a valid license for the language.
This command cannot be set in a file	-roamingprofile	Use roaming user profile	Enables Microsoft  Dynamics AX client files and settings to work with roaming profiles in a Remote Desktop Services (RDS) farm. Roaming profiles can improve client startup times in an RDS farm, though results depend on network and hardware infrastructure.

 

Connection Options

This table describes the options you can use to connect to an AOS instance

Command in configuration file	Command in command line	Configuration utility option	Description
aos2,text,<options> Options include: host –or– host:port	-aos2=host –or– -aos2=host:port	Add Application Object Server Instance	Specify connections to additional AOS instances. Instance and port are optional. If port is not specifie
aosencryption,Text,<0,1>	-aosencryption=<0,1>	Encrypt client to server communication	Encrypt all data sent between this client and the AOS.
useserverprinters,Int,1	-useserverprinters	Connect to printers on the server	Enable clients to connect to printers on the AOS computer. You must configure the AOS to print. For more information, see Configure an AOS instance to print.

Developer Options

This table describes the options you can use to set up the development environment.

Command in configuration file	Command in command line	Configuration utility option	Description
This command cannot be set in a file.	-development	This command does not have a corresponding user interface value.	Opens the Microsoft Dynamics AX developer workspace and the AOT.
aol,Text,<string>	-aol=<string>	Layer to open in Application Object Tree	Specifies which layer to open in the AOT.
aolcode,Text,<string>	-aolcode=<string>	License code	Specifies the developer license code for developer options.
globalbreakpoints,Int,1	-globalbreakpoints	Enable global breakpoints for debugging code running in the Business Connector or client	This is a binary command that is not set by default. For all users, allow X++ code running in the Business Connector or client to be interrupted by global breakpoints
Not supported in the configuration file.	-logstrtrunc	Writes diagnostic information to the Windows Event Log every time an X++ str value is truncated due to the declaration having specified a maximum length.	Truncation of str values does not occur if the X++ code is running as .NET Framework common intermediate language (CIL). This is one of the rare cases where the behavior of X++ code differs depending on whether the code is being run as interpreted p-code versus CIL.
xppdebug,Text,<0,1>	-xppdebug=<0,1>	Enable user breakpoints for debugging code running in the Business Connector	For sessions owned by users for whom debug is enabled, allow X++ code running in the Business Connector to be interrupted by breakpoints.
aotimportfile,text,<file.xpo>	–aotimportfile=<File.xpo>	This command does not have a corresponding user interface value.	Import an xpo file and start a full compile of the AOT when the client starts.
Not supported in the configuration file.	-model =<model to use>	This command does not have a corresponding user interface value.	The “current model” is the model where all new AOT elements are created in. For this command, <model-to-use> is any valid model in the layer you are starting Microsoft Dynamics AX in. For example, USR. If <model-to-use> is not a valid model, the system generated model is used instead. For example “USR Model”.
Not supported in the configuration file.	-noauto	This command does not have a corresponding user interface value.	Microsoft Dynamics AX developers use this parameter when they have made changes to the startup behavior of Microsoft Dynamics AX and they want to bypass those changes to troubleshoot issues or problems.
This command cannot be set in a file.	-development	This command does not have a corresponding user interface value.	Use roaming user profile.
aol,Text,<string>	-aol=<string>	Layer to open in Application Object Tree	Specifies which layer to open in the AOT.
aolcode,Text,<string>	-aolcode=<string>	License code	Specifies the developer license code for developer options.
globalbreakpoints,Int,1	-globalbreakpoints	Enable global breakpoints for debugging code running in the Business Connector or client	This is a binary command that is not set by default. For all users, allow X++ code running in the Business Connector or client to be interrupted by global breakpoints
Not supported in the configuration file.	-logstrtrunc	Writes diagnostic information to the Windows Event Log every time an X++ str value is truncated due to the declaration having specified a maximum length.	Truncation of str values does not occur if the X++ code is running as .NET Framework common intermediate language (CIL). This is one of the rare cases where the behavior of X++ code differs depending on whether the code is being run as interpreted p-code versus CIL.
xppdebug,Text,<0,1>	-xppdebug=<0,1>	Enable user breakpoints for debugging code running in the Business Connector	For sessions owned by users for whom debug is enabled, allow X++ code running in the Business Connector to be interrupted by breakpoints.
aotimportfile,text,<file.xpo>	–aotimportfile=<File.xpo>	This command does not have a corresponding user interface value.	Import an xpo file and start a full compile of the AOT when the client starts.
Not supported in the configuration file.	-model =<model to use>	This command does not have a corresponding user interface value.	The “current model” is the model where all new AOT elements are created in. For this command, <model-to-use> is any valid model in the layer you are starting Microsoft Dynamics AX in. For example, USR. If <model-to-use> is not a valid model, the system generated model is used instead. For example “USR Model”.
Not supported in the configuration file.	-noauto	This command does not have a corresponding user interface value.	Microsoft Dynamics AX developers use this parameter when they have made changes to the startup behavior of Microsoft Dynamics AX and they want to bypass those changes to troubleshoot issues or problems.