Download Envelope Log

The fourth pillar of security, logging provides you with comprehensive audit trail of what happened at any given time and who performed the action.

NOTE  
The audit trail displays all the information about the document and it can be downloaded from Namirial in PDF format together with the signed document. This is done when the property downloadLog is set to true. The configurations are made in the processor settings. If the processor is not used, then this field is sent in the body of the request to DCS.

The envelope log file shows information about the envelope:

  • the general information
  • status of the envelope
  • the creation date
  • the recipients and the changes they made to the document, e. g., which signature fields were placed on the document
  • the time when the workstep was finished.

How to download the envelope log

To download the envelope log:

  1. Log in the FintechOS Studio in developer mode.
  2. In the Main Menu, click Advanced > Server Automation Scripts. The Server Automation Scripts List page appears.
  3. Search for the FTOS_DFP_ESign_Download_OnDemand server automation script and add double-click it. The Edit Server Automation Script page appears.
  4. In the Code field, search for the code written for downloading the document::
    Copy
    var downloadlRequest = {
        "envelopeList": [envelopeId]
    };
    var downloadResponse = JSON.parse(serialize(dcs.downloadSignedDocument(downloadlRequest)));
  5. Edit the downloadlRequest as follows:
    Copy
    var downloadlRequest = {
        "envelopeList": [envelopeId],
        "downloadLog": [true]
    };

The response will also contain the LogFile in base64 format.

Example

Copy 
{
    "Envelopes": [
        {
            "Name": "signedContract",
            "EnvelopeStatus": "Completed",
            "ExpirationDate": "2019-01-18T09:04:36.16Z",
            "SendDate": "2019-01-16T09:04:36.16Z",
            "MetaData": null,
            "SubEnvelopes": [
                {
                    "RecipientEmail": "",
                    "FinishedDocuments": {
                        "DocumentList": [
                            {
                                "DocumentId": "6ba9636e-ef75-425f-8b39-47f428ed7801",
                                "DocumentName": "test.pdf",
                                "FormFieldValues": null
                            }
                        ],
                        "LogDocId": "505598f5-e138-4336-8ce8-3c553dcfec1f"
                    },
                    "Recipients": []
                }
            ],
            "EnvelopeId": "684551f2-f5b9-4eb1-a514-c7eea0be83dd",
            "Files": [
                {
                    "FileName": "test.pdf",
                    "Data": "base 64 file"
                }
            ],
            "LogFiles": [
                {
                    "FileName": "EnvelopeLog_03a5fbfc-480a-4a6d-a796-a7121e46d794.pdf",
                    "Data": "base 64 file"
                }
            ]
        }
    ],
    "IsSuccess": true,
    "ErrorMessage": null
}