DocuSign eSignature Integration

Overview

Streamline sales processes using integration with DocuSign eSignature. This native integration, with eSignature vendor DocuSign, eliminates the pass-through step, facilitates the interaction between both applications, and always provides the most up-to-date output from the Oracle CPQ interface.

DocuSign eSignature Integration features include:

DocuSign eSignature

DocuSign Connect Message Formats

DocuSign sends a message to Oracle CPQ to notify when a workflow event is triggered, such as when an eSignature envelope is signed or declined by a recipient. DocuSign Connect is the webhook service Oracle CPQ uses to receive these event messages. DocuSign Connect event messages can be formatted as JSON or XML. This is configured from the DocuSign configuration page. Refer to Configure DocuSign Properties.

Oracle CPQ 24D and later supports JSON DocuSign Connect messages, including both JSON SIM and Aggregate modes. When a DocuSign Connect message is sent, it is parsed based on the content type header, JSON or XML, and validated using DocuSign HMAC security protocol. The Oracle CPQ DocuSign integration requires a DocuSign-generated secure Connect Key in order to authenticate JSON event messages.

When setting up the Oracle CPQ DocuSign Integration, the message format field requirements are as follows:

The DocuSign connect key expires three years from the Last Modified date. Oracle CPQ sends the administrator weekly email notification reminders starting 4 weeks ahead of the connect key expiration date. If the connect key expires, the DocuSign envelope status will stop working.
OAuth 2.0 Support for DocuSign Integration

The DocuSign eSignature integration allows the CPQ application to prepare documents, assign signers, and create envelopes in DocuSign. When a sales agent sends a document out for signature the CPQ application makes a web service call to DocuSign. In 24B and later, Oracle CPQ replaces the previous authentication mechanism with a new OAuth-based flow to authenticate the web service call which creates the envelope in DocuSign. To support this new security mechanism, we have updated the DocuSign eSignature Connector in the Integration Center to allow administrators to manage the new connection details, the certificate, and the token key.

When upgrading to Oracle CPQ 24B and later, existing DocuSign eSignature integrations are supported and continue to function using their existing connection information.We recommend moving to the new OAuth-based flow promptly as the legacy authentication mechanism is deprecated by DocuSign and is no longer supported. Once you have upgraded to 24B existing connections using the old pattern will no longer be able to be modified. You must delete the old integration and recreate the connection using the updated Connector.

Administration

ClosedConfigure DocuSign Properties

In order for the Receive action to run properly when a document status changes in DocuSign, the following DocuSign should be configured by following the steps below:

  1. Login to DocuSign.

  2. Navigate to the Integration section within the Settings tab

  3. Select Connect from the Integration section. The Connect page displays.

  4. Within the Configuration tab, click Add Configuration to create a custom configuration.

  5. Select Active Connection from the Status field of the Listener Settings.

  6. Enter the name for the configuration in the Name field.

  7. Enter the Oracle CPQ hostname you are integrating with in the URL to Publish field, as follows:

    https://<cpqhost>/notification/receiver

  8. Select the Enable Log and Require Acknowledgement checkboxes.

  9. Under Event Settings, one of the following for Data Format:

    • REST v2.1 for JSON message format. Proceed to Step 10.

    • Legacy for XML message format. Skip to Step 11.

  1. For JSON message format, perform the following to complete the DocuSign configuration:

    1. Under Event Message Delivery Mode, select one of the following based on your business needs:
      • Send Individual Message (SIM)

      • Aggregate Message

    2. Under Trigger Events,expand the Envelopes & Recipients section and select the following:
      • Envelope Signed/Completed

      • Envelope Declined

      • Envelop Voided

    3. Expand the Include Data section of Envelopes & Recipients and select the following:

      • Document PDFs

      • Document Fields

    4. Select the Include HMAC Signature (Recommended) option under Integration and Security Settings section.

    5. Select Manage Keys to go to the Connect Key tab to create a secret key.

    6. Within the Connect Key section, click Add Secret Key. This will create a secret key.

    7. Copy the secret key value using the copy icon.

    8. Paste the secret key value into the Connect Key field in the Oracle CPQ DocuSign Integration Center page.

    9. Click Add Configuration to save the JSON message format DocuSign properties.

      You can learn more about HMAC Security with DocuSign Connect implementation and best practices from the DocuSign Developer Center. Oracle CPQ recommends rotating secret keys at a reasonable frequency as per your company-defined security policy.
  2. For XML message format, perform the following to complete the DocuSign configuration:

    1. Under Trigger Events,expand the Envelopes & Recipients section and select the following:
      • Envelope Signed/Completed

      • Envelope Declined

      • Envelop Voided

    2. Expand the Include Data section of Envelopes & Recipients and select the following:

      • Document PDFs

      • Document Fields

    3. Select Use SOAP Interface (SOAP Method: DocuSignConnectUpdate).

    4. Enter the SOAP Namespace that will be used in the notification requests to your server. Ensure a full path namespace is specified instead of the default property envelope.

    5. Select Include XML Digital Signature in SOAP Header so that SOAP XML messages will be digitally signed.

    6. Click Add Configuration to save the XML message format DocuSign properties.

If these settings are not set, administrators may see the following error message in the error log:

Failed to generate response to notification.

org.apache.axiom.soap.SOAPProcessingException: First Element must contain the local name, Envelop, but found DocuSignEnvelopeInformation


ClosedSet Up a DocuSign Integration

Setting up DocuSign integration requires the following tasks:

ClosedStep 1: Enabling DocuSign eSignature Integration

ClosedOAuth 2.0 Support for DocuSign Integration (Oracle CPQ 24B and later)

To create a DocuSign eSignature integration type, administrators with permissions can complete the following steps:

  1. Click Integration Center in the Integration Platform section of the Admin Home page.

  2. Click Create Integration.

  3. Select eSignature from the Type drop-down.

  4. Select DocuSign from the Vendor drop-down. The DocuSign Integration field entries display.

    Create DocuSign Integration from Oracle CPQ Integration Center

  5. Enter the Admin User ID. Refer to Retrieve DocuSign Field Values for retrieving this information.

  6. Enter the Account ID. Refer to Retrieve DocuSign Field Values for retrieving this information.

  7. Enter https://account.docusign.com for the OAuth URL.

  8. Enter the Endpoint URL. This includes the DocuSign Account Base URI with the restapi version information appended (for example, https://prodsite.docusign.net/restapi/v2). Refer to Retrieve DocuSign Field Values for retrieving this information.

    This URL must be included in the allow list of approved domains.
  9. Enter the Connect Key if your DocuSign Connect is configured to send JSON formatted messages to Oracle CPQ. This the key used to authenticate the DocuSign Connect message and is generated from DocuSign and provided to Oracle CPQ. The connect key is validated with DocuSign event notification headers. Refer to Retrieve DocuSign Field Values for retrieving this information.

    When the DocuSign eSignature integration is saved,the connect key is stored and the Last Modified date associated with the connect key is automatically populated.
  10. Upload the Connect Certificate if your DocuSign Connect is configured to send XML formatted messages to Oracle CPQ. To add the connect certificate, click Choose File and navigate to a valid certificate (for example, a.crt file) on your hard drive. This certificate must be the same as the one created in the DocuSign environment.

    • It is essential that the certificate in DocuSign and Oracle CPQ match.
    • When the DocuSign eSignature integration is saved, the certificate is stored and available for download. Also the Last Modified date associated with the certificate is automatically populated.
  11. Click Save to save the integration details along with the connection certificate.

  12. Select Generate to generate the Admin Token. If this is the first time you are setting up the OAuth-based integration, DocuSign consent must be verified. A warning displays indicating that consent from DocuSign is required.

    DocuSign Consent Warning

  13. Click Give Consent to close the Consent warning box. If required, you may need to log in to DocuSign.

    DocuSign Allow Access

  14. Click Allow Access to allow Oracle CPQ access. A consent confirmation message displays.

    DocuSign Consent Confirmation

  15. Navigate to the Oracle CPQ DocuSign eSignature Integration Center page and click Generate.

    DocuSign Integration Connected - Generate Token

    The Oracle CPQ DocuSign eSignature Integration Center page displays the Revoke button for the Admin Token instead of a Generate button. This indicates the access was granted and the integration connection is established.

Retrieve DocuSign Field Values

To set up the Oracle CPQ DocuSign eSignature Integration, the administrator must retrieve necessary field data from DocuSign. The following provides an overview of the steps to locate the DocuSign fields and the corresponding DocuSign to Oracle CPQ field names.

1. Log into DocuSign.

2. Navigate to the Integration section within the Settings tab.

3. Click Apps and Keys from within the Integration section. The Apps and Keys page displays.

4. Within the My Account Information section, note the following field values. These values must be entered in the corresponding field for the Oracle CPQ DocuSign eSignature Integration.

DocuSign App and Key Field

Oracle CPQ DocuSign Integration Field

User ID

Admin User ID

API Account ID

Account ID

Account Base URI

Endpoint URL

Enter the Account Base URI with the restapi version information appended (for example, https://prodsite.docusign.net/restapi/v2)

  1. Click Connect from the Integration section. The Connect page displays.

  2. Within the Connect Key section, click Add Secret Key. This will create a secret key.

  3. Copy the secret key value using the copy icon.

  4. Paste the secret key value into the Connect Key field in the Oracle CPQ DocuSign Integration Center page.

  5. Click Save to save the secret key.


ClosedLegacy Support for DocuSign Integration (Oracle CPQ 24A and earlier)

ClosedStep 2: Creating the eSignature Attribute Set, Action Set, and Layout Element


ClosedStep 3: Obtaining the DocuSign Authentication Token


ClosedStep 4: Adding Signer Tags to a Document

Add a Signature Tag

  1. Click Admin to go to the Admin Home Page.
  2. Click Document Designer (or Documents, for the Document Engine) under Commerce and Documents.
  3. Open an existing document, or create a new one.
  4. Select a location in the document for signature tags.

    In Document Designer, you may need to add a Text Element first.
  5. Create a signature tag by typing \s1, where "1" is the number of the signer.

    Signature tag

    When a signature is requested, DocuSign interprets \s1 as the location where signer #1 must sign.


ClosedRequesting Signatures for a Document

ClosedRequesting Signatures for a Document - Parallel only (19B or earlier)

ClosedRequesting Signatures for a Document - Sequential or Parallel Requests (19C and later)

ClosedUsing eSignature on Mobile Devices

ClosedUse BML to Reset eSignature Attributes

You can reset eSignature attribute values like attachments, recipients, status, etc. through BML implementation. For example, if a Transaction is versioned using Version action, the associated Modify action can implement the BML to reset the eSignature attributes values for the new Version. The following provides sample BML for resetting eSignature attributes.

Reset signatures BML sample

Modifying eSignature attribute values outside of the standard flow may cause integration issues if the attribute values are not setup properly. Please verify the changes and test the integration to make sure it is functioning as expected.


Notes

Notes:

  • eSignature attributes are listed in the order that they were created, and cannot be reordered on the grid.
  • Displayed rows can be controlled based on Permissions.
  • Each user must specify their account information when generating their authentication token.
    Refer to Step 3: Obtaining the DocuSign Authentication Token.

    Oracle CPQ associates a user to their default DocuSign account when that user generates an Authentication Token.

    The Login provided during Token generation is case-sensitive and must match the format of the DocuSign login exactly.
    If the logins don't match the integration will fail after the customer signs. For example, if the user's DocuSign login is "FirstName.LastName@domain", but the login used to generate the token is "firstname.lastname@domain", the integration will fail.

  • If your DocuSign certificate expires, the status for a CPQ transaction will not get updated when the associated document is signed and marked as complete in DocuSign. If this occurs, you need to regenerate your DocuSign certificate recreate your eSignature integration, refer to Step 1: Enabling DocuSign eSignature Integration.

  • The user sets their default account in DocuSign.

  • The symbols “<” and “>” are used as delimiters for recipients. For example, Name<Name@oracle.com>.
  • eSignature functionality allows for unlimited eSignature Attribute sets.
  • For more information on DocuSign, visit the DocuSign web site.

Related Topics

Related Topics Link IconSee Also