docusign for sharepoint on-prem · pdf file221mainstreet,suite1000,sanfrancisco,ca94105ι...
TRANSCRIPT
221Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι ©DocuSign, Inc.
DocuSign for SharePoint On-Prem — v3.1
Published: July 18, 2017
Overview
DocuSign for SharePoint allows users to sign or get signatures from any SharePoint document
library. This guide provides information on installing, sending, and signing documents from
SharePoint.
Important! This guide applies only to SharePoint on premise installations. It cannot be used for
SharePoint Online.
Note: The DocuSign for SharePoint application is only available for Microsoft SharePoint 2013 and
Microsoft SharePoint 2016, and can only be installed by SharePoint administrators. If you already
have a DocuSign account, the user credentials specifiedmust have sending enabled andmust
have send on behalf of rights enabled. See theDocuSign administrator email address setting
description for additional information.
What's New 3
Install DocuSign for SharePoint 5
DocuSign for SharePoint Settings 11
Send Documents using DocuSign for SharePoint 23
Check the Status of Sent Documents 25
Sign Documents with DocuSign for SharePoint 26
Quick Start Guide
SharePoint Designer Workflow Actions 28
FAQ 43
For More Information or Assistance 50
Release Notes 51
221Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι ©DocuSign, Inc.
DocuSign for SharePoint On-Prem
What's New
This section describes the new features and fixes included as part of the current release.
See Release Notes for features and fixes for previous releases.
New Features
l Multiple DocuSign accounts - Starting with v3.1, SharePoint On-Prem supports multiple
DocuSign accounts. Companies can now have three levels of administrative granularity
where each level is tied to a different DocuSign account. This accommodates use cases
where, for example, different business units or geographic locations need to be
administered separately. The three levels are:
o Central Administration defined for the entire farm (required)
o Site Collection
o Document Library
l Bulk Send envelopes - When preparing an envelope to be sent, you can upload a CSV
list of recipients and each person on the list will receive an identical envelope.
l New workflow action - A new workflow action extracts field values from completed
envelopes.
l Workflows now support proxy settings.
Bug Fixes
l Only one file is downloaded when checking the status of a signed document.
l SharePoint users are no longer mapped to DocuSign users; matching is done on-the-fly
when a user initiates an action (send, sign, or go to DocuSign). Related changes are:
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
3
DocuSign for SharePoint On-Prem
o Remove hidden user list and logic
o Remove users persisted object
o Remove Update button from Central Administration page
o Remove Show Users button from Document Library settings page
l The Secure Store App is created when you set the administrator credentials on the Cen-
tral Administration page
l Documents are downloaded to a custom location set to a sub-site's document library
l The Account ID is always shown on the Central Administration page
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
4
DocuSign for SharePoint On-Prem
Install DocuSign for SharePoint
Before installing DocuSign for SharePoint, be sure to follow the guidelines and
requirements listed here.
Installation Guidelines and Requirements
l During the deployment, the SharePoint farm is unavailable to users. We recommend
deploying during non-business hours.
Important!DocuSign for SharePoint uses the Secure Store Service. The Secure Store
Servicemust be configured and running when installing DocuSign for SharePoint. If the
Secure Store Application is not started and configured, the appmay appear to be
installed but it will not work. See the Microsoft TechNet articleConfigure the Secure
Store Service in SharePoint for detailed information on configuring and starting the
service.
Note:DocuSign for SharePoint does not support SharePoint 2013 Foundation or
SharePoint 2016 Foundation because the Secure Store Service is not included.
l DocuSign for SharePoint requires .NET 4.5 or higher.
l DocuSign for SharePoint does not support a hybrid configuration in which the
customer does not host and administer the SharePoint farm.
l DocuSign for SharePoint only installs if there is at least one site to activate.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
5
DocuSign for SharePoint On-Prem
DocuSign for SharePoint Installation
As an administrator or site collection owner, follow these steps to install DocuSign for
SharePoint:
1. Make sure you have configured and started the Secure Store Service, including
creating a new encryption key if this is the first time you're using the Secure Store
Service. See the Microsoft TechNet article Configure the Secure Store Service in
SharePoint for information on configuring and starting the service.
2. Extract the installation files to a folder on your SharePoint server.
3. Open the folder and double-click the file DocuSignForSharePoint2013.Installer.exe
(the file name is the same for both SharePoint 2013 and SharePoint 2016).
This starts the DocuSign for SharePoint install wizard.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
6
DocuSign for SharePoint On-Prem
4. Follow the steps outlined in the Install Wizard:
a. Choose your deployment option – you can either install the application, update a
current installation of DocuSign for SharePoint, or uninstall DocuSign for
SharePoint. In this case, you are installing the solution, so choose Install to
SharePoint sites.
b. Type a regular expression to retrieve the desired sites from your SharePoint farm.
For example, if you are looking for a site that contains the URL test, type /test into the
regular expression URL text box.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
7
DocuSign for SharePoint On-Prem
Move the sites you want to install DocuSign for SharePoint on from the list on the
left to the list on the right.
c. Set the DocuSign environment, either DEMO or Production, you want to use. This
will be the environment setting for all of the site collections selected in the previous
step.
d. Type your DocuSign email and password to configure your DocuSign account on
behalf of all your SharePoint users.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
8
DocuSign for SharePoint On-Prem
Your DocuSign account must have Account Wide Rights andSend on Behalf of
enabled.
e. If you need to connect to a proxy server, include the proxy settings. If not, click Next
to skip this step.
f. Review your settings on the confirmation screen, and then click Process.
Note: You can find information about the different settings in the FAQ.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
9
DocuSign for SharePoint On-Prem
g. A screen displaying all the sites the DocuSign for SharePoint solution was installed
on appears.
5. The DocuSign actions are now visible under the DocuSign tab for all document
libraries in the selected site collections.
Important! There must be direct connectivity to the Internet from the SharePoint
servers where the solution is installed.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
10
DocuSign for SharePoint On-Prem
DocuSign for SharePoint Settings
This section provides information about general account, site collection, and document
library settings for DocuSign for SharePoint.
DocuSign General Settings
This section provides information about the account settings for DocuSign for SharePoint.
Only Secure Store Service administrators can view and change these settings.
To access the DocuSign settings, go to the SharePoint Central Administration settings and
look for the DocuSign Connector. In the connector menu, select DocuSign Connector
Settings to go to the DocuSign General Settings screen. These settings apply to the entire
SharePoint farm. See DocuSign Document Library Settings for more information about
document library settings.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
11
DocuSign for SharePoint On-Prem
DocuSign Account Settings
The account setting options are:
Environment: This sets which DocuSign environment your DocuSign for SharePoint
installation is using. This can allow testing or demonstrations of the installation before
going live on the DocuSign production environment.
To change the setting, click EDIT on the same line as Environment and select the
DocuSign environment you want to use. Changing the environment removes the system-
wide login. Click SAVE to save the change.
Proxy server: This sets the proxy server information for your account.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
12
DocuSign for SharePoint On-Prem
To configure your proxy server settings, click EDIT on the same line as Proxy server. In the
dialog box, type the Proxy URL (the URL format is validated as it is added). The Proxy User
Name and Proxy Password are not required to save the information. If a value is entered for
either Proxy User Name or Proxy Password, however, then all fields must be completed.
After adding the proxy server information, click SAVE. Setting proxy server information
also applies to workflow actions.
DocuSign User Provisioning: This sets the automatic user provisioning option for your
account. When a SharePoint user tries to use DocuSign for SharePoint, we check to see
whether that user exists in DocuSign (in this case a user is defined by their email address)
and then take action based on your provisioning setting. There are two user provisioning
options: Enabled and Disabled.
If Enabled is selected, the possible results of the user check are:
1. If the user does not exist as a member of any DocuSign account, DocuSign creates a
new user with the user’s user name and email combination, and adds them as a
member of the current DocuSign account. DocuSign sends the user an activation email
with a link that they must click before they can use this connector. They do not,
however, have to add a password and do not need to know the password for the
account.
Note:Depending on the information in a user’s SharePoint profile and settings,
DocuSign might display a provisioning dialog box asking the user to enter information for
provisioning their account.
2. If the user exists in the DocuSign system and exists as a member of the current
DocuSign account, DocuSign uses that user information to send the document.
3. If the user exists in the DocuSign system, but does not exist as a member of the current
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
13
DocuSign for SharePoint On-Prem
DocuSign account, the DocuSign provisioning dialog box appears. The user must
enter a unique user name and email address combination that is different from the one
they already have in the DocuSign system.
If Disabled is selected, the possible results of the user check are:
1. If the user is a member of the current DocuSign account, there is no change to the
current behavior. DocuSign uses the existing user information to send the document.
2. If the user is not a member of your DocuSign account, DocuSign does not create a new
user or send the document.
In this case, the user sees the following message: "You do not have a DocuSign
membership with this account. Please contact your administrator."
To change your DocuSign User Provisioning setting, click EDIT on the same line as
DocuSign User Provisioning. This brings up a dialog box where you can select the user
provisioning option. After changing the setting, click SAVE.
DocuSign administrator email address: This sets the DocuSign user credentials
associated with the SharePoint installation. The credentials allow other users in the
account to get signatures or sign with DocuSign. DocuSign recommends that you set up a
dedicated system account user for this purpose, and that you do not use the credentials
for an actual user that might leave your organization.
The user credentials specified must have sending enabled and must have send on behalf of
rights enabled.
l If you are viewing the credentials in the Classic DocuSign Experience administration,
the user's Permissions must have the Send Envelopes, Account-Wide Rights, and Send
On Behalf Of Rights (API) settings enabled.
l If you are viewing the credentials in the New DocuSign Experience Admin, the user must
be assigned to a Permission Set with the Can send envelope, Allow view and manage
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
14
DocuSign for SharePoint On-Prem
envelope rights through API, and Allow send on behalf of other users through API set-
tings enabled.
To change the administrator credentials, click RESET, and then enter the credential
information.
DocuSign Status Update - Timer Job
This is a timer job that automatically updates document statuses, and then downloads
completed documents (those where signing is complete) every 5 minutes. You can
configure the default 5 minute interval setting.
Configure the time interval in Central Administration → Monitoring → Review job
definitions → DocuSign Status Update Job.
You can execute this job (for testing purposes) by clicking Run Now.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
15
DocuSign for SharePoint On-Prem
DocuSign Site Collection Settings
This section provides information about site collection settings for DocuSign for
SharePoint.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
16
DocuSign for SharePoint On-Prem
To access these settings, go to Site Collection Settings, and then, under Site Collection
Administration, click DocuSign Site Administration Settings.
To set Site Collection Administration Account Settings, the following requirements must be
met:
l Site Collection Administration or Farm Admin privileges are required
l Site Collection Administrators must have permission to write to the Secure Store. You
can do this in either of the following ways:o Set up Site Collection Administrators as Secure Store Administrators
o Add the SharePoint Application user (IIS) to the Secure Store Service Administrators
DocuSign administrator email address: This sets the DocuSign user credentials
associated with the Site Collection, overriding the settings set in Central Administration.
The credentials allow other users in the account to get signatures or sign with DocuSign.
The user credentials specified must have sending enabled and must have send-on-behalf-
of rights enabled.
l If you are viewing the credentials in the New DocuSign Experience Admin, the user must
be assigned to a Permission Set with the Can send envelope, Allow view and manage
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
17
DocuSign for SharePoint On-Prem
envelope rights through API, and Allow send on behalf of other users through API set-
tings enabled.
l If you are viewing the credentials in the Classic DocuSign Experience administration,
the user's permissions must have the Send Envelopes, Account-Wide Rights, and Send
On Behalf Of Rights (API) settings enabled.
To change the administrator credentials, click RESET, and then enter the credential
information.
To remove the administrator, click CLEAR. When cleared, the DocuSign account for this
site collection administrator is the one set in Central Admin.
DocuSign Document Library Settings
Important! If you create a site after you install DocuSign for SharePoint On-Prem, you won't
see the DocuSign Connector option. In which case, you can enable the feature under the
Site Collection Features, after which you can see the DocuSign connector option under a
document library.
This section provides information about the document library settings for DocuSign for
SharePoint. Only administrators can view and change these settings. These settings apply
only to this document library. See DocuSign General Settings information for more about
account settings.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
18
DocuSign for SharePoint On-Prem
To access the settings from a library, click the Library tab, click Library Settings, and then
click DocuSign Connector. This takes you to the DocuSign Connector screen. After
making any changes in this section, click SAVE to save the changes.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
19
DocuSign for SharePoint On-Prem
The document library options are:
DocuSign Account Settings: This sets the DocuSign user credentials associated with the
Document Library, overriding the settings set in Central Administration and Site Collection.
The credentials allow other users in the account to get signatures or sign with DocuSign.
The user credentials specified must have sending enabled and must have send-on-behalf-
of rights enabled.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
20
DocuSign for SharePoint On-Prem
l If you are viewing the credentials in the New DocuSign Experience Admin, the user must
be assigned to a Permission Set with the Can send envelope, Allow view and manage
envelope rights through API, and Allow send on behalf of other users through API set-
tings enabled.
l If you are viewing the credentials in the Classic DocuSign Experience administration,
the user's permissions must have the Send Envelopes, Account-Wide Rights, and Send
On Behalf Of Rights (API) settings enabled.
To change the administrator credentials, click RESET, and then enter the credential
information.
To remove the administrator, click CLEAR. When cleared, the DocuSign account for this
site collection administrator is the one set in Central Admin.
Activate DocuSign Connector: This activates DocuSign for SharePoint for this document
library and shows the DocuSign ribbon in the library.
Certificate of Completion: This sets whether a Certificate of Completion is attached to
signed documents. A Certificate of Completion is a document associated with every
DocuSign envelope that provides proof of the signing process to all parties in the
transaction. The certificate establishes who, what, when, and how documents were signed.
There are two options for downloading the Certificate of Completion:
l A separate file, which is supported for SBS digital signatures when a single document is
signed
l Combined into one document, which is not supported for SBS digital signatures when
more than one document is signed
Completed DocuSign Documents: This sets where completed documents are stored. The
Completed DocuSign Document storage options are:
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
21
DocuSign for SharePoint On-Prem
l Store in a dedicated folder in the originating document library: Selecting this option
stores completed documents in a dedicated DocuSign documents folder in the
document library from which the DocuSign action was initiated.
l Store as a new document in the originating document library: Selecting this option
stores completed documents as a new document in the same document library from
which the DocuSign action was initiated.
l Store in a custom site or folder: Selecting this option stores completed documents as a
document in a different site (within the same site collection), document library, or folder.
You must enter the full URL for the site or folder in the field below the option. This action
is only available for SharePoint administrators.
Signed Document Naming Convention: This sets the naming convention used for
completed documents when they are saved. It can include a timestamp, the recipient names
and a timestamp, or sender names and a timestamp.
Signed Document Version Settings: This sets whether a signed document is saved as a
new file or as a new version of the original document. Storing as a new version is only
available if the original document was a PDF file. If the original document was not a PDF
file, a new file is saved.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
22
DocuSign for SharePoint On-Prem
Send Documents using DocuSign for SharePoint
With DocuSign for SharePoint, you can send documents for signature directly from the
ribbon bar in a SharePoint document library. You can select recipients one at a time or you
can upload a file with up to 1000 recipients and send each person their own copy of the
document to sign.
1. Go to a SharePoint library and select one or more documents.
2. On the ribbon, in the DocuSign tab, click Get Signatures.
Or, you can click the document menu, click …, and then select Get Signatures.
3. The DocuSign sending application opens within the SharePoint frame.
4. Select each recipient and add the fields they will see.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
23
DocuSign for SharePoint On-Prem
5. After you've added all the fields for each recipient, send your documents.
6. Done! You have successfully sent documents for signature using DocuSign.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
24
DocuSign for SharePoint On-Prem
Check the Status of Sent Documents
Follow these steps to check the status of sent documents:
1. Go to the SharePoint document library and select one or more documents. On the
document ribbon, in the DocuSign tab, click Check Status. This displays a list that
shows the statuses for the documents you have sent.
The possible values are: Draft, Waiting for Others, Completed, Declined, and Canceled.
DocuSign automatically updates documents and statuses every five minutes and
downloads the completed documents. You can also update the status of the documents
manually by clicking Update All at the top of the page.
2. For documents with a status of Completed, a PDF file with the signed document is
stored in a DocuSign folder within the originating document library or in the library or
folder designated by your SharePoint administrator. Click View Document to open the
PDF file or navigate to the appropriate folder to access the signed document.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
25
DocuSign for SharePoint On-Prem
Sign Documents with DocuSign for SharePoint
With DocuSign for SharePoint, you can sign documents in a SharePoint 2016 document
library directly from the ribbon bar. Follow these steps to sign documents:
1. Go to a SharePoint library and select one or more documents.
2. On the document ribbon, in the DocuSign tab, click Sign.
Or, you can click the document menu, then click …, and then select Sign with
DocuSign.
3. The free-form signing experience opens within the SharePoint frame.
4. Sign the document:
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
26
DocuSign for SharePoint On-Prem
l To add a signature, initial, or other information to the document, click the pen button
to show the fields palette.
l Click the field you want to place, and then drag and drop it at the appropriate
location in the document.
5. After you place all the fields in the document, click Finish to complete your document
signing.
6. Done! You have successfully signed the documents with DocuSign.
The signed document is saved as a PDF file in the DocuSign Documents sub-folder in
the originating document library or in the library or folder designated by your
SharePoint administrator.
Open the folder to access the signed PDF.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
27
DocuSign for SharePoint On-Prem
SharePoint Designer Workflow Actions
Send Document and Download Document are DocuSign-specific actions supported in
SharePoint Designer. Before you can use these actions, however, you must set up the
Secure Store Service to work with the actions. The first part of this section walks you
through that process; the second part shows you how to use the actions. You only need to
set up the SharePoint Secure Store Service once to enable workflow actions.
Important! These actions are available on the SharePoint 2010workflow platform and also
work in SharePoint 2013 and 2016.
Set Up the SharePoint Secure Store Service
The Secure Store Service maintains an encrypted database that maps the identities of
SharePoint users, groups, or process accounts to the external credentials required to
access external systems.
When the Business Data Catalog needs to impersonate external credentials to access a
data source, it passes the identity of the caller to the Secure Store Service.
The Secure Store Service then returns the external credentials that are mapped to the
identity of the caller.
Within the Secure Store Service, credential mappings are organized by target applications.
A target application represents an external system or data source, and includes a unique
target application ID.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
28
DocuSign for SharePoint On-Prem
When the Business Data Catalog requests a set of credentials from the Secure Store
Service, it specifies the target application ID so that the Secure Store Service knows which
credential mapping to retrieve.
To Configure the Secure Store Service
If this is the first time that you are using the Secure Store Service, you first need to
generate a new encryption key by clicking Generate New Key under the Edit tab on the
SharePoint ribbon.
Then select a pass phrase and click OK.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
29
DocuSign for SharePoint On-Prem
To Create a Target Application in the Secure Store Service
1. In the Central Administration Web site, click Application Management, and then click
Manage Service Applications.
2. On the Manage Service Applications page, click Secure Store Service.
3. On the ribbon, in the Manage Target Applications section, click New.
4. On right side of the Create New Secure Store Target Application page, do the following:
a. Set the Target Application ID to DocuSignWFActions.
b. Set the Display Name to DocuSign Workflow Actions.
c. Provide a contact e-mail address (for example, [email protected]).
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
30
DocuSign for SharePoint On-Prem
d. Under Target Application Type, select Group.
a. Click Next.
5. On the next page, set the credential fields names to Username and Password, set the cre-
dentials fields types to User Name and Password, and then click Next.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
31
DocuSign for SharePoint On-Prem
6. On the next page, in the Target Application Administrators text box, add your admin-
istrative account.
7. On the Secure Store Service page, in the DocuSignWFActions list, click Set Cre-
dentials.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
32
DocuSign for SharePoint On-Prem
8. On the Set Credentials for Secure Store Target Application page, set the Credential
Owner to the identity that runs the relevant SharePoint site application pool (for
example, Network Service), set the Username and Password to the DocuSign admin-
istrator account credentials, and then click OK.
DocuSign Document Actions
The next sections show you how to use the Send Document, Download Document, and Get
Field Value actions.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
33
DocuSign for SharePoint On-Prem
To Use the Send Document Action
The Send Document action supports templates (with or without custom tags), anchor tags,
and PDF form fields.
From the Action menu on the ribbon, under DocuSign, select Send Document.
Action
Send document to, with the following email subject (Output to Variable:Result,
Variable:EnvelopeID
Parameters
to: A text field for the recipient's email address
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
34
DocuSign for SharePoint On-Prem
email subject: A text field for the email subject
Result variable: Populated with the result returned by the DocuSign API
EnvelopeID: The unique envelope identifier assigned to this document by the
system
Properties
Environment: The following list of processing environments
l demo.docusign.net
l www.docusign.net
l na2.docusign.net
l eu.docusign.net
l eu1.docusign.net
AccountId: The DocuSign user account ID
SenderEmail: The email account used for send-on-behalf-of (SOBO)
RecipientName: (Optional) The email recipient's name
EmailMessage: (Optional) The body of the email that the recipient will receive
Template ID: (Optional) The unique ID of the template to be used to send the
document. Find more information about template IDs here.
Signer Role Name: Used only with templates containing placeholders. Finds
the correct signer placeholder and replaces it with the recipient data.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
35
DocuSign for SharePoint On-Prem
PDF Form fields: (Optional) Used only with PDF files. Options are:
l No: Do nothing. This is the default setting.
l Yes: Enabled in the API. Find more information about API for PDFs here.
Additional Information
Anchor tags (called AutoPlace in the New DocuSign Experience) are supported
in the Send Document action.
To Use the Download Document Action
The Download Document action returns final documents. Final documents have a status of
Completed, Declined, or Voided. No documents with any other status (sent, delivered,
correct, etc.) are returned. Documents with Declined status are returned with the reason
they were declined.
From the Action menu on the ribbon, under DocuSign, select Download Document.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
36
DocuSign for SharePoint On-Prem
Action
Download document with Envelope ID, (Output to Variable:Result,
Variable:Message)
Parameters
Envelop ID: The EnvelopeID returned by the Send Document action, or any
other valid envelope ID
Result variable: Populated with the result returned by the DocuSign API
Message variable: Populated with the reason the document was declined
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
37
DocuSign for SharePoint On-Prem
Properties
Environment: A list of processing environments
l demo.docusign.net
l www.docusign.net
l na2.docusign.net
l eu.docusign.net
l eu1.docusign.net
AccountId: The DocuSign user account ID
Overwrite current item: A flag designating whether to overwrite an existing
document of the same name
Destination URL: The location in which to store the returned document
Overwrite current item and Destination URL are closely coupled. Based on the
setting of these two parameters and the type of document sent, the following
behavior occurs:
l Destination URL is not specified (the document is returned to the library or
folder from which it was sent) and the document type is PDF.o Overwrite current item enabled - if a document with the same name as
the signed PDF exists, it is deleted and a new version of the document is
created in the library where the workflow is running
o Overwrite current item disabled - if a document with the same name as
the signed PDF exists, a new version of the document is created in the
library where the workflow is running
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
38
DocuSign for SharePoint On-Prem
l Destination URL is not specified (the document is returned to the library or
folder from which it was sent) and the original document type is not PDF, but
was converted to a PDF by DocuSign during the signing process.o Overwrite current item enabled - if a document with the same name as
the signed PDF exists, it is deleted and new document is written into the
library or folder from which it was sent
o Overwrite current item disabled - if a document with the same name as
the signed PDF exists, the new document is written into the document
library or folder from which it was sent with the same name plus a time
stamp
l Destination URL is specified (the document is returned to a specified library
or folder)o Overwrite current item enabled - if a document with the same name as
the signed PDF exists, it is deleted and new document is written into the
specified library or folder
o Overwrite current item disabled - if a document with the same name as
the signed PDF exists, the new document is written into the specified
library or folder with the same name plus a time stamp
Polling interval: (Optional) Defines how many minutes will pass before this
action polls the DocuSign API. If not specified, the default is 20 minutes. The
minimum value is 1 minute.
Lifetime: (Optional) Defines the number of days this action runs. If not set, the
action runs indefinitely.
Preserve Metadata: (Optional) Based on the value of Overwrite current item,
the following behavior occurs:
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
39
DocuSign for SharePoint On-Prem
l Yes: Applies only when Overwrite current item = No. When a document is
stored in the specified path, the relevant metadata associated with the ori-
ginal document is copied to the new item. System-generated fields such as
owner, creation time, etc. are ignored.
l No: No data from the original document is saved with the returned doc-
ument.
To Use the Get Field Values Action
The Get Field Values action extracts field values from completed documents.
From the Action menu on the ribbon, under DocuSign, select Get Field Value.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
40
DocuSign for SharePoint On-Prem
Action
Get field data for Envelope ID, user Recipient Name, with the field name (Output
to Variable:Field Value, Variable:Result, Variable:Message)
Parameters
Envelop ID: The EnvelopeID returned by the Send Document action, or any
other valid envelope ID.
RecipientName: Envelopes with multiple recipients can have multiple fields
with the same name. RecipientName defines which recipient’s field value is
returned.
Field Name: The value of this field is placed in an output variable.
Field Variable: The value of the field that was filled by a specific recipient.
Result variable: Populated with the result returned by the DocuSign API.
Message variable: Populated with information returned from DocuSign.
Properties
Environment: A list of processing environments
l demo.docusign.net
l www.docusign.net
l na2.docusign.net
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
41
DocuSign for SharePoint On-Prem
l eu.docusign.net
l eu1.docusign.net
Supported DocuSign Fields
The following table lists the DocuSign fields from which you can retrieve data
with the Get Field Values action.
Type Return value
Signature True or False (signed or not signed)
Date Date
Company Company
Title Title
Check Box True or False (selected or not selected)
Radio Buttons Value set for each button
Dropdown Selected value
Attachment True or False
Text Text
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
42
DocuSign for SharePoint On-Prem
FAQ
Note: If your question isn't covered by these FAQs, please check theDocuSign for
SharePoint Support Center page for additional support information.
What is the difference between "Get Signatures" and "Sign" with DocuSign?
l Get Signatures is used when you want to send a document, or documents, to one or
more people to gather signatures or information from those people. You, as the sender,
can also be a signer on documents, but you do not have to be. Sign with DocuSign is
used when you just want to sign something yourself that can be delivered to someone
else.
Using the Sign with DocuSign option only takes you to the signing page in DocuSign,
while the Get Signatures with DocuSign lets you address and add fields to the document
for sending.
If I am an admin of SharePoint and would like to upgrade to a paid DocuSign account,
what do I do?
l Contact our sales team at [email protected] or 1.877.720.2040.
I’m not the Administrator or Site Collection owner for my SharePoint account, can I still
install DocuSign for SharePoint?
l No, only the Administrator or Site Collection owner can install this application.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
43
DocuSign for SharePoint On-Prem
How do I change the DocuSign environment that my DocuSign for SharePoint
application is pointing to?
l To access the DocuSign settings, go to the SharePoint Central Administration settings
and look for the DocuSign Connector. In the connector menu, select DocuSign Con-
nector Settings to go to the DocuSign General Settings screen. Click Edit next to Envir-
onment. This brings up a dialog where you can select the DocuSign environment you
want to use. This action also removes the system-wide login. Click Save to save the
changes.
Do I have to give the other SharePoint users my DocuSign credential information so
they can send with DocuSign?
l No. If you created a new account, it is automatically set up to allow other users in your
account to get signatures or sign with DocuSign.
If you have an existing DocuSign account, DocuSign recommends that you set up a
dedicated system account user for this purpose, and that you do not use the credentials
for an actual user that might leave your organization.
The user credentials specified must have sending enabled and must have send on
behalf of rights enabled. If you are viewing the credentials in the Classic DocuSign
Experience administration, the user's Permissions must have the Send Envelopes,
Account-Wide Rights, and Send On Behalf Of Rights (API) settings enabled. If you are
viewing the credentials in the New DocuSign Experience Admin, the user must be
assigned to a Permission Set with the Can send envelope, Allow view and manage
envelope rights through API, and Allow send on behalf of other users through API
settings enabled.
Additionally, if your account uses the Password Strength setting Custom, you must set
the Password Questions Required option to 0.
Who can see the status of documents sent from a document library?
l Everyone with rights to the SharePoint document library can see the status of doc-
uments for that document library – regardless of whether the user is the sender or the
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
44
DocuSign for SharePoint On-Prem
recipient.
I have installed DocuSign for SharePoint, but I not sure of the activation status for all
my SharePoint sites. Is there an easy way to tell the status for my sites?
l In the extracted DocuSign for SharePoint solution, click
DocuSignForSharePoint2013.Installer.exe. In the Deployment Options step, select
Update current install of DocuSign for SharePoint. In the Site Selection section, you
will see the list of the active sites on the list on the right side of the screen.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
45
DocuSign for SharePoint On-Prem
I am using a proxy server. How do I configure my proxy server settings to use
DocuSign for SharePoint?
l To configure your proxy server settings, go to the SharePoint Central Administration
settings and look for the DocuSign Connector. In the connector menu, select DocuSign
Connector Settings to go to the DocuSign General Settings screen. Click EDIT on the
same line as Proxy server. In the dialog box, type the Proxy URL (the URL format is
validated as it is added). The Proxy User Name and Proxy Password are not required to
save the information. If a value is entered for either Proxy User Name or Proxy
Password, however, then all fields must be completed. After adding the proxy server
information, click SAVE.
Not all of my SharePoint users have DocuSign Accounts. Can they still use DocuSign
for SharePoint?
l Yes, as long as automatic user provisioning is enabled and you still have seats available
for your DocuSign account. When a SharePoint user clicks Get Signatures or Sign, we
check to see whether that user exists in DocuSign (in this case a user is defined by their
email address). There are three possible results:
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
46
DocuSign for SharePoint On-Prem
1. If the user does not exist as a member of any DocuSign account, DocuSign creates a
new user with the user’s user name and email combination, and adds them as a
member of the current DocuSign account. The user does not add a password and
does not need to know the password for the account.
Note:Depending on the information in a user’s SharePoint profile and settings,
DocuSign might display a provisioning dialog box asking the user to enter information
for provisioning their account.
2. If the user exists in the DocuSign system and exists as a member of the current
DocuSign account, DocuSign uses that user information to send the document.
3. If the user exists in the DocuSign system, but does not exist as a member of the cur-
rent DocuSign account, the DocuSign provisioning dialog box appears. The user
must enter a unique user name and email address combination that is different from
the one they already have in the DocuSign system.
When I try to sign a document I get the error message there was an error getting the
DocuSign account information. Error: There are no addresses available for this
application.” What should I do?
l Your Secure Store Service is not configured or is not running. See the Microsoft
TechNet article Configure the Secure Store Service in SharePoint for information on con-
figuring and starting the service.
How do I uninstall DocuSign for SharePoint?
l In the extracted DocuSign for SharePoint solution, click
DocuSignForSharePoint2013.Installer.exe in the folder. In the Deployment Options
step, select Uninstall DocuSign for SharePoint. Click Next, and then click Process on
the confirmation screen.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
47
DocuSign for SharePoint On-Prem
How do I update my install of DocuSign for SharePoint to the latest version of the app?
l In the newest download of the extracted DocuSign for SharePoint solution, open the
folder and click DocuSignForSharePoint2013.Installer.exe. In the Deployment Options
step, select Update current install of DocuSign for SharePoint. Click Next, and then
follow the steps in the installer. Your DocuSign credentials and DocuSign statuses will
remain intact in SharePoint.
How do I change the location in which signed documents are stored?
l To access the settings from a library, click the Library tab, click Library Settings, and
then click DocuSign Connector. This takes you to the DocuSign Connector screen.
Select the Completed DocuSign Document storage option for this document library. The
options are:
o Store in a dedicated folder in the originating document library: Selecting this
option stores completed documents in a dedicated DocuSign documents folder in the
document library from which the DocuSign action was initiated.
o Store as a new document in the originating document library: Selecting this option
stores completed documents as a new document in the same document library from
which the DocuSign action was initiated.
o Store in a custom site or folder: Selecting this option stores completed documents
as a document in a different site or folder. You must enter the full URL for the site or
folder in the field below the option. This action is only available for SharePoint
administrators.
After selecting your option, click SAVE to save the change.
How do I change the naming convention of signed documents?
l To access the settings from a library, click the Library tab, click Library Settings, and
then click DocuSign Connector. This takes you to the DocuSign Connector screen.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
48
DocuSign for SharePoint On-Prem
Select the Signed Document Naming Convention you want to use for this document
library.
What is user provisioning and how do I change the user provisioning setting for my
account?
l When a SharePoint user clicks Get Signatures or Sign, we check to see whether that
user exists in DocuSign (in this case a user is defined by their email address) and then
takes action based on your provisioning setting. There are two DocuSign user
provisioning options: Enabled and Disabled.
If you select Enabled, DocuSign follows the actions outlined in the automatic
provisioning FAQ.
If you select Disabled, the possible results of the user check are:
1. If the user is a member of the current DocuSign account, there is no change to the
current behavior. DocuSign uses the existing user information to send the
document.
2. If the user is not a member of your DocuSign account, DocuSign does not create a
new user or send the document.
In this case the user sees the following message: "You do not have a DocuSign
membership with this account. Please contact your administrator."
To change your DocuSign User Provisioning Setting:
Go to the SharePoint Central Administration settings and look for the DocuSign
Connector. In the connector menu, select DocuSign Connector Settings to go to the
DocuSign General Settings screen. Click the EDIT option adjacent to DocuSign User
Provisioning. This brings up a dialog where you can select the user provisioning
option. This action is only available for SharePoint administrators.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
49
DocuSign for SharePoint On-Prem
For More Information or Assistance
For more information or assistance, visit DocuSign Support Center, the DocuSign
Community, docusign.com, or contact DocuSign Support.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
50
DocuSign for SharePoint On-Prem
Release Notes
DocuSign for SharePoint v3.0
The following features or fixes were included as a part of DocuSign for SharePoint v3.0:
l Support for Send Document and Download Document workflowso The Send Document action supports templates (with or without custom tags), anchor
tags, and PDF form fields
o The Download Document action returns final Completed, Declined, or Voided doc-
uments
l Certificate of Completion optionso When you elect to have a Certificate of Completion created, you can select whether it
is appended to the completed PDF file or whether it is saved as a separate document,
l Improvement to the Status pageo By default, the status page shows only the documents that were sent from the current
document library. Previous behavior was to show all documents from all senders
over the entire site collection.
o The Status page paginates when there are more items than can be displayed on the
current page
l Download completed document background service
o This is a timer job that automatically updates document statuses and downloads com-
pleted documents (those where signing is complete) every 5 minutes. The default 5
minute interval setting is configurable.
l Users with read-only permissions can now send and sign documents without receiving
an error and without needing write permission to the status list.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
51
DocuSign for SharePoint On-Prem
l The storage location for a document is set at the time it is sent and honors the setting for
the document library from which it was sent. Previous behavior was to retrieve the set-
ting from the current document library, which may not be the library from which the doc-
ument was sent, and which might have a different storage setting.
l The Update All button pulls information only for the current user and the current doc-
ument library.
l DocuSign for SharePoint now supports record libraries. That is, in Record Center site
collections, the Record Library and Drop Off Library now have the DocuSign Ribbon in
the library and the DocuSign Connector settings link in Settings page.
DocuSign for SharePoint v2.4
The following features or fixes were included as a part of DocuSign for SharePoint v2.4:
l Improvements to the Status pageo The most recent envelopes appear at the top of the Status page
o Only documents sent by the current user appear
o Status page refresh time was increased to 10 minutes
o When an environment change occurs, the Status page updates appropriately
l With user provisioning is enabled, the first time new users who have not set up a
DocuSign account attempt to send a document, they are prompted to activate their
DocuSign account before they can proceed with sending the document
DocuSign for SharePoint v2.3
The following features were included as a part of DocuSign for SharePoint 2016 v2.3:
l Added a new central DocuSign Account Settings page to set farm-level account settings
and updated the document library settings page.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
52
DocuSign for SharePoint On-Prem
l Document Library settings now apply only on specific document libraries not to the
entire site collection.
l User matching between the DocuSign account and SharePoint users is now done using
email address only.
l Added the new RESET ALL button in the DocuSign General Settings page, which auto-
matically retrieves all user from your DocuSign account and generates mapping
between SharePoint and DocuSign users for the account.
221 Main Street, Suite 1000, San Francisco, CA 94105 Ι www.docusign.com Ι © DocuSign, Inc.
53