Connect Server  |  Set up  |  Settings  |  Submit  |  Associated Files

Associated Files
Using Associated Files
Reserved Names
 
Reserved Names


Associated file commands are entered into a text object in FTDesign using the syntax
##A#<name>#<value>#, where <name> is either a reserved command such as those listed below, or your own Associated file command for use with archiving or other purposes, and <value> is the field populated by the incoming data stream and/or constant text. Such text objects are not printed on the final output from the FormTrap process, however the command will be used to populate the Associated file and/or to deliver the document. FTSpooler completes delivery of its documents using the specified delivery engines. Each delivery engine implements a special way of outputting formatted documents.

The standard delivery engines are:

  • Printing
  • MAPI e-mail/fax, SMTP, Windows Fax Service
  • Output to directory

The additional delivery engines implement third-party products:

  • NetFax
  • WinFax
  • OSFax
  • Esker Fax
  • Esker Mail

A complete list of reserved names that FTSpooler is able to recognise and use for delivery is displayed below. All entry names are not case sensitive.
Associated File Reserved Names
 
Delivery Engine Reserved Name Description
Printing Recipients Print

Windows Printer name. This entry tells FTSpooler to print the formatted FormTrap document using the specified windows PCL/PS printer. Ensure the Windows printer name is used and NOT the printers network path.

The following entry is a valid entry:

##A#Print#HP LaserJet 4100N PCL6#
MAPI Recipients EmailTo Email address of the primary recipient. This entry tells FTSpooler 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. These are both valid entries:

##A#EmailTo#username@domain.com#

##A#EmailTo#userA@domain.com; userB@domain.com#
EmailCC Email address of the secondary recipient. This entry tells FTSpooler 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. These are both valid entries:

##A#EmailCC#username@domain.com#

##A#EmailCC#userA@domain.com; userB@domain.com#
EmailBCC Email address of the blind carbon copy recipient. This entry tells FTSpooler 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. These are both valid entries:

##A#EmailBCC#username@domain.com#

##A#EmailBCC#userA@domain.com; userB@domain.com#
VSIFAXTo VSI Fax number. This entry tells FTSpooler that the formatted document is sent to a Esker VSI-FAX Fax engine installed and configured.VSI-FAX provides a comprehensive, multi-platform fax solution for users who requires faxing of any document from any application running on Unix, or Windows 2000/NT/XP. The VSIFAXTo entry can only have one fax number as its value. The following entry is a valid entry:

##A#VSIFAXTo#1 222 333 4444 #
FaxTo Fax number. This entry tells FTSpooler 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. The following entry is a valid entry:

##A#FaxTo#1 222 333 4444#
Delivery Options Subj Subject line for emails and faxes with a cover page. These specified subject line will be added to the email message or to the cover page of the fax. The following entry is a valid entry:

##A#Subj#Invoice#

This Associated File field may contain one or many fields.

More information on Using Multiple Associated File Fields
EmailTitle This option names the attached file. The following entry is a valid entry.

##A#EmailTitle#Invoice Form#
EmailBody Body text for the email message. The entry must use the full path of the text file that contains the body of the email message. The following entry is a valid entry.

##A#EmailBody#C:\FolderName\File Name.txt#
EmailFrom Return email address. This entry can be used to set the return email address for each email message being sent. The following entry is a valid entry.

##A#EmailFrom#username@domain.com#
EmailFrom Name 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. The following entry is a valid entry.

##A#EmailFromName#Accounts Department#
EmailFrom Type Document type, use internally. The following entry is a valid entry:

##A#EmailFromType#Purchase Order#
SMTP Recipients SMTPTo SMTP emailing address of the primary recipient. This entry tells FTSpooler 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. These are both valid entries:

##A#SMTPTo#username@domain.com#

##A#SMTPTo#userA@domain.com; userB@domain.com#
SMTPCC SMTP emailing address of the secondary recipient. This entry tells FTSpooler 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. These are both valid entries:

##A#SMTPCC#username@domain.com#

##A#SMTPCC#userA@domain.com; userB@domain.com#
SMTPBCC SMTP emailing address of the blind carbon copy recipient. This entry tells FTSpooler to email a copy of the formatted FormTrap document to the specified email address. This email address will NOT be appear on the message. TThis must be fully qualified (username@domain.com), Windows address book names cannot be used. Multiple entries may be specified, separated by a semi-colon. These are both valid entries:

##A#SMTPBCC#username@domain.com#

##A#SMTPBCC#userA@domain.com; userB@domain.com#
Delivery Options Subj Subject line for emails and faxes with a cover page. These specified subject line will be added to the email message or to the cover page of the fax. The following entry is a valid entry:

##A#Subj#Invoice#

This Associated File field may contain one or many fields.

More information on Using Multiple Associated File Fields
EmailBody Body text for the email message. The entry must use the full path of the text file that contains the body of the email message. The following entry is a valid entry.

##A#EmailBody#C:\FolderName\File Name.txt#
EmailTitle This option names the attached file. The following entry is a valid entry.

##A#EmailTitle#Invoice Form#
SMTPFrom Return SMTP email address. This entry can be used to set the return SMTP email address for each email message being sent. The following entry is a valid entry.

##A#SMTPFrom#username@domain.com#
SMTPFrom Name 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. The following entry is a valid entry.

##A#SMTPFromName#Accounts Department#
SMTPFrom Type Document type, use internally. The following entry is a valid entry:

##A#SMTPFromType#Purchase Order#
Directory Recipients OutFolder Path for write to file option. This entry is used to set the directory path for the write to file option in FTSpooler. The following entry is a valid entry.

##A#OutFolder#C:\FolderName#
NetFax Recipients NetFax Recipient Fax Number, Name and Company. This is the only mandatory entry for NetFax in the Associated File. This entry tells FTSpooler that the document is to be sent to NetFax for faxing. Name and/or Company are optional entries, separated by a comma. Multiple recipients maybe specified, separated by semi-colon. These are all valid entries.

##A#NetFax#1 222 333 4444#

##A#NetFax#1 222 333 4444, Name#

##A#NetFax#1 222 333 4444, Name, Company#

##A#NetFax#1 222 333 4444, , Company#

##A#NetFax#1 222 333 4444; 1 222 333 5555#
Delivery Options NetFaxRes Resolution, values are low or high. The defaul is high and this entry is not usually required.

##A#NetFaxRes#low#

##A#NetFaxRes#high#
DocID Document identifier, for information purposes.

##A#DocID#123454678#
DocType Document type, for information purposes.The following entry is a valid entry:

##A#DocType#Purchase Order#
WinFax PRO Recipients WFP Recipient Fax Number, Name and Company. This is the only mandatory entry for WinFax PRO in the Associated File. This entry tells FTSpooler that the document is to be sent to WinFax PRO 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 all valid entries:

##A#WFP#1 222 333 4444#

##A#WFP#1 222 333 4444, Name#

##A#WFP#1 222 333 4444, Name, Company#

##A#WFP#1 222 333 4444, , Company#

##A#WFP#1 222 333 4444; 1 222 333 5555#
Delivery Options WFPRes Resolution, values are low or high. The default is high and this entry is not usually required.

##A#WFPRes#low#

##A#WFPRes#high#
WFPDelete Delete (or not delete) files after sending. If delete is set, the user will not be able to view sent faxes. A, B and C have the same meaning. These are all valid entries:

##A#WFPDelete#A#

##A#WFPDelete#B#

##A#WFPDelete#C#
WFPCover Cover sheet file name. You may use the full path  name or a description from the WinFax PRO Cover Sheet data base. These are all valid entries:

##A#WFPCover#C:\FolderName\filename#

##A#WFPCover#Invoice Cover Page#
WFPSchedule Schedule the fax. If omitted, the fax is scheduled immediately. Values allowed are:
  • off peak - scheduled off peak (use message manager to set)
  • hold - hold the message in Outlook
  • parseable date and time - format according to local settings
  • parseable time - sent today at the time, format to local time settings

These are all valid entries:

##A#WFPSchedule#offpeak#

##A#WFPSchedule#hold#

##A#WFPSchedule#25/01/01 19:30:00#

##A#WFPSchedule#08:30:00 AM#
WFPSubj Subject line for the cover page. This entry is included in the WinFax PRO log, whether a cover page is used or not. The following entry is a valid entry.

##A#WFPSubj#Purchase Order#

This Associated file field may contain one or many fields.

More information on Using Multiple Associated File Fields
WFPBody Body text for the cover page. It is ignored if there is no Cover Page specified. The entry may quote a full file name or directly contain the body text. These are all valid entries:

##A#WFPBody#message text#

##A#WFPBody#C:\FolderName\filename.txt#
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 FTSpooler 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 all valid entries:

##A#W2KFAX#1 222 333 4444#

##A#W2KFAX#1 222 333 4444, Name#

##A#W2KFAX#1 222 333 4444, Name, Company#

##A#W2KFAX#1 222 333 4444, , Company#

##A#W2KFAX#1 222 333 4444; 1 222 333 5555#
Delivery Options W2KFAX Schedule Schedule the fax. If omitted, the fax is scheduled immediately. Values allowed are:
  • off peak - scheduled off peak (use message manager to set)
  • hold - hold the message in Outlook
  • parseable date and time - format according to local settings
  • parseable time - sent today at the time, format to local time settings

These are all valid entries:

##A#W2KFAXSchedule#offpeak#

##A#W2KFAXSchedule#hold#

##A#W2KFAXSchedule#25/01/01 19:30:00#

##A#W2KFAXSchedule#08:30:00 AM#
W2KFAXSubj Subject line for the cover page. The following entry is a valid entry.

##A#W2KFAXSubj#Purchase Order#

This Associated file field may contain one or many fields.

More information on Using Multiple Associated File Fields
W2KFAXBody Body text for the cover page. It is ignored if there is no Cover Page specified. The entry may quote a full file name or directly contain the body text. These are all valid entries:

##A#W2KFAXBody#message text#

##A#W2KFAXBody#C:\FolderName\filename.cvp#
Esker Fax Web Service Recipients EskerFax Recipient Esker Fax Number, Name and Company. This is the only mandatory entry for Esker Fax in the Associated File. This entry tells FTSpooler that the document is to be sent to Esker Fax for faxing. Name and/or Company are optional entries, separated by a comma. Multiple recipients maybe specified, separated by semi-colon. These are all valid entries.

##A#EskerFax#1 222 333 4444#

##A#EskerFax#1 222 333 4444, Name#

##A#EskerFax#1 222 333 4444, Name, Company#

##A#EskerFax#1 222 333 4444, , Company#

##A#EskerFax#1 222 333 4444; 1 222 333 5555#
Delivery Options EskerFax Sender Esker Fax Sender Name. This entry tells FTSpooler who the document is to be sent to. The following entry is a valid entry:

##A#EskerFaxSender#Accounts Department#
EskerFax SenderComp Esker Fax Company Name. This entry tells FTSpooler which company the document is to be sent to. The following entry is a valid entry:

##A#EskerFaxSenderComp#CompanyName#
EskerFax Cover Cover sheet file name. You may use the full path  name or a description from the Esker Fax Cover Sheet data base. These are all valid entries:

##A#EskerFaxCover#C:\FolderName\filename.cvp#

##A#EskerFaxCover#Invoice Cover Page#
EskerFax Subject Subject line for the cover page. This entry is included in the Esker Fax Service log, whether a cover page is used or not. The following entry is a valid entry.

##A#EskerFaxSubject#Purchase Order#

This Associated file field may contain one or many fields.

More information on Using Multiple Associated File Fields
EskerFax Message Message for the cover page. It is ignored if there is no Cover Page specified. The entry may quote a full file name or directly contain the body text. These are all valid entries:

##A#EskerFaxMessage#message text#

##A#EskerFaxMessage#C:\FolderName\filename.rtf#
EskerFaxNfy Document identifier for Esker Fax Service, use internally. The following entry is a valid entry.

##A#EskerFaxNfy#12345678#
EskerFax Priority Priority settings for the fax. The priority can be set to high, low, normal or default. These are all valid entries:

##A#EskerFaxPriority#high#

##A#EskerFaxPriority#low#s

##A#EskerFaxPriority#normal#

##A#EskerFaxPriority#default#
EskerFax NfyType Document type for Esker Fax Service, use internally. The following entry is a valid entry.

##A#EskerFaxNfyType#Purchase Order#
Esker Mail Web Service Recipients EskerMail Recipient of Esker Mail Web Service address line. This entry tells FTSpooler to mail the formatted FormTrap document to the specified address using Esker Mail Web Service. This is the address option allows you to enter 3 to 7 lines, "~" is used to wrap different lines of address. The following is an valid entry:

##A#EskerMail#Address Line 1 ~ Address Line2~ Address Line 3 ~ Address Line 4 ~ Address Line 5#
Delivery Options EskerMail Sender Esker Mail Sender Name. This entry tells FTSpooler who the document is to be sent to. The following entry is a valid entry:

##A#EskerMailSender#Accounts Department#
EskerMail Provider Esker Mail Provider Name. This entry tells FTSpooler who the document is provided. The options for provider names are: AU, FR3, US and US2. The following entry is a valid entry:

##A#EskerMailProvider#AU#

##A#EskerMailProvider#US2#
EskerMail Duplex Duplex Esker Mail document. This entry allows both sided printing. The only two options for Esker Mail Duplex are Y or N. The following entry is a valid entry:

##A#EskerMailDuplex#Y#

##A#EskerMailDuplex#N#
EskerMail Color This entry enables colour printing of Esker Mail Service. The only two options for Esker Mail Color are Y or N. The following entry is a valid entry:

##A#EskerMailColor#Y#

##A#EskerMailColor#N#
EskerMail Cover Cover sheet file name. You may use the full path  name or a description from the Esker Mail Cover Sheet data base. These are all valid entries:

##A#EskerMailCover#C:\FolderName\filename.cvp#

##A#EskerMailCover#Invoice Cover Page#
EskerMail NfyReceipt

 

 Acknowledgement of receipt for Esker Mail Service, use internally. The only two options for Esker Mail Notify Receipt are Y or N. The following entry is a valid entry.

##A#EskerMailNfyReceipt#Y#

##A#EskerMailNfyReceipt#N#
EskerMail NfyReturned Non-delivered mail notification for Esker Mail Service, use internally. The only two options for Esker Mail Notify Returned are Y or N. The following entry is a valid entry.

##A#EskerMailNfyReturned#Y#

##A#EskerMailNfyReturned#N#
OSFax Recipients OSFax Recipient Fax Number, Name and Company. This is the only mandatory entry for OsFax Service in the Associated File. This entry tells FTSpooler that the document is to be sent to OsFax 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 all valid entries:

##A#OSFax#1 222 333 4444#

##A#OSFax#1 222 333 4444, Name#

##A#OSFax#1 222 333 4444, Name, Company#

##A#OSFax#1 222 333 4444, , Company#

##A#OSFax#1 222 333 4444; 1 222 333 5555#
Top