File Transfer

Performing a file transfer of the completed document without embedding the contents in XML is accomplished through simple configuration steps in the Completed Document Transmission interface.

To start configuring a file transfer, go to the “Administration” tab, and click on “DocumentTRAK” under the “Notifications” heading. The “Completed Document Transmission” table allows you to create a new notification or copy an existing one. When creating a new file transfer, select “Upload using FTP,FTPS, or SFTP” as the Document Transmission Type.

General Information for File Transfer

Provide a unique name for your transfer process that will help you identify it properly when selecting it later on a template workflow instance. Consider avoiding overly generic names such as “Transfer 1” which could cause debugging difficulties later on.

Specify the Hostname or Server URL of your service. This will be the working location of your service, for example "ftp://ftp.mysite.net"

You may customize the port on which to communicate and choose one of

  • File Transfer Protocol (FTP)

  • FTP over SSL (FTPS)

  • Secure Shell File Transfer Protocol (SFTP)

By default, the service will choose the standard port for each method. Authentication may be enabled for FTP and FTPS, and it must be enabled for SFTP. If authentication is enabled you may either use account-level credentials (specified in your Nintex eSign account settings) or specific credentials for the site. At this time, only username/password authentication for SFTP is supported; public key exchange is not currently supported. Also consider that FTPS may not be natively supported by all FTP servers.

Important:  Generally the endpoint should be just the address of the service, and the filename should include the relative path to which the file is being copied, such as "...storagefolder/[Document ID].pdf"

In the case of file transfer, merge fields may be used for naming the file. You have at your disposal merge fields indicated available for use with DocumentTRAK here.

Remember, it is possible to create multiple notifications on a single event. You could create a web notification that occurs on a Document Completed event, and you could create a document transmission via file transfer that also occurs on document completion.

Note: Note: You may need to create a secondary processing mechanism for picking up files transferred to a central file depository. For example, you could use the "Order ID" merge field as part of the name which could be parsed by your application in order to update the associated record in your data. For example, you could enter “[Order ID].pdf” as the Server Filename. Your pickup process may then parse the name, update the corresponding record (for which the order ID is a key) and move the file to a final storage location based on some other characteristic of the record based on your business rules.