Assigning recipients to an envelope
Define the entities that receive a DocuSign envelope by adjusting the
pyAssignRecipientsToEnvelope data transform to your business
needs. 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: 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
For more information, see the following article in the DocuSing Developers
documentation: Auto-place (anchor tagging). 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. For more information, see the following article in the DocuSing Developers
documentation: Fixed positioning. Add recipients, define their roles in the signing process, and determine whether to
use advanced identity verification by configuring the
pyAssignRecipientsToEnvelope data transform. Provide a unique ID for an envelope recipient. The value must be a non-negative integer. For example,
"1" 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. Place this tab type by each instance of this text
string. For example, for the Sign
Here tab, enter "Place
your signature here" Define the units for measuring the tab placement in
relation to the anchor. The available values include: Define how to place the tab on the 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. Define how to place the tab on the For example, if you enter "0",
DocuSign places the tab parallel to the anchor. 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". Provide the tooltip associated with the tab. For example, use the tooltip to provide recipients with
additional information that facilitates tab
completion. Enter the text that this tab
contains. For example, a Note tab
might provide additional legal information regarding
completing a document. Require the recipient to select the checkbox, enter
"true". Otherwise, enter
"false" Allow other recipients to view the checkbox input by
entering "true". Otherwise, enter
"false" Provide a unique ID for an envelope
recipient. The value must be a non-negative integer. For
example, "1" 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.tabs
. Supported tab types
You can define the placement of a tab in a document through anchor tagging or fixed
positioning, depending on the tab type.
Anchor tagging
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.Fixed positioning
Configuring the data transform
Step Property Description 2.1 .pyDeliveryMethod Change the sample value to
"Email" 2.2 .pyRecipientId 2.3 .pyRoutingOrder 2.4 .pyName Provide the full legal name of the recipient. 2.5 .pyEmail Provide the email address of the recipient. Property Description .pyAnchorString .pyAnchorUnits .pyAnchorXOffset x
(horizontal)
axis with relation to the anchor..pyAnchorYOffset y
(vertical)
axis with relation to the anchor..pyAnchorIgnoreIfNotPresent Property Description .pyDocumentId Provide the ID of the document on which to place the
tab. .pyRecipientId Provide the ID of the recipient to associate with the
tab. .pyPageNumber Provide the page number on which to place the
tab. .pyXPosition Provide the horizontal offset (in points) to use in
combination with the .pyYPosition
property value to determine the tab placement on a
page. .pyYPosition Provide the vertical offset (in points) to use in
combination with the .pyXPosition
property value to determine the tab placement on a
page. .pyName .pyTabLabel Provide the tab display name. .pyHeight Provide the height of the tab in points. .pyWidth Provide the width of the tab in points. .pyValue .pySelect .pyShared Step Property Description 4.1 .pyName Provide the full legal name of the
recipient. 4.2 .pyEmail Provide the email address of the
recipient. 4.3 .pyRecipientId 4.4 .pyRoutingOrder
Previous topic Configuring basic authentication details for DocuSign envelope requests Next topic Configuring advanced identity verification for envelope recipients