Server XML configuration file

[Applies to: Microsoft Dynamics CRM 4.0]

The /config [drive:] [[path] configfilename.xml]] command-line parameter provides Microsoft Dynamics CRM Server Setup with required information. The information supplied by the XML configuration file is the same required by each installation screen.

Important

The XML elements must be in English (US). An XML configuration file that has localized XML elements will not work correctly. For example, if you have a German version of Microsoft Dynamics CRM Server, the XML file elements must still be English (US).

By default, Setup will use e UTF-8 encoding for the Setup XML configuration file. Setup cannot load an XML configuration file when there are extended characters in the file. You will receive an error message from Setup that the XML file is invalid. If the XML configuration file contains extended characters, you can work around this issue by saving the XML configuration file by using Unicode encoding. To do this, open the XML configuration file in Notepad, click Save As, in the Encoding list select Unicode, and then click Save.

An explanation of each XML element and a sample XML file follows:

<CRMSetup> </CRMSetup>

The configuration file must be a valid XML file that uses <CRMSetup> as the root element.

<Server> </Server>

Specifies a Microsoft Dynamics CRM Server installation. All the Microsoft Dynamics CRM Server entries that follow must be inside the Server tags.

<InstallType>Uninstall/Repair</InstallType>

Specifies the type of installation that Setup will perform. The following options are available:

Uninstall. Uninstalls Microsoft Dynamics CRM Server.

Repair. Starts Setup in repair mode.

<Patch update="true"/"false">\\ServerName\ShareName\Patch_Location</Patch>

By default, this element does not specify a location, which configures Setup to search for available updates on a CRM Updates Internet site controlled by Microsoft. If you want Setup to install updates from another location, such as a share on your network, add the filepath to the .msp file in the element, as shown in the example.

update. Specifies whether Setup will look for, download, and apply updates for Microsoft Dynamics CRM Server Setup. We recommend that you let Setup download the latest version by selecting true. By default, this value is set to false. If the value is set to false, Setup will ignore this step and continue with the installation.

For more information about how to obtain Setup updates, see How to obtain the setup updates for Microsoft Dynamics CRM 4.0.

<SqlServer>SQLServername</SqlServer>

Specifies the name of the instance of Microsoft SQL Server that will manage the Microsoft Dynamics CRM Server database files. If SQL Server is running on the computer where you are installing Microsoft Dynamics CRM Server you can specify ". " or "localhost".

<Database create="true"/"false" update="true"/"false"/>

create

Values for this parameter are either true or false. True causes Setup to create a new Microsoft Dynamics CRM database. False causes Setup to connect to an existing Microsoft Dynamics CRM database as indicated by the Active Directory organizational name (see the following <Organization> element).

update

Values for this parameter are either true or false. When you select true, Setup will write the appropriate server deployment information to the configuration database (MSCRM_CONFIG). Select false only when you are using a pre existing configuration database and you do not want Setup to update the server deployment information. When you select false, the appropriate server deployment information for the computer where Microsoft Dynamics CRM 4.0 Server is being installed must already exist in the configuration database for Setup to complete successfully. The default value is true.

<Organization>Organization friendly or long name</Organization>

Specifies the long name of your organization. The name can be up to 250 characters long and extended characters are supported.

<OrganizationUniqueName>OrganizationName</OrganizationUniqueName>

Specifies the name of your organization. There is a 30 character limit. Notice that extended characters or spaces are not allowed. If you leave this element blank Setup will generate a short name based on the OrganizationFriendlyName value.

<OU> OU=value,DC=value,DC=value,DC=value,DC=value</OU>

The <OU> element specifies the Active Directory organizational unit (OU) and domain (DC) values that this Microsoft Dynamics CRM Server computer is to be associated with. For example, <OU> OU=CRM, DC=MySubDomain, DC=MyDomain, DC=com</OU>.

<LicenseKey>KeyValue</LicenseKey>

Specifies the license key for this deployment. The configuration file can contain only one Microsoft Dynamics CRM license key. For example:

<licenseKey>XXXXX-XXXXX-XXXXX-XXXXX-XXXXX</licenseKey>

Note

If you purchase Microsoft Dynamics CRM through a Microsoft Volume Licensing program, the license key is provided in the license.txt file. The license.txt file is included in the Microsoft Dynamics CRM installation files.

<WebsiteUrl Create="true"/"false" port="TCPportnumber">/LM/W3SVC/1</WebsiteUrl>

Specifies the path for the Web site to be created on the Microsoft Dynamics CRM Server.

Use Create="true" to create a new Microsoft Dynamics CRM Web site and leave the value between the element tags blank. Specify Create="false" to use an existing Web site and then you must enter the Web site node in the element tags, such as /LM/W3SVC/1, which is the default Web site.

Use port="TCPportnumber", where TCPportnumber is a valid and available TCP port number, to specify the port for connecting to the Microsoft Dynamics CRM Server application. If left blank, the port number that will be used is 5555.

<InstallDir>c:\program files\Microsoft CRM</InstallDir>

Specifies the folder in which Microsoft Dynamics CRM Server files will be copied.

<basecurrency isocurrencycode="CurrencyCode" currencyname="CurrencyName" currencysymbol="CurrencySymbol"/>

Specifies the ISO three-letter currency-code, display name, and symbol to use for the base currency. For example, if you want to have to use U.S. dollars as the base currency, use isocurrencycode="USD". You must use a valid ISO currency description for the isocurrencycode attribute. You must also specify the currency-name and currency-symbol display names for the ISO base currency. For example, if the ISO currency code is USD, the currency name should be "US Dollar" and the currency symbol should be "$". However, you can use any string that you want for those attributes.

Important

After Setup is complete, you cannot change the base ISO currency code. However, you can change the base-currency name and base-currency symbol.

A list of supported ISO currency codes are available in the System Requirements section of the Microsoft Dynamics CRM 4.0 Implementation Guide.

<OrganizationCollation>CollationName</OrganizationCollation>

Specifies the SQL Server database collation name to use for the organization database. For example, Latin1_General_Cl_Al, which is the default collation for English (US) language deployments. For more information about database collation, see the following Microsoft MSDN Web site:

SQL Server Collation Fundamentals

<CrmServiceAccount type="DomainUser">
     <ServiceAccountLogin>login</ServiceAccountLogin>
     <ServiceAccountPassword>password</ServiceAccountPassword>
</CrmServiceAccount>

Specifies the Microsoft Dynamics CRM service account type. Accepted values include NetworkService, which uses the Network Service system account, or DomainUser, which will use the specified domain user. By default, Setup will use the Network Service account. If DomainUser is specified, <ServiceAccountLogin> and <ServiceAccountPassword> are required. If this option is not used, Setup will use Network Service.

Caution

Maintaining the configuration file that has <ServiceAccountLogin> and <ServiceAccountPassword> values specified is a security risk because you are storing a password in plain text. Delete these elements as soon as the configuration file is used to install Microsoft Dynamics CRM Server.

<SQM optin=" true / false"/>

Specifies whether you will participate in the Customer Experience Improvement Program. If you specify true, you will participate in the program.

Note

By default, the Customer Experience Improvement Program feature in Microsoft Dynamics CRM is turned on. Later, if you decide that you do not want to participate in the Customer Experience Improvement Program, you can turn off this feature in the Microsoft Dynamics CRM Web application. To do this, in the Navigation Pane, click Settings, under Settings, click Administration, in the Administration area click Privacy Preferences, in the Privacy Preferences dialog box clear the Yes, I am willing to participate anonymously in the Customer Experience Improvement Program check box, and then click OK.

<Reporting UseSSL="true"/"false" URL="http://srsserver1/ReportServer"/>

UseSSL. If the SQL Server Reporting Services Web site uses SSL, designate true, otherwise, enter false.

URL. Specifies the URL of the Report Server.

<Groups autogroupmanagementoff="true/false">

     <PrivUserGroup>CN=value,OU=value,DC=value,DC=value,DC=value</PrivUserGroup>

     <SQLAccessGroup>CN=value,OU=value,DC=value,DC=value,DC=value</SQLAccessGroup>

     <UserGroup>CN=value,OU=value,DC=value,DC=value,DC=value</UserGroup>

     <ReportingGroup>CN=value,OU=value,DC=value,DC=value,DC=value</ReportingGroup>

<PrivReportingGroup>CN=value,OU=value,DC=value,DC=value,DC=value</PrivReportingGroup>

     </Groups>

When used, Setup will use the existing groups in Active Directory instead of creating them during installation. If <automanagegroupsoff> is true, Setup will not add or remove any members to those groups.

<Reboot>true/false</Reboot>

If this option is not specified, the default is false. This means that the server will not restart at the end of Setup. Also, this option applies only to a final install restart, and not previous restarts that may be required for other components.

<Email>

<IncomingExchangeServer name=" ServerName"/>

Specifies the Microsoft Exchange Server computer or POP3 that will be used by the E-mail Router to route incoming e-mail messages.

</Email>

Specifies the e-mail server that will be used for e-mail routing.

<InstallDir>C:\Program Files\Microsoft Dynamics CRM</InstallDir>

<configdb>

This is the parent for the following encryption key elements:

Warning

By default, encryption keys are not stored in the configuration database in an encrypted format. We strongly recommend that you specify encryption when you run Setup by using the following entries. For more information, see Key Management inMicrosoft Dynamics CRM.

<encryptionkeys certificate="CrmEncryptionCertificate" generate="true"/"False" password="SCpassword" keysource="uniqueID">

The encryptionkeys element specifies how, and whether, to encrypt the keys that are stored in the Microsoft Dynamics CRM system. Use generate="true" to enable the system-generated keys that are encrypted. The keysource may be any value, but must be different from other keysource values. SCpassword is the password that will be used to create the symmetric certificate.

Warning

Maintaining a configuration file that has password and keysource values specified is a security risk because you are storing a password and key information in plain text. We recommend that you save the password in a secure location from where it can be retrieved later for recovery. Then, delete these elements as soon as the configuration file is used to install Microsoft Dynamics CRM.

<encryptionkey physicalname="CrmSymmetricKey" virtualname="CrmKeyEncryptionKey"/>

Each encryptionkeys element specifies a mapping between a symmetric key store in the Microsoft SQL Server database to a virtual key name, hard-coded in Microsoft Dynamics CRM for encrypting data in the configuration database.

</encryptionkeys>

</configdb>

For more information, see:

Encryption key example

Sample server XML configuration file

Sample server XML configuration file for installing with pre-created groups

Sample server XML configuration file for Internet-Facing Deployments

© 2011 Microsoft Corporation. All rights reserved.