Share via

Install Microsoft Dynamics CRM Email Router using a command prompt

  • Article

 

Applies To: Dynamics CRM 2016, Dynamics CRM Online

Note

The Microsoft Dynamics CRM Email Router is deprecated for December 2016 update for Dynamics 365 (online and on-premises) or later. We strongly recommend that you migrate all email routing functionality to use the server-side synchronization feature. More information: Migrate settings from the Email Router to server-side synchronization and Set up server-side synchronization of email, appointments, contacts, and tasks.

The Email Router accepts the same command prompt parameters as Microsoft Dynamics 365 Server. To install the Email Router in quiet mode, run the SetupEmailRouter.exe command in the EmailRouter folder on the installation media, or download location of the Microsoft Dynamics CRM installation files as follows:

SetupEmailRouter /Q /CONFIG folderpath\install-config.xml /L c:\temp\log.txt

This installation uses an XML configuration file named install-config.xml and creates a log file named log.txt.

In This Topic

Email Router XML configuration file

Sample Microsoft Dynamics CRM Email Router XML configuration file

Email Router XML configuration file

The /config[drive:] [[path] configfilename.xml]] command-line parameter provides Microsoft Dynamics CRM Email Router Setup with required information. It is the same information that each Microsoft Dynamics CRM Email Router Setup Wizard screen requires.

Important

To use the Email Router after it is installed, you must run the Email Router Configuration Manager to configure it. You cannot configure the Email Router by using an XML configuration file.

The XML elements must be in English (US). An XML configuration file that has localized XML elements will not work correctly.

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.
  • <EmailRouter> </ EmailRouter>
    Specifies a Microsoft Dynamics CRM Email Router installation. The <EmailRouter> tag must be within the <CRMSetup> open and end tags. All the Email Router entries that follow must be within the <EmailRouter> tags.

  • <InstallType>Uninstall/Repair</InstallType>
    Specifies the type of installation that Setup will perform. The following options are available:

    Uninstall

    Uninstalls Microsoft Dynamics CRM Email Router.

    Repair

    Starts Setup in repair mode.

  • <Patch update="true"/"false">\\ServerName\ShareName\Patch_Location</Patch>
    If you do not specify a location, by default Setup will go online to a location that is managed by Microsoft to search for available updates. Or, you can point Setup to install a Microsoft Dynamics CRM Email Router Setup update .msp file from a different location, such as an internal share.

    update

    Specifies whether Setup will look for, download, and apply updates for Microsoft Dynamics CRM Email Router 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.

  • <muoptin optin="true”/“false" />
    Specifies whether to use Microsoft Update to download and install updates for the Microsoft Dynamics CRM Email Router. After the installation is completed, this feature helps keep your computer up-to-date on an ongoing basis.

    • True. When you specify this option, Setup will opt in to Microsoft Update as the update service and use the Windows automatic updating settings on the computer. Windows automatic update settings can be viewed in Windows Update in Control Panel. Microsoft Update helps make sure that your computer has the latest technology, which can help reduce the risk of vulnerabilities and security issues.

    • False. When you specify this option, Setup won’t change the existing Windows automatic update settings. If the computer isn’t already configured to use Microsoft Update as the update service, we recommend that you have another method to install updates on the computer, such as by using Windows Update Services. If left blank, a value of false will be selected.

  • <InstallDir>c:\Program Files\Microsoft CRM Email</InstallDir>
    Specifies the folder where the Email Router will be installed. By default, the Email Router is installed to C:\Program Files\Microsoft CRM Email.

  • <Features></Features>
    If a value is not specified, Setup installs the Email Router service and the Email Router Configuration Manager, but does not install the Rule Deployment Wizard.

    The following features are available:

    • <SinkService />
      Add this entry if you want to install the E-mail Router service and Email Router Configuration Manager.
    • <RulesWizard />
      Add this entry if you want to install the Rule Deployment Wizard.

Sample Microsoft Dynamics CRM Email Router XML configuration file

The following configuration-file sample instructs Setup to check a Microsoft Web site for available updates to Email Router Setup and if found, apply them. It opts-in to Microsoft Update and then installs the Email Router service and Rule Deployment Wizard in the C:\Program Files\Microsoft Dynamics CRM Email Router folder:

<CRMSetup>
<EmailRouter>
<Features>
  <SinkService />
  <RulesWizard />
</Features>
<Patch update="true"></Patch>
<muoptin optin=”true” />
<InstallDir>c:\Program Files\Microsoft Dynamics CRM Email Router</InstallDir>
</EmailRouter>
</CRMSetup>

See Also

Set up Email Router
Email Router

© 2016 Microsoft. All rights reserved. Copyright