DocuSign connector

The DocuSign connector is used to send documents via email to be digitally signed. The process flow waits for a document to be signed before continuing with the process. The signed document is saved to the Alfresco Content Services repository folder that corresponds to the process instance ID that called the connector in the following format:

<application-name> Site / Document Library / <process-instance-id> / <service-task-id> / <signed-document>

Important: The DocuSign connector requires a licensed version of Alfresco Content Services (ACS) deployed to interact with. It also requires a DocuSign account to handle document signing.

The DocuSign connector is graphically represented by the DocuSign logo under the OOTB Connectors menu whilst modeling a process.

The implementation value of the DocuSign connector in a service task would be similar to the following:

<bpmn2:serviceTask id="ServiceTask_1jas8cr" implementation="docusignConnector.SIGNDOCUMENT" />

DocuSign configuration

The DocuSign connector uses the DocuSign REST API. An application needs to be set up and authorized to utilize this functionality in the connector. The following steps outline this process:

  1. Sign into your DocuSign account.
  2. Configure an application for JWT authentication including the prerequisites required to setup an RSA key.
  3. Grant consent to the application.

Configuration parameters

Values for configuration parameters that are specific to a connector instance can be set in the modeling application or during application deployment.

The following are the configuration parameters that need to be set for the DocuSign connector:

ParameterDescription
DOCUSIGN_APILOCATIONThe URL of the DocuSign REST API to use
DOCUSIGN_ACCOUNT_IDThe DocuSign account that the application is registered to
DOCUSIGN_CLIENT_IDThe application integration key
DOCUSIGN_IMPERSONATED_USER_IDThe GUID of the DocuSign user that the application impersonates
DOCUSIGN_AUTH_SERVERThe URL of the DocuSign authorization server
DOCUSIGN_JWT_LIFETIMEThe expiration time of the JWT expressed in seconds
DOCUSIGN_RSA_KEYThe private RSA key for the DocuSign application
ALFRESCO_CONTENT_REPO_BASE_URLThe base URL of the Content Services deployment

Input parameters

The following are the parameters that can be passed to the DocuSign connector as input parameters using the SIGNDOCUMENT action:

ParameterDescriptionTypeRequired?
nodeIdThe node ID of the file to sign from Alfresco Content ServicesString*
uriThe URI of the file to signString*
filesA file uploaded in a process and set as a process variable or uploaded as part of a form or another connector to signFile*
recipientEmailThe email address to send the file to for signingStringYes
recipientNameThe name of the email recipientStringNo
emailSubjectThe subject line of the emailStringNo
documentIdA document ID for the Docusign API to use. The value must be positive integerIntegerNo
nodeFormatThe document format for the Docusign API. The default value is pdfStringNo
signHerePageThe label for the Sign Here box in the documentStringNo
signHereXThe X position of the Sign Here box in the documentStringNo
signHereYThe Y position of the Sign Here box in the documentStringNo
timeoutThe time to wait for the document to be signed expressed in secondsIntegerNo
parentFolderThe node ID of the folder to store the signed document in. If this value is set, the generated document will be output here and not to the default process instance folder for the process instanceStringNo
outputFileNameThe name of the signed documentStringNo
targetFileAn existing file to overwrite with the signed documentFileNo
nodeTypeThe node type assigned to the signed document in ACS. The default is cm:contentStringNo

* One of these parameters is required.

Output parameter

The following is the parameter that is returned to the process by the DocuSign connector as an output parameter using the SIGNDOCUMENT action:

ParameterDescriptionType
docusign.resultThe node ID of the signed documentString
docusign.errorA list of errors if any are caught by the connectorString

© 2023 Alfresco Software, Inc. All Rights Reserved.