Documentation

Enabling DocuSign Digital Signatures

Available: Liferay Portal 7.4 GA3+

You can now integrate DocuSign digital signatures into your Liferay documents. DocuSign is a service that manages documents to be signed electronically. With this integration, you can manage and collect signatures on your documents.

Before you enable digital signatures in Liferay, make sure you’ve generated and retrieved your User ID key, API Account key, Account Base URI, Integration key, and RSA Private key. Instructions for doing this can be found on DocuSign’s website.

Enabling Digital Signatures

  1. Open the Global menu in the top right corner. Global Menu

  2. Click Control PanelInstance SettingsDigital Signature.

    The Digital Signature link appears in either Instance Settings or Site Settings.

  3. Switch the toggle to Enabled.

    Switch the toggle.

  4. Choose a Site Settings Strategy (see below).

    Your Site Settings Strategy defines the scope of your digital signatures.

  5. Click Save.

You have three options for your Site settings strategy:

Always Inherit: All sites are linked to these settings.

Always Override: Every site must provide its own configuration.

Inherit or Override: Can be defined in both Instance Settings and Site Settings. If defined in both, Site settings take precedence over Instance settings.

You must now add your digital keys from DocuSign at the appropriate scope in Liferay.

Adding Digital Keys

Depending on what you chose for your Site Settings strategy, add your digital keys at the appropriate scope:

  • If you chose Always Inherit, add the keys in Instance Settings.

  • If you chose Always Override, add the keys in Site Settings.

  • If you chose Inherit or Override, add the keys in either place

  1. Navigate to Control PanelInstance SettingsDigital Signature or for Site Settings, the Site MenuConfigurationSite SettingsDigital Signature.

  2. If it’s not switched already, switch the toggle to Enabled.

  3. Enter the User ID, API Account ID, Account’s Base URI, Integration Key, and the RSA Private Key you previously retrieved from the DocuSign website.

  4. Click Save to enable digital signatures.

Collecting Document Signatures in Documents and Media

  1. Find the document where you want to collect the digital signatures and click ActionsCollect Digital Signature.

    You can see the Actions and Collect Digital Signatures buttons.

  2. For multiple documents, select the documents where you want to collect the signatures and click Collect Digital Signature (Collect Digital Signature).

    You can see multiple selected files and the Collect Digital Signature button.

  3. Fill in the Envelope’s information and click Send.

    Fill in the envelope's information.

  4. When the envelope is sent, Recipients must go through DocuSign’s process to sign the document.

Tracking an Envelope’s Status

DocuSign uses the term envelope to denote a document or collection of documents to be signed. Once sent, you can track your envelope status from within Liferay.

Tip

You can check the different status labels on the DocuSign website.

  1. Open the Site Menu (Site Menu) → Content & DataDigital Signature to see a list of created envelopes.

  2. You can also create an envelope directly from this screen using the Add Button. You’re shown the envelope’s screen to enter its information.

  3. Use Filter and Order or type keywords in the Search bar to filter and sort the list of available envelopes.

    Organize documents through Filter and Order, or the Search Bar.

Downloading Documents

  1. Click the envelope’s name to see its details. You can download the document by clicking the Download button or by clicking the Actions Button Actions Button from the Digital Signature screen.

    Important

    Clicking Download fetches the document from DocuSign not from Liferay, since Liferay does not store signed documents. Whether a document is partially or fully signed, the download button retrieves the latest state.

    You can view the details of your envelopes from inside Liferay.

Warning

Disabling the Digital Signature Configuration removes all reference to DocuSign, including the Digital Signature module in the Control Panel. If you disable the feature in Liferay, all envelopes are still visible in DocuSign. If you re-enable digital signatures, the list appears again.

Additional Information