Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Requesting digital signatures through DocuSign templates

Updated on April 6, 2022

Speed up the signing process and reduce the risk of errors by using DocuSign templates.

Using templates simplifies your workflow when sending similar documents, for example, non-disclosure agreements, or when sending documents to the same group of people, for example, in case of loan documents.

Before you begin:
  1. In the DocuSign Developers portal, create a template, and then note the template ID.
  2. In the DocuSign Developers portal, create recipient roles for the template.
    Remember: When you use a template to send a document, roles are placeholders that help to determine the parties involved in the signing process, for example, Applicant, Client, and Sales Rep, without providing personal information. You also simplify template reuse because recipients might vary each time you send an envelope. The following figure shows a sample role in a DocuSign template:
    Setting recipient information in a DocuSign template
    A section of a template in the DocuSign Developer portal in which you configure recipient information.
For more information, see the following article in the DocuSign Developer documentation: About templates.

Enable support for DocuSign templates in your Pega Platform application by adjusting the pyPrepareNewEnvelope data transform configuration.

  1. Find and open the pyPrepareNewEnvelope data transform.
  2. On the Definition tab, under data transform step 2.4, set the ID of the template that you want to use:
    2.4.3Set.pyTemplateIDSelect which DocuSign template to use by providing the corresponding template ID.
  3. Add a template role, and then associate the role with a recipient:
    1. For the data transform step that you created in task step 2, add a sibling data transform step for creating a top-level page as a container for the role and the associated recipient:
      Append and Map to.pyTemplateRolesSelect a new page.
    2. For the top-level page, specify the role name, and then provide the recipient information by adding the following child steps:
      Note: Consider the following points:
      • You can skip setting the recipient details through the .pyName and .pyEmail properties for a role if you already defined these details in the template.
      • You can add one recipient per role only.

      Enter a role name.

      For example "Sales Rep".

      Note: The role name that you enter must match the corresponding role name in the DocuSign Developers portal.

      Provide the full legal name of the recipient.

      For example, "Kyle Reese".


      Provide the email address of the recipient.

      For example, "[email protected]".

    3. To add more roles to the template, repeat task steps 3.a through 3.b.
  4. Disable data transform step 2.4.12 that sets the .pyRecipients page through the pyAssignRecipientsToEnvelope data transform.
  5. Confirm your settings by clicking Save.
    For example: The following figure shows the selection of data transform steps that you must configure in your application to use templates in your digital signature workflow:
    Adjusting the pyPrepareNewEnvelope data transform to use templates
    The steps in the pyPrepareNewEnvelope data transform that enable support for DocuSign templates.
  6. Bypass the envelope validation by performing the following actions:
    1. Save the pyValidateEnvelope activity as part of your application ruleset.
    2. Configure the activity to end after the activity first step.
    3. Save the activity.
What to do next: Configure a case type to use a template-based workflow for signature requests. For more information, see Configuring a signature request to DocuSign.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us