The first step in configuring the Integration for DocuSign module is to connect your DocuSign eSignature account to OnBase. This allows OnBase to establish a link to your DocuSign eSignature account when uploading and signing documents with DocuSign.
To connect DocuSign to OnBase, from the OnBase Configuration module:
- Navigate to the Document menu.
-
Select Hosted Signing | DocuSign.
Note:
This option is only available for users with the Document Configuration configuration right. See the System Administration documentation for information on modifying configuration rights.
-
The DocuSign Integration Configuration dialog box is displayed.Note:
If these credentials are already configured and you intend to change them, it is considered a best practice to ensure all envelopes uploaded to DocuSign using these credentials have been successfully returned. If you upload envelopes to DocuSign and subsequently change the login and/or account credentials, you cannot successfully return those envelopes until the original credentials used for uploading the envelopes have been reinstated.
-
Enter your DocuSign credentials into the fields (the first three fields are required):
Credential
Description
Login Email
The email address you use to log into DocuSign.
Note:The Login Email is limited to 254 characters.
Note:In order to allow users to view the status of DocuSign documents from OnBase, the user account connected to OnBase must have the Share envelopes with user action enabled within DocuSign. See your DocuSign documentation for information on configuring this action.
Login Password
The App Password generated by a DocuSign account administrator. Reference your DocuSign documentation for information on generating a DocuSign App Password.
Note:The character limit for the Login Password is dependent upon encryption. You are prompted if your password is too long.
Account ID
The API Account ID of your DocuSign account.
Note:The API Account ID is different than the account number.
Note:The Account ID is limited to 50 characters.
Override Service URL
Select to enter an override service URL. An override service URL is used to bypass the default URL used to connect to DocuSign (e.g., you can use it to switch to a demo environment instead of a production environment).
To obtain a DSAPIService URL for a demo environment that you can use as the override service URL, contact DocuSign.
CAUTION:You can only upload a document to DocuSign one time. When working within a demo environment, only upload documents you do not plan to upload when in a production environment.
Note:The Override Service URL is limited to 254 characters.
Enable Send on Behalf Of
Select to send DocuSign email notifications on behalf of the OnBase user uploading the envelope, instead of on behalf of the DocuSign administrator account. To have email updates sent on behalf of the user uploading the envelope, the user must:
-
Have an email address specified in User Settings. For more information on User Settings, see the System Administration module reference guide or help file.
-
Be created under the administrator account in DocuSign and be using the same email address specified in User Settings.
Note:If this option is selected and the user does not have an email specified in User Settings, notifications are sent on behalf of the DocuSign administrator account (i.e., the Login Email specified above). If this option is selected and the user has an email specified in User Settings that does not exist within DocuSign, the user is unable to upload envelopes to DocuSign.
Note:For more information on these credentials, refer to the help files provided by DocuSign.
-
-
Click Advanced. The Advanced DocuSign Options dialog box is displayed.
- Select Archive Signed Envelope as New Document to import the signed envelope into OnBase as a new document. To specify which Document Type to import the signed envelope as, select a Document Type from the Save as Document Type drop-down list.
-
Select Apply Envelope ID as Keyword to store the
envelope ID generated by DocuSign as a Keyword Value on the OnBase document. To specify which Keyword Type to
store the envelope ID in, select a Keyword Type from the Save as
Keyword Type drop-down list.
Note: If both Apply Envelope ID as Keyword and Archive Signed Envelope as New Document are enabled and the selected Keyword Type is present on the selected Document Type, the envelope ID is also stored as a Keyword Value on the new signed document.
- Select Archive Certificate of Completion to automatically import the Certificate of Completion of a signed document when the signed document is returned to OnBase. To specify which Document Type to import the Certificate of Completion as, select a Document Type from the Save as Document Type drop-down list.
- Select Specify Template by Keyword to automatically specify a DocuSign Template based on a specified Keyword. To specify the Keyword Type by which the specified DocuSign Template is determined, select a Keyword Type from the drop-down list. Select Null Keytype to specify the DocuSign Template based on the absence of a Keyword Type.
-
To select and map a DocuSign Template, click Templates. The DocuSign Templates dialog box is displayed.
-
Select a DocuSign Template from the drop-down list.
Note:
Do not select a DocuSign Template that is configured to contain more than one document. A DocuSign Template intended for use with the OnBase Integration for DocuSign must only contain a single document. If the selected DocuSign Template contains multiple documents, errors may occur when users upload documents to create DocuSign Envelopes. See your DocuSign documentation for information on configuring DocuSign Templates.
-
Click OK. The Template Role Mapping dialog box is displayed.
-
To map Keyword Types to DocuSign Template Roles for the selected DocuSign Template:
-
Enter the name of the Template Role in the Template Role field. This field is required.
Note:
The Template Role field must exactly match the Role Name in the DocuSign Template designer.
Note:Template Role names consisting only of spaces are not supported.
- To map the Signer Name of the DocuSign Template Role, select a Keyword Type from the Name Keyword drop-down list. A selection is required.
- To map the Signer Email of the DocuSign Template Role, select a Keyword Type from the Email Keyword drop-down list. A selection is required.
-
Click Add. The Template Role mapping is added to the Template Role mapping list.
To remove a Template Role mapping, select the Template Role mapping in the Template Role mapping list, and click Remove.
-
Enter the name of the Template Role in the Template Role field. This field is required.
- Click Close to close the Template Role Mapping dialog box.
- Once your advanced options are selected, click Save to close the Advanced DocuSign Options dialog box.
- Once your credentials are verified and advanced options selected, click OK to close the DocuSign Integration Configuration dialog box.