Test DocGen Packages

After you create a DocGen Package A customizable package that consists of your Salesforce data, documents, and delivery configurations for documents you want to generate., you can start generating documents. It's good practice to test the DocGen Packages you create to check that your document generates correctly.

By using the Test Run Package you can check to make sure your template and delivery options have been set correctly, all without interrupting other users and sending out a document to a customer on accident. It uses the same Lightning Component that Salesforce Admins can add to their Lightning page layouts. Any time that you make changes to a package, such as changing the delivery option ensure that you refresh the page before using the Run Test Package option.

Use the test functionality to ensure your DocGen Packages include all the information you want in your documents, as well as making sure it looks as you intend it to.

Important: It is recommended that testing packages be done in a test environment as using the Test Run Package option still counts towards your DocGen run limit. Run limits are per environment, so as to not count towards your DocGen run limit in your production environment it is recommended to use a different environment to test.

Test DocGen Packages

  1. On the top right of the page in the DocGen Package Tester, select the object you want to use.
    • If necessary or required, select a Contact record.
  2. Select the Download delivery option that you created.
  3. Test your download by selecting the Run Test button.

  4. The Download delivery option will always appear as default, so you can test your DocGen Packages. The download method will ensure the DocGen Package performs without any unintended actions. Some unintended actions are:

    • Creating or updating records.
    • Creating a task.
    • Sending emails.
    • Creating e-sign transactions.
  5. Select Run DocGen Package.

Once the DocGen process is started, you will have the option to download the document in the output of your choice.

After the DocGen Package Tester generates documents, you can perform any of the following additional options:

  • Start Over: Returns to the select record option and discards all previous selections.
  • Modify Run: Returns to the contact selection, with the same record and Delivery Option selected for generation
  • Re-run DocGen Package:Generates documents again, using the same selections.