Dynamic PDFs and Documents with WebMerge

12/02/2014 Posted by Brandon

When it comes to using your Knack database to generate formatted PDF, Word, and other documents, WebMerge is a great tool that we often recommend.

Although Knack lets you print any page in your interface to a PDF, sometimes you need more custom formatting or other document types.

WebMerge makes it easy to set up your documents and then use Zapier or our API to populate those documents with records from your Knack database.

The following is a guest post by Webmerge’s very own Jeremy Clarke on how to to do some custom integration with Knack and Webmerge.

Email a Merged Document

In this example, we’re going to show you how to generate a contract and send it to our customer directly from a Knack CRM application. First, we’ll setup our contract template in WebMerge, then we’ll add a custom button to our Knack application that will send our client data to WebMerge to generate the contract.

For our contract, we’re going to use a Word document as the document type. In the document we are going to add all of the normal contract terms, and then we’ll add the WebMerge merge fields (ie {$company_name}, {$address}, etc) where we want the Knack data to go. Here’s what our contract template looks like:

After we upload our document to WebMerge, we need to make sure we update the email delivery settings so that the contract is emailed to our client. You can make these changes under the Deliver tab. You’ll want to change the “To” address to the merge field for the email address. If you don’t have an email address merge field setup yet, simply click the >“ option and type in {$email}. This will add “email” as a merge field.

On the Merge tab inside WebMerge, you’ll notice there is a “Merge URL” for your document. This is the unique URL that you’ll use when sending data to WebMerge to populate your contract. Save this for later.

Next, let’s jump into Knack and setup the custom button that will be used to generate a contract for a specific client. The setup process is pretty straight forward, but it is a little technical. We’ve tried to include as many examples as we could to help you, but Knack has a great support team that is more than happy to help with this custom coding.

We’re going to use Javascript to customize our Knack application to show a “Create Contract” button on our Client Detail page. To edit the Javascript for our application, we’re going to go to the API & Code page in our application settings. Once there, click the Javascript tab and you should see a code editor (text box). This is where we are going to use jQuery to manipulate our page.

We’re going to use this code snippet as a starting point for our application. There are a few things that you need to figure out when setting up the javascript:Which “Scene” is your page inWhich “View” in that scene is your pageWhat the Field IDs are that you need to send to WebMerge

The easiest way to find this information is to “inspect” the HTML in your browser (either using the built-in development tools or using a plugin like Firebug). You will be looking for elements in the HTML like and . These IDs will be important in our javascript.

When a new scene loads, an event is fired and we can capture that with jQuery. You’ll notice the first line in our code example is looking for “$(document).on(‘knack-scene-render.scene_3’, …” – This event will fire when our scene is rendered. This is when we want to add the button to our view page.

To add the button to our view page, we’re going to use jQuery to create a new div container that will contain our button. Then we will attach an event handler on the button that will use AJAX to send the data to our WebMerge contract. Here’s what our code looks like:

As you’ll see in the code above, we add the link to our page, set an event handler that uses AJAX to send the contact data to WebMerge (using our Merge URL) and displays a message when complete. This happens behind the scenes without ever having to leave Knack!

Here’s what the button looks like in action:

Let’s click that button! Everything worked great and here’s the document we have generated. All of our data from Knack is in the document and it has been emailed off to the client. How’s that for easy?

Wait, there’s more…

Generate and Download Merged Document

Creating a document behind the scenes is cool, but what if you want to open up the document right away without having to go to your email? No problem, here is an updated code example that will generate a link that sends data to WebMerge in a new window rather than AJAX and then your document will be there for you