Deploying the Sync Engine on a remote server

You can deploy the Sync Engine on a different machine to the Sage CRM server.

  1. Correctly download and install a compatible version of Tomcat on the remote server. Sage CRM 2022 R1 uses Apache Tomcat 8.5.24.
  2. Stop the Tomcat service (Apache Tomcat 8.5 <SageCrmInstallName>Tomcat8) on the Sage CRM server.
  3. Move the following from the Sage CRM server to the remote server hosting Tomcat: 
    • File %ProgramFiles(x86)%\Sage\CRM\<InstallName>\
      tomcat\webapps\<InstallName>ExchangeSyncEngine.war
    • Folder %ProgramFiles(x86)%\Sage\CRM\<InstallName>\
      tomcat\webapps\<InstallName>ExchangeSyncEngine

    Example:

    Source folder on the Sage CRM server

    Target folder on the remote server

    %ProgramFiles(x86)%\Sage\CRM\
    <InstallName>\tomcat\webapps\

    <TomcatInstallationFolder>\webapps

  4. Start the Tomcat service on the Sage CRM server.
  5. Go to <TomcatInstallationFolder>\webapps on the remote server.
    • Check that <InstallName>ExchangeSyncEngine\WEB-INF\db.properties contains valid parameters for connection to the database.
    • Check that ExchangeSyncEngine\WEB-INF\syncengine.properties contains valid parameters for a connection to the Sage CRM endpoint. For example: syncengine.configurationurl=http://2K8X64CRMX86001/sdata/crmj
  6. Restart the Tomcat service on the remote server. A restart is required because properties have been changed.
  7. Install the rewriter module so Sage CRM can access the CRMRewriter.
    • Copy the CRMRewriter folder from the Sage CRM server (%ProgramFiles(x86)%\Sage\CRM\Services\IISUtils) to the remote server.
    • On the remote server, add an SData application to IIS, which points to the CRMRewriter folder.
    • In the CRM.Rewriter.rules file, remove all lines except the line containing: RewriteRule ^(/sdata/test.html)/sdata/Default.aspx?r=$1 [R,NC] and for example, RewriteRule ^/sdata/[install name]ExchangeSyncEngine/(.*)$ http://[remote server name]:10009/[install name]ExchangeSyncEngine/$1?%{QUERY_STRING} [P].
    • In the CRM.Rewriter.rules file change the line: RewriteRule ^/sdata/[install name]ExchangeSyncEngine/(.*)$ http://pl-crm70-vm:10009/[install name]ExchangeSyncEngine/$1?%{QUERY_STRING} [P] to match the Exchange Sync Engine folder and port that Tomcat uses.
    • Restart IIS and check that the rewriter module works. For example, the following URL should return an unauthorized access page: http://localhost/sdata/[install name]ExchangeSyncEngine/$service/status.
  8. Check that the Sync Engine is visible from the Sage CRM server. For example, the following URL should return an unauthorized access page: http://<sync engine host name>/sdata/<appname>ExchangeSyncEngine/$service/status.
  9. Create a connection to Exchange Server using the Sync Engine deployed on the remote server. These steps are described in Creating a connection to Exchange Server.