Application Object Server (AOS) configuration commands
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
Configuration commands set the options that are used when an Application Object Server (AOS) instance 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 Server Configuration utility
From a command prompt using Ax32Serv.exe, which is located in the Drive:\Program Files\Microsoft Dynamics AX\60\Server\MicrosoftDynamicsAX\bin directory
Configuration commands require that you use different syntax if you are setting them in a configuration file, executing them in the Configuration Command to run at kernel startup field, or executing them from a command prompt. Syntax variations are provided in the following tables.
General options
This table describes the general options you can use to work with configurations and files.
Command in configuration file |
Command from command line |
Configuration utility option |
Description |
|---|---|---|---|
This command cannot be set in a file. |
-regConfig=<configname> |
Configuration |
Specify the configuration to use when this AOS instance starts. |
Application Object Server options
This table describes the options you can use to manage how an AOS functions.
Command in configuration file |
Command from command line |
Configuration utility option |
Description |
|---|---|---|---|
bindir,Text,<path> |
-bindir=<path> |
Alternate bin directory |
Specify a directory location that contains an alternate kernel text data (ktd) file. |
compressiondisabled,Int,1 |
-compressiondisabled |
Option not available in utility |
This is a binary command that is not set by default. When this value is absent, data sent between the AOS and Microsoft Dynamics AX clients is compressed to improve performance. If the value is present, then packets are not compressed. Disabling compression can have a negative impact on system performance. To compress packets, remove the value from the configuration file. |
compressionminsize,Text,<number> |
-compressionminsize=<number> |
Minimum packet size to compress |
Specify the smallest useful packet size to compress. The larger the packet size chosen, the smaller the gains in speed. |
exposeserverprinters,Int,1 |
-exposeserverprinters |
Allow clients to connect to printers on this server |
This is a binary command that is not set by default. When this value is present, clients are allowed to connect to printers that are connected to the AOS computer. |
port,Text,<portnumber> |
-port=<portnumber> |
TCP/IP port |
The TCP/IP port that the AOS instance should use to connect to clients. The default value is 2712. |
xppdebug,Text,<0,1> |
-xppdebug=<0,1> |
Enable breakpoints to debug X++ code running on this server |
Enable clients to trace their interactions with this AOS instance. The default is off (0). |
caslevel,Text,<enable/disable/trace> |
-caslevel=<enable/disable/trace> |
Option not available in utility |
Code Access Security (CAS) is the mechanism in Microsoft Dynamics AX that is used to protect specific APIs. Enable, the default setting, activates CAS for all CAS-protected APIs. If a CAS-protected API is invoked without following the correct consumer steps, an error is generated. Trace is used to simulate CAS being enabled. An error is not generated if a CAS-protected API is invoked incorrectly. Instead, debug information is written to the Infolog. Use in development or test environments to determine the changes that need to be made to get the system working. Important Do not set the caslevel to Trace in production environments. Disable disables CAS entirely. Important Do not set the caslevel to Disable in production environments. |
MaxConcurrentUISessions,Text,<value> |
-MaxConcurrentUISessions=<value> |
Set the maximum number of concurrent Microsoft Dynamics AX client sessions. The minimum value is 0, the maximum value (and default) is 65535. |
|
MaxConcurrentGuestSessions,Text,<value> |
-MaxConcurrentGuestSessions=<value> |
Set the maximum number of concurrent Guest (anonymous user) sessions. The minimum value is 0, the maximum value (and default) is 65535. |
|
MaxConcurrentWebSessions,Text,<value> |
-MaxConcurrentWebSessions=<value> |
Set the maximum number of concurrent Enterprise Portal sessions, including Guest sessions. The minimum value is 0, the maximum value (and default) is 65535. |
|
MaxConcurrentBCSessions,Text,<value> |
-MaxConcurrentBCSessions=<value> |
Set the maximum number of concurrent Business Connector sessions, including all Web sessions (all Web sessions come through Business Connector). The default value is 65535. |
|
MaxMemLoad,Text,<value> |
-MaxMemLoad=<value> |
Set the maximum amount of memory usage (the maximum percentage of physical memory that is in use on the computer). The default value is 0. |
|
MaxConcurrentSessions,Int,<value> |
-MaxConcurrentSessions=<value> |
Maximum number of client sessions |
Set the maximum number of client sessions this AOS instance will accept. The minimum value is 0, the maximum value (and default) is 65535. |
startupcmd,Text,<command> |
-startupCmd=<command> |
Command to run at application startup |
Enter a SysStartupCmd method to run when this client application starts. For details, see Execute configuration commands. |
extracmd,Text,<command> |
-extracmd=<command> |
Configuration command to run at kernel startup |
Enter any configuration command to run when the kernel starts. |
Database connection options
This table describes the options you can use to connect to a database.
Command in configuration file |
Command from command line |
Configuration utility option |
Description |
|---|---|---|---|
createdsn,Text, <microsoftsqlserver> |
createdsn=<microsoftsqlserver> |
Option not available in utility |
Create the data source in the ODBC manager. |
dsn,text,<portnumber> |
-dsn=<portnumber> |
Option not available in utility |
Point to a specific data source. |
database,Text,<databasename> |
-database=<databasename> |
Database to connect to |
Specify the database to connect to. |
dbcli,Text,<ODBC> |
-dbcli=<ODBC> |
Option not available in utility |
Run Microsoft Dynamics AX in ODBC mode. |
dbserver,Text,<servername> |
-dbserver=<servername> |
Option not available in utility |
SQL Server name. |
Database tuning options
This table describes the options you can use to tune database performance.
Command in configuration file |
Command from command line |
Configuration utility option |
Description |
|---|---|---|---|
connectionidletimeout,Text,<0,1> |
-connectionidletimeout=<0,1> |
Leave the connection running when idle |
Retain a connection to the database when no transactions are running. |
connectionidletimeout,Text,<time> |
-connectionidletimeout=<time> |
Maximum idle time before closing |
Specify the amount of time to leave a database connection idle before closing it. |
fetchahead,Text,<number> |
-fetchahead=<number> |
Array fetch ahead |
Specify the maximum number of records that the system fetches at the same time. Starts as your local default computer setting of 100. |
hint,Text,1 |
-hint=<0, 1> |
Allow INDEX hints in queries |
Enable any query written with an INDEX hint to override the index selected by the database management system. |
hint,Text,2 |
-hint=<0, 2> |
Include LTRIM in all SELECT statements to remove leading space from right-aligned columns |
Add LTRIM to all queries generated by Microsoft Dynamics AX. Using LTRIM forces the database to perform a table scan, which can slow query results. Set to 2 to enable this feature, and 0 to disable it. |
ignoredatasourceindex,Text,<0,1> |
-ignoredatasourceindex=<0, 1> |
Generate ORDER BY clauses from WHERE clauses |
Set to 1 to override the ordering specified by the index on the data source, using the order of the columns as specified in the WHERE clause. This can improve query performance. |
newconnectionretrycount,Text,<number> |
-newconnectionretrycount=<number> |
Number of connection retries |
Specify the number of times to try connecting to the database before failing. |
newconnectionretrydelayms,Text,<time> |
-newconnectionretrydelayms=<time> |
Connection retry interval |
Specify the interval between attempts to connect to the database in milliseconds. |
opencursors,Text,<number> |
-opencursors=<number> |
Maximum open cursors |
Specify the maximum number of database cursors to keep open for reuse in a connection. Starts as your local computer setting, which defaults to 90. |
retry,Text,<time> |
-retry=<time> |
Transaction retry interval (in seconds) |
Specify the delay before re-executing a transaction after a deadlock. The default value is 5 seconds. |
sqlbuffer,Text,<number> |
-sqlbuffer=< number> |
Maximum buffer size |
Specify the maximum size of the data retrieval buffer. The larger the buffer, the greater the number of records transferred at the same time. Starts as your local default computer setting of 24. |
sqlcomplexliterals,Text,<0,1> |
-sqlcomplexliterals=<0,1> |
Use literals in complex joins from X++ |
Specify that Microsoft Dynamics AX use literals rather than parameters for complex joins to optimize performance. |
sqlformliterals,Text, <0,1> |
-sqlformliterals=<0, 1> |
Use literals in join queries from forms and reports |
Specify that Microsoft Dynamics AX use literals rather than parameters in long-running queries to optimize performance. |
Unfamiliar configuration options
In the configuration files generated by Microsoft Dynamics AX, you may see unfamiliar options. Some are legacy options (configuration options from previous versions) that are not in use. Other configuration options remain in both the client or server configuration files, although they only apply to client or server, because in previous product versions the utilities were combined. We recommend that you do not change values for these options; unexpected results may occur.
Value in configuration file |
Applies to |
|---|---|
directory,Text,<pathname> |
Server |
client,Text,thin |
Legacy |
broadcast,Text, |
Legacy |
sql,Int,1 |
Server |
native,Int,0 |
Legacy |
fetchahead,Text, |
Server |
opencursors,Text, |
Server |
database,Text, |
Server |
dsn,Text, |
Server |
sqluser,Text, |
Legacy |
hint,Text, |
Server |
sqlbuffer,Text, |
Server |
log,Text, |
Server |
hassqlpwd,Int,0 |
Legacy |
sqlpwd,Text, |
Legacy |
retry,Text, |
Server |
dbserver,Text, |
Server |
localappldoc,Int,0 |
Legacy |
localsysdoc,Int,0 |
Legacy |
applshare,Int,1 |
Legacy |
applexclusive,Int,0 |
Legacy |
hascompwd,Int,0 |
Legacy |
compwd,Text, |
Legacy |
hasserveridletimeout,Int,0 |
Server |
serveridletimeout,Text, |
Server |
connectionidletimeout,Text, |
Server |
port,Text, |
Server |
createdsn,Text, |
Server |
allowunauth,Int,0 |
Legacy |
sqlformliterals,Text,1 |
Server |
sqlcomplexliterals,Text,1 |
Server |
ignoredatasourceindex,Text,0 |
Server |
dbcli,Text,odbc |
Server |
dbunicodeenabled,Text,1 |
Legacy |
newconnectionretrydelayms,Text, |
Server |
newconnectionretrycount,Text, |
Server |
cachesynctime,Text, |
Server |
_clientadname,Text, |
Legacy |