The DocuSign Connect Import QSX is a Quillix Input QSX that is used to capture DocuSign envelopes as Quillix batches. The Input QSX has two parts - the QSX that allows configuring the Batch Profile, index fields, and options, and a webhook intended to be hosted on a web server that will be connected to by DocuSign Connect to send document envelopes to Quillix Capture. This documentation will cover configuring the QSX to connect to DocuSign Connect. DocuSign has very good documentation on setting up Connect on their side: DocuSign Connect Support
The QSX Configuration Dialog provides settings for General Info, Indexes and other options. The QSX Configuration Dialog is accessed by either double-clicking on an instance of the QSX, or by right clicking on an instance of the QSX on a capture process map, and clicking on Configure.
The first tab on the QSX Configuration Dialog is used to provide non-indexing settings. There are settings for Source directory, Working directory, Batch Naming, JSON options, Document Identification options and to enable Verbose Logging.
Figure 1 - DocuSign Connect Import QSX - General Info
Source Directory |
Sets the location where the QSX will look for DocuSign envelopes written by the webhook. This location must match the "Path" location set in the webhook's appsettings.json. |
Working Directory |
The user-set location where the QSX will copy files temporarily for processing. |
Batch Name |
Sets batch naming options to provide for unique names. |
JSON Options |
Options to allow saving the original DocuSign JSON as a page in the batch, and whether to save the original DocuSign JSON to a backup location. |
Document Identification |
Allows selecting a field and setting an expected value for the field. If the field or value is not found, the document envelope will be ignored. This feature can be used as additional proof that the document should be imported, and also allows one webhook to work with multiple DocuSign Connect Import QSX Modules at once. |
Verbose Logging |
This option tells the QSX to provide to the Reports log extended logging of processing, provided the Minimum Log Level setting on the Settings page in Process Manager is set to Trace. |
Indexes Tab
The second tab on the QSX Configuration Dialog is used to set the Quillix Batch Profile and to map Batch Profile Index Fields to fields in the DocuSign document.
Figure 2 - DocuSign Connect Import QSX - Indexes
Batch Profile |
Sets the Batch Profile to be used when importing DocuSign documents. |
Index Fields |
Double-click on the field to see options for mapping DocuSign metadata to the selected Quillix Batch Profile Index Field. |
Double-clicking on an Index Field loads the following dialog:
Figure 2 - Docusign Connect Import QSX - Index Field Mapping
Don't map this field |
Select this option to not map this index field. |
Static Value |
Select this option and provide a static value to apply to this index field. |
DocSign defined field |
Select the DocuSign field to map to the Quillix Index Field. If a DocuSign custom field is selected, the name of that field must be provided. If a field that is a list like 'signers' or 'witnesses' is selected, set the number (1 and up) of the 'signer' or 'witness'. |