Initial Setup Guide

Accessing WebMerge for

You can access WebMerge for at any time from the App Launcher in the top left corner of Salesforce.



WebMerge for gives you access to three Tabs:

1.    Webmerge Documents

2.    Webmerge Mappings

3.    Webmerge Settings


These Tabs are where you will be able to manage your WebMerge document mappings and settings.





WebMerge Settings


To give access to your WebMerge documents, we need to setup an API Key and API Secret in WebMerge.




Visit and either sign in or create a new account.




Under your Profile, click on API Access.




Click on Click here to create an API Key! to get started.  If you've added an API key before, you'll see the +New API Key button, as shown below.



Give your API Key a name. For this example, we’re going to call it WebMerge for Salesforce.




Now you want to copy and paste the API Key and API Secret from WebMerge into WebMerge for settings.



From within Salesforce, Click Login to WebMerge using your new API credentials.




If everything was entered correctly, you’ll see a success message indicating your WebMerge account is connected to Salesforce.





Managing WebMerge Documents

Now that you are logged in to WebMerge, you can view the WebMerge Documents and WebMerge Mappings tabs.

Click on WebMerge Documents and you’ll see that we have given you full access to your WebMerge account right within Salesforce. You can create new Documents or Data Routes here and they will be available to be used in the WebMerge Mappings tab.




Creating a WebMerge Mapping

WebMerge for Salesforce allows you to create WebMerge document mappings using data from records.



Click New WebMerge Mapping to get started on creating a new mapping.


 Fill out the details on the New WebMerge Mapping screen:

·         Mapping Name: Give this mapping a name that will be descriptive to you and your users.

·         Description: Give users a description of what this mapping does or what use case it was created          for.

·         Salesforce Object: Select a standard object for which you’d like to merge the              document with. WebMerge for Salesforce currently supports:

o   Account

o   Case

o   Contact

o   Lead

o   Opportunity

·         Select a WebMerge Resource:  WebMerge allows you to create Documents or Data Routes. You can toggle between both types of resources here. Selecting Documents will give you access to a list of available, active Documents in WebMerge.

·         Select a WebMerge Document (or Route): Select the specific Document or Data Route from WebMerge you’d like to create a mapping for.

Click Save and Next to continue on to Field Mapping.


Creating Field Mappings

Now that we have created a new WebMerge Mapping, we are presented with a series of WebMerge Fields that we can map to existing fields on the Salesforce object that we selected on the previous screen.



Select the Salesforce Field that you want to map to each WebMerge Field. As you are doing this, you will have access to:

·         Fields from the selected Salesforce Object

·         Fields from parent records like Owner, Account, etc.

·         Child Relationships. See Working with Child Relationships for more information on using Child Relationships in your WebMerge documents.

Automatically Generating Documents

With WebMerge you can automatically have a WebMerge Mapping generate a document when specific criteria are met.




Evaluate the following rule when a records is:

·         Created - this will evaluate the rule every single time a record is created. If the rule criteria are met, the document will be created.

·         Created, and every time it’s edited - this will evaluate the rule every single time a record is created and every single time the record is edited. If the rule criteria are met, the document will be created.

·         Created, and any time it’s edited to subsequently meet criteria – this option will evaluate the rule every time a record is created any every time the record is edited and did not previously meet the criteria.


Once you’ve selected the evaluation criteria, you can select up to four criteria that must be met in order for the document to be generated automatically. You have access to the fields on the Salesforce Object that you selected when creating the WebMerge Mapping as well as fields from parent objects like Owner.Name or Account.Name.


Activating and Deactivating WebMerge Mappings

As you build your WebMerge Mapping, you can save it and return to it at any time as you gather requirements and design your document in WebMerge. If you are working with a new mapping, you can Save & Close or Save & Activate. If you choose to Save & Close, you will be able to activate the mapping later.

 Activated Mappings

Once you activate a mapping, it will be available to your users through the WebMerge button on a record. If your mapping has been configured to automatically generate documents, those rules will now be active as well.



Adding WebMerge Buttons to Salesforce Page Layouts

Not only do you have the option to setup criteria for generating documents automatically, users can also generate documents on demand using the WebMerge button on a Salesforce record. The objects currently supported by WebMerge are: Account, Case, Contact, Contract,  Lead and Opportunity.

View a record from each of these objects and click on Setup > Edit Object in the upper right menu.



From within the Object Manager, click on Page Layouts and select the page layout to which you wish to add the WebMerge button.  In this example, we're selecting the Account Layout.


In the Buttons section you will see a WebMerge button.


 Drag the WebMerge button into the Custom Buttons section of the Page Layout.


Save the Page Layout and you will now see the WebMerge button on the detail record. Repeat this for each of the supported Salesforce objects.



Was this article helpful?
1 out of 1 found this helpful


1 comment
  • "With WebMerge you can automatically have a WebMerge Mapping generate a document when specific criteria are met."

    Right now the criteria can only do criterias with :
    1) All conditions are met
    2) Any conditions are met

    How can we achieve a criteria like in workflow rules such that we can specify 1 AND 2 OR 3 OR 4 AND 5?


Please sign in to leave a comment.