Skip to main content


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

Assigning recipients to an envelope

Updated on April 5, 2022

Define the entities that receive a DocuSign envelope by adjusting the pyAssignRecipientsToEnvelope data transform to your business needs.

In DocuSign, recipients interact with one or more areas of a document, for example, by signing that document or taking some other action. You specify the type of action that each recipient must take with regards to the document through DocuSign entities called tabs.
Before you begin: Save the pyAssignRecipientsToEnvelope data transform rule as part of your application ruleset, in the case type class that integrates the DocuSign services.

Supported tab types

Tabs are places in a document where a recipient must provide input, typically a signature.

You assign tabs to individual recipients for input. After a recipient enters data for all tabs in all assigned documents in an envelope, the signing process is complete.

Pega Platform supports the following DocuSign tab types:

  • Sign Here
  • Initial Here
  • Date Signed
  • Text
  • Note
  • Checkbox
  • Email
You can define the placement of a tab in a document through anchor tagging or fixed positioning, depending on the tab type.

Anchor tagging

You define the placement of Sign Here, Initial Here, and Date Signed tabs by using anchor tagging. In this method, DocuSign searches a document for every location where a specific text string (called an anchor) is located. For each anchor, DocuSign places a tab of the type you specified for the designated recipient. You set the exact tab position with regards to the anchor by providing offset values on an x and y axis.

For more information, see the following article in the DocuSing Developers documentation: Auto-place (anchor tagging).

Fixed positioning

For Text, Note, Checkbox, and Email tabs, you define their placement at a fixed location in a document, primarily by using the .pyXPosition and .pyYPosition properties that are measured in points.

Note: A millimeter is 3.572 points.

For more information, see the following article in the DocuSing Developers documentation: Fixed positioning.

Configuring the data transform

Add recipients, define their roles in the signing process, and determine whether to use advanced identity verification by configuring the pyAssignRecipientsToEnvelope data transform.

  1. Find and open the pyAssignRecipientsToEnvelope data transform.
  2. On the Definition tab, in data transform step 2, add a signer:
    StepPropertyDescription
    2.1.pyDeliveryMethodChange the sample value to "Email"
    2.2.pyRecipientId

    Provide a unique ID for an envelope recipient.

    The value must be a non-negative integer. For example, "1"

    2.3.pyRoutingOrder

    Define the recipient place in the routing order, where each recipient receives the email notification when the previous recipient completed their assigned action.

    The value must be a non-negative integer. For example, value "1" means that the recipient is first in the routing order.

    2.4.pyNameProvide the full legal name of the recipient.
    2.5.pyEmailProvide the email address of the recipient.
  3. In step 2.7, configure the setting for recipient identity verification:
  4. In data transform steps 2.9.3 through 2.9.5, define the placement of Sign Here, Initial Here, and Date Signed tabs, as needed:
    PropertyDescription
    .pyAnchorString

    Place this tab type by each instance of this text string.

    For example, for the Sign Here tab, enter "Place your signature here"

    .pyAnchorUnits

    Define the units for measuring the tab placement in relation to the anchor.

    The available values include:"pixels""inches""centimeters""millimeters"

    .pyAnchorXOffset

    Define how to place the tab on the x (horizontal) axis with relation to the anchor.

    For example, if you enter "1"and the value of the .pyAnchorUnits property is "inches", it means that DocuSign places the tab one inch to the right of the anchor.

    .pyAnchorYOffset

    Define how to place the tab on the y (vertical) axis with relation to the anchor.

    For example, if you enter "0", DocuSign places the tab parallel to the anchor.

    .pyAnchorIgnoreIfNotPresent

    To allow completing the envelope if DocuSign does not detect the anchor, change the default value to "true".

    To return an error message if DocuSign does not detect the anchor, enter "false".

  5. In data transform steps 2.9.7 through 2.9.10, define the placement of Text, Note, Checkbox, and Email tabs, as needed:
    PropertyDescription
    .pyDocumentIdProvide the ID of the document on which to place the tab.
    .pyRecipientIdProvide the ID of the recipient to associate with the tab.
    .pyPageNumberProvide the page number on which to place the tab.
    .pyXPositionProvide the horizontal offset (in points) to use in combination with the .pyYPosition property value to determine the tab placement on a page.
    .pyYPositionProvide the vertical offset (in points) to use in combination with the .pyXPosition property value to determine the tab placement on a page.
    .pyName

    Provide the tooltip associated with the tab.

    For example, use the tooltip to provide recipients with additional information that facilitates tab completion.

    .pyTabLabelProvide the tab display name.
    .pyHeightProvide the height of the tab in points.
    .pyWidthProvide the width of the tab in points.
    .pyValue
    Note: Applicable to the Text and Note tabs.

    Enter the text that this tab contains.

    For example, a Note tab might provide additional legal information regarding completing a document.

    .pySelect
    Note: Applicable to the Checkbox tab.

    Require the recipient to select the checkbox, enter "true". Otherwise, enter "false"

    .pyShared
    Note: Applicable to the Checkbox tab.

    Allow other recipients to view the checkbox input by entering "true". Otherwise, enter "false"

  6. For data transform steps 2.9.3 through 2.9.10, delete or disable the steps for the tabs that you do not use.
  7. Add carbon copy recipients:
    Note: Disable data transform step 4 if you do not require carbon copy recipients.
    1. In data transform step 4, enter the recipient details and specify their place in the routing order:
      StepPropertyDescription
      4.1.pyNameProvide the full legal name of the recipient.
      4.2.pyEmailProvide the email address of the recipient.
      4.3.pyRecipientId

      Provide a unique ID for an envelope recipient.

      The value must be a non-negative integer. For example, "1"

      4.4.pyRoutingOrder

      Define the recipient place in the routing order, in which each recipient receives the email notification when the previous recipient has completed their assigned action.

      The value must be a non-negative integer. For example, value "2" means that the recipient is second in the routing order.

    2. Optional: To add more carbon copy recipients, create a copy of data transform step 4, and then set the recipient information by configuring the corresponding data transform steps.
  8. Optional: To add more signers, create a copy of data transform step 2, and then repeat task steps 2 through 7.
  9. Confirm your settings by clicking Save.

  • Previous topic Configuring basic authentication details for DocuSign envelope requests
  • Next topic Configuring advanced identity verification for envelope recipients

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.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us