What are Associated Files

The Associated File is a powerful facility within FormTrap designed to allow document-specific information to be extracted from a FormTrap form into a separate file at run-time. Most often, the associated file is used to extract delivery details such as the fax number or email address of the recipient, but can be used in conjunction with any user process, either embedded (File and Output Filter processes) or external (written to output and used by external programs).

How Associated Files Work

The Associated File is a simple text file containing entries in a name=value syntax. The name is simply a field name used to identify the data contained in the value. For example, EmailTo=support@formtrap.com identifies the value support@formtrap.com as being an EmailTo field.

  • Associated file entries may direct processes:
    archive=yes
  • may provide data to a process
    DocNum=PO60803
  • or may both direct and provide data to a process
    EmailTo=support@formtrap.com

Within FTSpooler, there are a number of reserved names that are recognised and used for delivery and archiving purposes.

See the full list of Reserved Names.

For example, at run time, a print stream maybe split into five documents. As the first of these is formatted an Associated File is produced that contains the entry FaxTo=1 234 567 8900. The name FaxTo is recognised by FTSpooler as requiring the document to be faxed to the number 1 234 567 8900. This process is repeated for each and every document with FaxTo in the Associated File.

FTSpooler recognizes the reserved names and delivers the document accordingly, however, all names are recorded automatically in the successful or unsuccessful jobs archives with their documents. You can carry out meaningful index data searches using Associated File Names.

You can also utilize user-defined names in any post-processing operations you may wish to perform (usually in the optional write to file or output filter facilities). For example, you may create index keys for long term archiving, or FTP details to aid in automated delivery of large files to alternative printing facilities (e.g. mailing bureau) or even direct delivery to the recipient.

Top