DocuSign Integration - Setting Document Type for New Attachments
Project Maintenance; standard Treeview path: CMiC Field > File Maintenance > Project Maintenance - Esign Maintenance tab
The Document Type for New Documents field, located on the Project Maintenance screen (shown in the screenshot above) and on PM objects, is used to define the document type for new documents uploaded in DocuSign and sent to CMiC.
This field can be set at the system level or the project level. If this field is left empty for an object type at the system and project level, documents sent back to CMiC from DocuSign must keep the original file name and no new attachments can be included in the envelope for the selected object type.
If a document type is selected at either the system or project level for an object, documents that are new to the envelope can be uploaded to DocuSign and added as a new document in CMiC using the object’s selected document type.
The following three scenarios demonstrate why a user might want to replace the original document sent with a newly named document or include new documents in the envelope:
-
If the user wants to delete a sent document in DocuSign and upload and sign a new document.
-
If the user wants to add an attachment to the envelope.
-
If the user wants to select the option to manually sign the document in DocuSign.
Default document types can be set in the E-Sign Maintenance tab of the Project Maintenance screen, which default to the PM object, or the document type can also be selected directly on the PM object.
Setting the Default Document Type
Project Maintenance; standard Treeview path: CMiC Field > File Maintenance > Project Maintenance - Esign Maintenance tab
The default document type can be set for each object type on the E-Sign Maintenance tab of the Project Maintenance screen. Select the object type from the Object Type drop-down menu, then click on the [Default Value] button in the console to launch the Default Esign Value for Object Type pop-up window, as shown in the screenshot above. In the pop-up window, use the Document Type for New Documents field’s drop-down menu to select the document type to be used when a new document is received from DocuSign. The type selected in this pop-up window will be used as the default in the PM object’s ESign pop-up when defaults have not been set at the project level.
NOTE: Field security can be assigned to the Document Type for New Documents field on the Project Maintenance screen or the ESign screen for the PM object, if required. Refer to Security Settings for more information.
Selecting the Document Type from the PM Object
Example of setting the document type for a PM object
If the default document type has been set in the E-Sign Maintenance tab of the Project Maintenance screen for the PM object, then that document type will default to the PM object, but can be updated for the object if required.
DocuSign Process Using Document Type
The following example shows the process used for sending an attachment from a PM object to DocuSign with a document type selected for the object. For this example, we will send an attachment from a subcontract for signing, and we set the document type as "Drawings" at the project level.
Example of sending PM object to DocuSign with document type defined for the object
The screenshot above shows the pop-up window launched from the [Esign Documents] button. Specify the signer in the Contact field and select the attachment to be signed. Select a default document type in the Document Type for New Document field, which will set the document type at the project level. When finished, click the [Send for ESigning] button.
Pop-up window launched from E-Signings link
Once the document has been sent for signing, clicking on the View ESignings link will launch a pop-up window, as shown in the screenshot above, where the attachment which has been included in the envelope will be displayed.
After the document is sent to DocuSign, the signer logs into DocuSign using their account credentials. After reviewing the document, the signer decides they want to make some changes. They want to delete the original file, upload two new files, and make revisions to one of the newly uploaded files.
The signer clicks the Other Actions field and selects "Correct" from the drop-down menu.
The signer deletes the existing document by clicking on the Menu icon and selects "Delete Document" from the drop-down menu.
The signer uploads two new documents using the [Upload] button.
The signer makes changes to one of the newly uploaded documents and presses the [Correct] button when finished.
The signer clicks on the [Continue] button to approve and sign the documents.
Once the documents are signed, the signer clicks on the [Finish] button, which re-sends the documents from DocuSign to CMiC.
CMiC is updated with the signed documents, which use the pre-defined document type (i.e., Drawings). The Attachments tab in the subcontract is updated with three new attachments: the two new documents uploaded by the signer in DocuSign, as well as a revised version of one of the newly uploaded documents.
Clicking on the View ESignings link for the documents displays the two different document types.
Security Settings
Field security exists for the Document Type for New Documents field on the Project Maintenance screen and the ESign screen, as shown in the screenshots below.
NOTE: If a user does not have access to the document type (both create and link privileges) assigned (see CMiC Field - Project Roles), as well as the PM System Options document options set up for the object, the document type will not be displayed in the drop-down list (see Document Types).
Project Maintenance
Role Maintenance; standard Treeview path: CMiC Field > Security > Role Maintenance
E-Sign
Role Maintenance; standard Treeview path: CMiC Field > Security > Role Maintenance