Close popover

Table of Contents

Configuring a signature request to DocuSign

Version:

You can make a signature request to DocuSign and create an envelope that sends multiple documents to multiple recipients.

  1. In the navigation pane of Dev Studio, click Case types.

  2. Click an existing case type to open it, or create a new case type. For more information, see Creating a top-level case type.

  3. On the Workflow tab, click Stage, and then enter a name in the field.

  4. Configure the DocuSign smart shape based on whether you want to authenticate requests from DocuSign with Basic authentication or OAuth 2.0 authentication.

    Before configuring OAuth 2.0 authentication in your case flow, download and install the DocuSign component, and then configure an OAuth 2.0 authentication profile. For more information, see Installing the DocuSign component and Configuring OAuth 2.0 authentication to authorize your DocuSign integration.
    Choices Actions
    Basic authentication
    1. In the Process section, click Step More Automations Send via DocuSign .

    2. Click Select.

    OAuth 2.0 authentication
    1. In the Process section, click Step More Automations Send via DocuSign V2 .

    2. Click Select.

    The DocuSign component overrides the Pega-provided pyExtendedAPIs navigation rule to include an entry for the Send via DocuSign V2 smart shape. If you already overrode the pyExtendedAPIs rule in your application, copy the Send via DocuSign V2 smart shape entry from the PegaDocuSignIntegration component ruleset into your application version of the pyExtendedAPIs rule. This ensures that the smart shape is visible at run time. For more information, see Navigation form - Completing the Editor tab.
  5. Optional:

    Configure the smart shape to reference the top-level page name that is populated in the pyPrepareNewEnvelope data transform.

    1. In the Step pane, in the Envelope field, enter pyPrepareNewEnvelope.

    2. Click Save.

      By default, the system sends the documents that are currently attached to your case to DocuSign for signature collection.

      If you do not enter a value in the Envelope field, the pxSendViaDocuSign activity creates a page with a default name.
  6. Optional:

    Customize your signature request.

    • Override the pyPrepareNewEnvelope data transform to prepare the envelope for making the signature request to DocuSign. For more information, see Preparing a DocuSign envelope.
    • Review the pySetEnvelopeCredentials data transform that is referenced in the pyPrepareNewEnvelope data transform. This data transform sets the DocuSign account credentials (account ID, user name, password, and integration key).
    • Override the pyAssignRecipientsToEnvelope data transform that is referenced in the pyPrepareNewEnvelope data transform. For more information, see Defining the recipients for your DocuSign documents.

    Ensure that all three data transforms are specialized into your application ruleset.

The following issues can prevent the REST connector from sending your request to DocuSign:

  • The top-level inbound page is not found or created.
  • Some of the email recipients are not valid.
  • The status for the envelope is not valid. "Created" and "Sent" are the only valid statuses.
  • Documents are not in binary format.
  • Document IDs are not valid.
  • File extensions of documents are not valid.
  • Recipient IDs are not valid.
  • The mapping of document IDs to recipient IDs when using the Sign Here or Date tabs in DocuSign is not valid.

If you experience issues while getting DocuSign to send your request, you can troubleshoot your request by inspecting the DocuSign response messages on the Pega Platform clipboard.

Suggest Edit

Have a question? Get answers now.

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