Merges Overview

A merge is the unique file conversion or delivery of a document or data route generated by Formstack Documents. 
 

How do I set up a merge?

How are merges counted?

How do I view merges?

How can I test merges?

How do I manage my merge count limit?

How do I set up a merge?

Set up merges from the Document’s Deliver tab in the initial creation of a Document or Data Route. Within the Deliver tab, manage where you send your document. Documents are commonly sent to emails and/or a CRM source.  

If deliveries aren’t set up, select the Click here to create a delivery button or select + New Delivery to add any additional deliveries. Then follow the prompts in the dialogue box to add needed information.

NOTE: Formstack Documents cannot store or retain data; review your delivery setups to avoid re-merging data. 
 

How are merges counted?

• Merges are counted by the number of locations a document is delivered to. For example, if a document is set up to deliver to two locations like an email and Google Drive or an email and a data route then the merge count increases by two. 
• When processing route rules, merges are counted for all external file downloads when there are more than 5 being downloaded.

Specific merge count examples

1. Fill out a Formstack Form connected to a Document with email deliver = 1 merge as it’s one single delivery.
2. Fill out a Formstack Form connected to a data route with conditional logic set up to only send one of the documents in the route to send an email = 1 merge as it’s one single delivery.
3. Use Data Route with 5 separate document templates, without conditional logic, with one delivery set up = 5 merges as this is 5 documents being generated.
4. A document generation that includes combining five different PDF files into a single PDF then delivered through email = 5 merges as this is 5 documents being generated. 
5. Submit a merge without the delivery setup but Debug Mode is enabled in set up = 1 merge as a document generated will always count as a minimum of 1 merge.
6. Reports like Salesforce or a CSV file with 20 rows mapped to deliver emails = 20 merges as it’s 20 unique email deliveries.
7. Documents for Salesforce are set up with email delivery = 1 merge.
8. Documents for Salesforce are set up to send for Signature and then stored in Salesforce once signed = 2 merges as it’s two deliveries.
9. Documents for Salesforce are set up, but in test mode, and uploaded back to Salesforce = 0 live as it counts for test merges and will be output with a watermark.

How do I view merges?

You can view your merges for a specific document under the Document Overview tab > Recent Merges: 


 

If you'd like to see the total merges on your account for a specified timeframe, you can find the option under Reports > Merge Overview. 

Note - the summary view will outline all document deliveries and any additional file conversion steps will be counted as part of the files total at the top of the page.

Under the Recent Merges tab, you can get more granular with the merge reporting and set a timeframe as well as export the report as a CSV if needed. If you'd only like to view reporting for specific documents, you can also select the  document or data route and update the report request. 

How can I test merges?

Test merges, or deliveries with watermarks, can be generated from:

1. Under Settings, toggle the Status to Test Mode.
2. Under Merge, utilize the Test URL.
3. Under the Test tab, enter the values and select Test Document.
4. Within the preview functionality from Docs for Salesforce managed package.
5. Set up within the Docs API.
6. All documents are delivered as Test Merges when an account reaches its merge limit.

How do I manage my merge count limit?

Merge counts are on a monthly cycle, based on your subscription date. View your Documents home page to view your current merge count, and merge reset date. 

Note that merge counts are reset the day of a new monthly cycle, at ~4pm Eastern Time on the date of the new cycle.

View your billing page to:

• View your plan and merge count limit/per month
• Choose to auto-upgrade if you hit your monthly quota
• Verify all deliveries set up within your account under the Delivery Accounts tab
  • You can also re-authenticate, delete, and view the number of deliveries within each connected app.

Without enabling the auto-upgrading feature, the documents will deliver in test mode until upgraded or when the merge count resets in the next month.  

Test Merge count limit

Test merges are limited to your plan type. Please review your Billing page for the monthly amount available.