Possible Parameters and Values

The following table lists all available command-line parameters and values and a brief description of each parameter.

Parameter Values Description

-file

or

-f

 path to configuration file

Specifies the directory where the XML configuration file is stored. By default, the file is stored in C:\Program Files (x86)\MYOB Acumatica\Data\.

Example: -file:"C:\Program Files (x86)\Program Folder\Data\"

-configmode

or

-cm

NewInstance

DBMaint

DBConection

CompanyConfig

ToolsInstall

NewTrainingInstance

DeleteSite

RenameSite

UpgradeSite

(Mandatory) Specifies the maintenance scenario for which you are using the command-line tool. The possible values and applicable scenarios follow:

  • NewInstance: Installs a new application instance. You can also use the following command-line parameters in this scenario:

    -company

    -dbname

    -dbnew

    -dbnewuser

    -dbpass

    -dbsrvname

    -dbsrvpass

    -dbsrvuser

    -dbsrvwinauth

    -dbupdate

    -dbuser

    -dbwinauth

    -iname

    -ipath

    -sactions

    -spass

    -split

    -spool

    -suser

    -svirtdir

    -swebsite

    -portal

  • DBMaint: Creates a new database or updates an existing database with a current version of the database schema. You can also use the following command-line parameters in this scenario:

    -company

    -dbname

    -dbnew

    -dbsrvname

    -dbsrvpass

    -dbsrvuser

    -dbsrvwinauth

    -dbupdate

    -split

  • DBConection: Modifies database connection settings. You can also use the following command-line parameters in this scenario:

    -company

    -dbname

    -dbnew

    -dbnewuser

    -dbpass

    -dbsrvname

    -dbsrvpass

    -dbsrvuser

    -dbsrvwinauth

    -dbupdate

    -dbuser

    -dbwinauth

    -split

  • CompanyConfig: Adds new tenants or deletes existing ones. You can also use the following command-line parameters in this scenario:

    -company

    -dbname

    -dbnew

    -dbsrvname

    -dbsrvpass

    -dbsrvuser

    -dbsrvwinauth

    -dbupdate

    -split

  • ToolsInstall: Installs MYOB Acumatica controls and templates for Microsoft Visual Studio; this option is available in the MYOB Acumatica ERP Configuration Wizard. You can also use the following command-line parameters in this scenario:

    -vscontrols

    -vstemplates

  • NewTrainingInstance: Installs a new application instance for a T-series training course and publishes the required customization for the course. In this scenario, you can use the command-line parameters that are described for the NewInstance scenario and additionally the following parameter: -coursetemplate.

  • DeleteSite: Deletes an existing MYOB Acumatica instance. You can also use the -iname parameter in this scenario.
  • RenameSite: Renames an existing MYOB Acumatica instance. You can also use the following command-line parameters in this scenario:

    -iname

    -ioldname

  • UpgradeSite: Upgrades the files of an existing MYOB Acumatica instance. You can also use the -iname command-line parameter in this scenario.

Example: -configmode:"NewInstance"

-dbsrvname

or

-s

 server name

Specifies the name of the SQL server that will be accessed by this application instance of MYOB Acumatica. The default setting is (local).

Example: -dbsrvname:"(local)"

-dbsrvwinauth

or

-sw

True

False

Specifies whether Windows or SQL Server authentication will be used by the configuration tools to access SQL Server. Select one of the following values:

  • True: Uses Windows authentication. This is the default value.
  • False: Uses SQL Server authentication.

Example: -dbsrvwinauth:"True"

-dbsrvuser

or

-u

 user name

Specifies the user name of the account used to access SQL Server. You must add this parameter if the SQL Server authentication method is used (and the dbsrvwinauth parameter value is set to False).

Example: -dbsrvuser:"SQLAdmin"

-dbsrvpass

or

-p

 user password

Specifies the user password for the account used to access SQL Server. You must specify this parameter if the SQL Server authentication method is used (and the dbsrvwinauth parameter value is set to False).

Example: -dbsrvpass:"<user_password>"

-dbname

or

-d

 database name

Required. Specifies the name of the database maintained by this application instance of MYOB Acumatica.

Example: -dbname:"HSBC_DB"

-dbnew

or

-n

True

False

Specifies whether you want to create a new database in SQL Server. The default setting is True.

Example: -dbnew:"False"

-dbupdate

or

-b

True

False

Specifies whether you want to update an earlier version of the database with a newer one. You can also use this parameter to repair an existing database of the current version. The default setting is True.

Example: -dbupdate:"False"

-dbsize

or

-dz

1

5

10

20

30

40

50

Specifies the maximum size of the database on Azure SQL and therefore is used only for MYOB Acumatica deployed on Windows Azure. The available values correspond to the standard database size values in GB. The default setting is 1.

Example: -dbsize:"50"

-dbskip

or

-ds

True

False

Specifies whether the database setup steps are skipped. If they are, the database will be set up by the MYOB Acumatica instance in run time. The default setting is False.

Example: -dbskip:"False"

-dbshrink

or

-dc

True

False

Specifies whether you want the utility to shrink the database once it has been configured. This parameter is used only for MYOB Acumatica deployed on Windows Azure. The default setting is False.

Example: -dbshrink:"True"

-iname

or

-i

 instance name

Required. Specifies the name of the MYOB Acumatica instance.

Example: -iname:"HSBC Main ERP"

-ioldname

or

-io

 old instance name

Specifies the current name of an MYOB Acumatica instance when you rename this instance.

Example: -ioldname:"HSBC_HQ"

-ipath

or

-h

 instance directory

Required. Specifies the directory where the application instance files will be stored. The default setting is C:\Program Files\MYOB Acumatica\.

Example: -ipath:"C:\Program Folder\"

-vmsize

or

-is

Small

Medium

Large

ExtraLarge

Specifies the relative size of the Windows Azure virtual machine. This parameter is used only for MYOB Acumatica deployed on Windows Azure. The default setting is Small.

Example: -vmsize:"ExtraLarge"

-swebsite

or

-w

 website name Specifies the name of the existing Internet Information Services (IIS) website on the local computer.

-svirtdir

or

-v

 virtual directory

Specifies the name of the IIS virtual directory. If there is no such virtual directory in IIS, this directory will be created on the local IIS.

Example: -svirtdir:"<virtual_directory_name>"

-spool

or

-po

 application pool

Specifies the name of the IIS application pool. If there is no such application pool in IIS, this pool will be created on the local IIS.

Example: -spool:"<application_pool_name>"

-dbwinauth

or

-dw

True

False

Specifies whether Windows or SQL Server authentication will be used by this MYOB Acumatica instance to access SQL Server. These are the possible values:

  • True: Uses Windows authentication. (This is the default value.)
  • False: Uses SQL Server authentication.

Example: -dbwinauth:"True"

-dbnewuser

or

-dn

True

False

Specifies whether a new SQL Server account must be created. The default setting is True.

Example: -dbnewuser:"True"

-dbuser

or

-du

 user name

Specifies the name of the user account used by this MYOB Acumatica instance to access SQL Server. You must add this parameter if the SQL Server authentication method is used (and the dbwinauth parameter value is set to False).

Example: -dbuser:"SQLAdmin"

-dbpass

or

-dp

 user password

Specifies the password of the user account used by this MYOB Acumatica instance to access SQL Server. You must add this parameter if the SQL Server authentication method is used (and the dbwinauth parameter value is set to False).

Example: -dbpass:"SQLAdmin"

-wscompany

or

-wc

 company ID

Specifies the ID of the tenant that will be used for the tenant portal. This parameter is used only in the Company Portal configuration mode.

Example: -wscompany:"<company_ID>"

-wsuser

or

-wu

 user name

Specifies the user account that will be used for the tenant portal. This parameter is used only in the Company Portal configuration mode.

Example: -wsuser:"<company_ID>"

-wswiki

or

-ww

 portal Wiki

Specifies the Wiki article that will be used for the tenant portal. This parameter is used only in the Company Portal configuration mode.

Example: -wswiki:"<company_ID>"

-securemode

or

-cs

True

False

Specifies whether the tenant ID is displayed on the logon screen. The default setting is False. Select one of these possible values:

  • True: Hides the tenant ID.
  • False: Displays the tenant ID.

Example: -securemode:"False"
-split

or

-sp		 table split options

Specifies split options for a table stored in an existing database. If you want to configure more than one table, you need to specify this parameter for each of the tables. This parameter contains two subparameters: Table (short form: t) and Option (short form: o).

For the Table subparameter, you specify the name of the database table.

For the Option subparameter, you specify one of the three values that indicate the available split modes:

  • Separate
  • Split
  • Shared

Example: -Split:"Table=AccountClass; Option=Shared; " -Split:"Table=AccessInfo; Option=Split; "-Split:"Table=APContact; Option=Separate;"

-company

or

-c

 company options

Specifies tenant options. If you want to configure options for more one tenant, specify this parameter for each of the tenants. This parameter contains the following subparameters:

  • CompanyID: Specifies the tenant ID. To modify the settings of an existing tenant, specify its ID here.
  • ParentID: Specifies the ID of the tenant's parent tenant.
  • Visible: Allows users to sign in to the tenant if you specify the True value.
  • CompanyType: Inserts demo data into the tenant's database if you specify the True value.
  • LoginName: Displays the tenant name on the MYOB Acumatica logon screen.
  • Delete: Deletes the tenant if you specify the True value.

Example: -company:"CompanyID=KC; ParentID=1; Visible=True; CompanyType=True; LoginName=Company; Delete=True"

-output

or

-op

Normal

Quiet

Forced

Specifies the command-line execution mode. Select one of the following possible values:

  • Normal: The command line acts as a dialog. When you run the ac.exe utility, you will answer questions related to the parameters.
  • Quiet: All warnings are ignored. Any error forces the ac.exe utility to stop and exit.
  • Forced: All warnings are ignored. If you do not specify any mandatory parameters, they are automatically configured with default values. Minor errors are ignored, while critical errors force the ac.exe utility to stop and exit.

Example: -output:"Forced"

-dbcollation

or

-dl

 Microsoft SQL Server collation name

Specifies a collation that will be used for a database that is created during MYOB Acumatica instance deployment instead of the default SQL_Latin1_General_CP1_CI_AS collation.

Example: -dbcollation:French_CI_AI

-dboptimize

or

-do

True

False

Specifies whether the Optimize Tables command should be applied to MySQL database tables during deployment of an MYOB Acumatica instance. The default value of this parameter is False because the process of table optimization may take a lot of time. To apply the Optimize Tables command, add this parameter and specify the True value.

Example: -dboptimize:"True"
-portal or -pp

True

False

 Specifies (if set to True) that the Customer Portal should be installed.

Example: -portal:"True"
-coursetemplate or -ct T210

T220

T230

T240

T250

 Specifies the training course for which an MYOB Acumatica instance is deployed and the customization project is published.

Example: -coursetemplate:"T210"
Note: For all command-line parameters that have the False and True values, you can also use No instead of False and Yes instead of True.