Configuring Doc Merge in On-Site Instances

Overview

Doc Merge pulls data from Sugar® records into professional-quality documents such as contracts, quotes, NDA agreements, form letters, and labels. For on-site customers, Doc Merge may need some additional configuration. For example, you may want to change the server that Doc Merge is communicating with for speed and/or legality purposes. Additionally, you may need to ensure that the appropriate IP range is open on your firewall to allow communication between Sugar and the Doc Merge server. This article will walk you through how to configure both. 

Changing the Region

For Sugar versions 14.0.x and higher, the Doc Merge region can be configured via Admin > System Settings. For versions lower than 14.0.x, locate the config.php file that is at the top of the directory where Sugar is installed. Edit this file in the text editor of your choice. Then, find the following code in the file:

  'document_merge' => 
  array (
    'max_retries' => 3,
    'service_urls' => 
    array (
      'default' => 'https://document-merge-us-west-2-prod.service.sugarcrm.com',
    ),
  ),

Replace the service URL in the line starting with 'default' with a new value from the below table. These URLs are in different regions. You will want to choose the location that best suits your needs. Choosing a server in the region you reside in will help increase the speed of Doc Merge. Additionally, you may need to choose a particular region for legal purposes. 

Note: Be sure to keep the comma at the end of the line to prevent a syntax error.

Once your changes are complete, save and close out the file. 

Configuring IP Access

If you have an IP restriction on your server, you must add the corresponding IPs to your allowlist. The IPs will correspond with the region's URL that you selected when changing the region. Add the IP addresses for your selected region to your allowlist according to the following table:

Note: A valid SSL certificate is required for your Sugar instance for Doc Merge to work.