Delivery Tags
(Associated Files)
Delivery Tags
Delivery Tags are defined in the XML section of form design, with
any required substitutions done as part of XML generation.
FormTrap Server delivers documents using the delivery engine(s)
mentioned in Delivery Tags. Each delivery engine implements a
different way of outputting formatted documents.
The standard delivery engines are:
- Either E-mail using TLS/SSL (third-party via Gmail,
Yahoo, other delivery services)
or Email using SMTP or MAPI in the same network. - Windows Fax Service
- e-Fax Services
- Output to folder
A complete list of delivery tags is shown below. Names are not case sensitive.
Notes:
1. Delivery Tag Names with no following values ARE IGNORED. Hence an "SMTPTo=" will NOT be delivered to SMTP, it will be ignored.
2. Recipients on Delivery Tags are accumulated. This is in contrast to non-recipients where the first value only is used.
Examples:
| Smtpto=paul <paul@formtrap.com>, joe <joe@formtrap.com> Smtpto=adam <adam@formtrap.com> | Emails to all three recipients |
Non-recipient are different - only the first value is used
| Smtpfrom=paul <paul@formtrap.com> Smtpfrom=adam <adam@formtrap.com> |
Email is from paul only |
Delivery Tag Names
| Delivery Engine | Type | Tag Name | Description |
| Directory | Recipients | OutFolder |
Root folder path for "write to
file" option. Use of outfolder delivery tag means
the first line Destination folder prompt of Queues,
File tab is ignored and outfolder is subject
to your choice in Queues, Processing tab, Delivery
tags ... prompt.
Use this only if you want to control saving of documents or require to save forms in a single project to a different drive from other forms. Example 1, save invoice, do not save pick list: Invoice form has outfolder delivery tag containing the folder structure to just above file name. Pick list omits outfolder delivery tag. Example2, different drives: outfolder delivery tag includes drive name (no outfolder if no requirement to save document). Note that you can build the entire folder string in the one outfolder delivery tag. |
| FileTitle | Contains File Title (with no extension) optionally may include leading folder name(s) for "write to file" option. Use of filetitle delivery tag means the second line File title prompt of Queues, File tab is ignored and filetitle is subject to your choice in Queues, Processing tab, Delivery tags ... prompt. | ||
| Recipients | Windows Printer name. This entry tells FormTrap Server to print the formatted FormTrap document using the specified windows PCL6/PS/PDF printer. Ensure the Windows printer name is used and NOT the printer's network path. | ||
| Delivery Options | PrintDoc | This entry tells FormTrap Server to
add the named print-ready file to the end of the formatted
document. Print-ready files are stored in the same place as
substitution files. Print-ready files MUST be
pre-tested on the nominated printer and must use the same
printer language. The Server does NO CHECKING on the ability of the printer to print the named file, if the file is an incorrect or unhandled format you will kill trees and/or disable the printer. |
|
| e-Fax (email fax service) |
Recipients | efax | Recipient fax number (numbers only,
no spaces - check with your e-fax provider for exact content),
this is the only entry for e-Fax Service. (specify a RegEx to massage fax data to the correct format) |
| MAPI | Recipients | EmailTo | Email address of the primary recipient. This entry tells FormTrap Server to email the formatted FormTrap document to the specified email address. This can either be fully qualified (username@domain.com) or a Windows address book name. Multiple entries may be specified, separated by a semi-colon. |
| EmailCC | Email address of the secondary recipient. This entry tells FormTrap Server to email a copy of the formatted FormTrap document to the specified email address. This can either be fully qualified (username@domain.com), or a Windows address book name. Multiple entries may be specified, separated by a semi-colon. | ||
| EmailBCC | Email address of the blind carbon copy recipient. This entry tells FormTrap Server to email a copy of the formatted FormTrap document to the specified email address. This email address will NOT be appear on the message. This can either be fully qualified (username@domain.com), or a Windows address book name. Multiple entries may be specified, separated by a semi-colon. | ||
| FaxTo | Fax number. This entry tells FormTrap Server that the formatted FormTrap document is sent to the MAPI fax engine for faxing. To use this entry you must have a MAPI fax engine installed and configured. The FaxTo entry can only have one fax number as its value. | ||
| Delivery Options | Subj | Subject line for emails and faxes
with a cover page. Subj may contain one or many Delivery Tags in square brackets, eg [InvoiceNo]. More information on Using Multiple Delivery Tags |
|
| EmailTitle | This option names the attached file. EmailTitle may contain one of more Delivery Tags, per Subj. | ||
| EmailBody | Body text for the email message. Plain Text: Either text to insert as body text or absolute file name containing body text or relative (to this queue's Substitution folder) file name containing body text (version 8.11 and after). 1. May contain one or many [Delivery Tags] (in square brackets), once delivery tag data is substituted if this is an absolute file name or or a relative file name to this queue's Substitution folder the content of that file is used as body text, otherwise (no file exists), the text is the body text. 2. Text file may contain Delivery Tag Names names in square brackets, e.g. [Delivery Tag]. Content of the same named field is substituted. NO EDIT OCCURS, user is entirely responsible. HTML: (version 8.8 FormTrap Server and later) You may use an HTML file from Version 8.8 onwards. Same conditions apply. You may use [Delivery Tag(s)] to form the file name (absolute or v8.11 and after, relative to this queue's substitution folder), and text may contain embedded [Delivery Tag(s)] which substitute data into that file. |
||
| EmailFrom | Return email address. This entry can be used to set the return email address for each email message being sent. | ||
| EmailFromName | Return email name. This entry can be used to set the name that appears next to the return email address for each email message being sent. | ||
| MailDoc | This entry tells FormTrap Server to attach the named document file to the email. Document files are stored in the same place as substitution files and are normally original documents such as Word or Excel documents, or PDFs. | ||
| SMTP | Recipients | SMTPTo | SMTP emailing address of the primary recipient(s). This entry tells FormTrap Server to email the formatted FormTrap document to the specified email address. This must be fully qualified (username@domain.com), Windows address book names cannot be used. Multiple entries may be specified, separated by a semi-colon. |
| SMTPCC | SMTP emailing address of the secondary recipient. This entry tells FormTrap Server to email a copy of the formatted FormTrap document to the specified email address. This must be fully qualified (username@domain.com) (Windows address book names cannot be used). Multiple entries may be specified, separated by a semi-colon. | ||
| SMTPBCC | SMTP emailing address of the blind carbon copy recipient. This entry tells FormTrap Server to email a copy of the formatted FormTrap document to the specified email address. This email address will NOT be appear on the message. This must be fully qualified (username@domain.com), Windows address book names cannot be used. Multiple entries may be specified, separated by a semi-colon. | ||
| Delivery Options | Subj | Subject line for emails and faxes
with a cover page. Subj may contain one or many Delivery Tags in square brackets, eg [InvoiceNo]. More information on Using Multiple Delivery Tags |
|
| EmailTitle | This option names the attached file. EmailTitle may contain one of more Delivery Tags, per Subj. | ||
| EmailBody | See BodyText within MAPI above for details | ||
| SMTPFrom | From SMTP email address, fully qualified (username@domain.com). | ||
| SMTPReplyTo | Return SMTP email address, fully qualified (username@domain.com). If unused, reply will be to SMTPFrom. (Available from Version 8-27-1 FormTrap Server) | ||
| SMTPFromName | Return SMTP email name. This entry
can be used to set the name that appears next to the return
email address for each email message being sent. This and the above SMTPReplyTo (or SMTPFrom if absent) concatenate to form Accounts Department [username@domain.com]. Note: Do NOT include names with punctuation (comma and semi-colon are treated as delimiter), such as "Company, Inc.". This is treated by SMTP as "Company" and "Inc" where neither will be found. |
||
| MailDoc | This entry tells FormTrap Server to add the named document file to the email. Document files are stored in the same place as substitution files and are normally original documents such as Word or Excel documents, or PDFs. | ||
| Windows Fax Service | Recipients | W2KFAX | Recipient Fax Number, Name and
Company. This is the only mandatory entry for Windows Fax
Service in the Associated File. This entry tells FormTrap
Server that the document is to be sent to Windows Fax Service
for faxing. Name and/or Company are optional entries,
separated by a comma. Multiple recipients may be specified,
separated by a semi-colon. These are examples:
1 222 333 4444 |
| Delivery Options | W2KFAX Schedule | Schedule the fax. If omitted, the
fax is scheduled immediately. Values allowed are:
W2KFAXSchedule offpeak W2KFAXSchedule hold W2KFAXSchedule 25/01/01 19:30:00 W2KFAXSchedule 08:30:00 AM |
|
| W2KFAXSubj | Subject line for the cover page. W2KFAXSubj may contain one or many Delivery Tags in square brackets, eg [InvoiceNo]. More information on Using Multiple Delivery Tags |
||
| W2KFAXBody | Body text for the cover page. It is ignored if there is no Cover Page specified. The entry may quote a full file path or directly contain the body text. |