Test a document package

Before deploying a document package, it's recommended to test the template to ensure it’s set up correctly and generating the document as expected. Testing helps verify that data merges properly through tagged fields and that the content displays as intended by the template designers. It’s also a useful step for identifying and troubleshooting any errors that may occur during document generation.

For example, let's say you check the status of a document on the Instances page and find that some documents failed to generate due to an error during the generation process. By using the testing function, you can troubleshoot the issue and make any necessary adjustments to fields, data, or the workflow.

Caution: Testing a document using the test package function counts towards a document generation entitlement. Therefore it is recommended to only test for issues during the initial deployment of the document package, or to troubleshoot any errors that arise.

Access the test document package function

To access the testing functionality for document packages:

1. Go to Documents.

2. Select an existing document package from the package list.

3. Go to Testing. The Testing pane contains the Testing tab and the Instances tab.

Run a document package test

To run a test for an existing or new document package:

1. Open an existing document package.

2. Go to Testing.

   All tagged fields that have been added to the document previously display in the Testing tab.

3. For each tagged field, type in data that you want to display for those sections when the document is generated.

   For example, if you were looking to test a tag called "Account_Name" then you would type in the name of an account into the tagged field.

4. After all tagged fields have been filled out, click Run test. The Instance tab displays showing a status of "Running" for the current test being run.

5. Wait for the test to complete, and for the status to change to Completed or Failed depending upon the success of the test. It may be necessary to refresh the page before the status updates.

6. After the test run is completed, click the ellipsis icon to display a list of actions you can perform for the completed test.

7. Go to > ellipsis > Download to download the completed document.

8. Wait for the document to download, and then open the file. Ensure that all data has been merged into the desired sections of the document.

Instances tab

After you have run a test for a document package, the results for that test display in the Instances tab. The results that display in this pane only show results for tests that you have run for the document package that is currently open, and does not display the results of other users who have also run tests for the document package.

The Instances tab displays the following data related to a test run:

Option	Description
Status	Displays the status of the last 10 tests run on the document package: Completed Failed Running
Started	Displays how long ago a test was run for the document package.

 

From the Instances pane there are several actions you can take related to the test that was run:

Action	Description
Refresh	Refreshes the currently displayed instance list to show any changes that have been made. For example, if a test package is run but is not showing up in the list, the Refresh button can be used to update the list to display the completed test run.
Instance details	Opens the Instance Management page for the document package in a new tab.
Download	Downloads the file generated from the test run. Documents are only available for download for 24 hours after a test has been run.
Share	Copies a link to the document package's Instance Management page that can then be shared by various means, such as Slack or an email.
Delete	Deletes the selected instance and triggers a refresh to load the next 10 instances that have been run.