Introduction

With the increase in the number of CopiaFacts systems which include multiple board types, configuring the fax header line becomes a more complicated task.  Each fax board manufacturer supports different formats and codes in the fax header text, and so the header line needs to take account of which board will be used to send the fax.

For details of the specific codes expanded for each fax board, see the Hardware section and the board documentation.

There are three basic places where a fax header line can be specified: the $fax_header commands, a FAX_HEADER_xx variable, and the $apply_gct command.

$fax_header Commands

The user profile or user properties $fax_header command supplies a default fax header for all transmissions done with the user.  It applies to all boards and therefore may need to be overridden when multiple board types are in use.

The FS file $fax_header command overrides the fax header for a specific transmission.  If you are limiting the board types on which the FS can be transmitted (for example by TOSEND queue) then it is possible to use board-specific variables in this command. Otherwise you may need to override it for specific boards.

FAX_HEADER_xx Variables

These variables can be defined (in CFG, USR/UJP or FS files) to override the $fax_header command to ensure that the correct syntax is used for a specific board. The following variables are available:

FAX_HEADER_BMSpecifies the header (and optional footer) text for use on Brooktrout TR1034 boards and recent TruFax boards. Unicode is not supported.
FAX_HEADER_DNSpecifies the header text for use on Dialogic VFX/40 boards. Unicode is not supported.
FAX_HEADER_ENSpecifies the header text for use on Diva Server boards and TE-Systems ports. Unicode is not supported.
FAX_HEADER_ENUSpecifies the Unicode header text for use on Diva Server boards.  Unicode is supported on later driver versions only, see below.
FAX_HEADER_FMSpecifies the header text for use on Fax Modems and, if specified for a fax modem line, KEEP_FAX archive copies of files. Unicode is supported in the same way as for $apply_gct.
FAX_HEADER_KFSpecifies the header text for use on 'Keep Fax' archive copies of sent faxes.  Since no board is used to create these files, no board-specific codes are available for use; however Unicode is supported in the same way as for $apply_gct. If KEEP_FAX is specified for a fax modem line, this variable is ignored.
FAX_HEADER_PVSpecifies the header text for use on Job Administration Preview fax documents and FFClient Fax. Since no board is used to create these files, no board-specific codes are available for use; however Unicode is supported in the same way as for $apply_gct.
FAX_HEADER_OFSpecifies the header (and optional footer) text for use on BladeWare OTF IP Ports and Sangoma boards. Unicode is not supported.
FAX_HEADER_CSSpecifies the header text to use on transmissions which are being consolidated.

Note that the contents of the above variables override all $fax_header specifications, even $fax_header none.  You can use none as a value of the above variables to suppress a header for a specific environment, and none is the default value of FAX_HEADER_PV for Job Administration preview.

None of the boards which support header text currently support Unicode.  If you supply Unicode text it may appear either as ? or as some other characters.  To use Unicode in fax header lines, use $apply_gct as described below.

$apply_gct Commands

The $apply_gct command can be used in an FS file to apply a header line defined in a GCT to an outgoing fax.  You should normally define the $fax_header or FAX_HEADER_xx value(s) as none to prevent two header lines being added.

Sample header files for use with $apply_gct are provided in the FAXFACTS folder.  You can define any font for use in the header annotation, although some smaller font sizes and styles may not look good on low-resolution fax transmissions.  You may need to adjust the offset value on the $apply_gct command depending on your chosen font size and annotation box size.

A built-in GCT file is used to apply the annotations for the 'Keep Fax' archive documents and for Job Administration previews.  This is used to apply header texts both from $fax_header commands and from FAX_HEADER_KF and FAX_HEADER_PV overrides.  To control the settings for this built-in header GCT, the following variables are available:

FAX_HEADER_FONTSpecifies the font name (default Arial)
FAX_HEADER_SIZESpecifies the font size (default 10)
FAX_HEADER_HEIGHTSpecifies the height of the annotation box (default 60 high-res pixels)
FAX_HEADER_STYLESpecifies the $style letters for the annotation (default T)
FAX_HEADER_OFFSETSpecifies the offset of the annotation: positive to add pixels above the image, negative to clear pixels at the top of the image, and zero to overlay the image (default 50).

The above variables do not affect normal usage of the $apply_gct command, only the internal apply-GCT file.

Showing Page Number

The page number within a fax is normally shown on the fax header line, using syntax specified by the fax board manufacturer:

BladeWare: Use %P in the header text to insert the current page number in either the header or the footer.
Brooktrout:Use %P in the header text to insert the current page number in either the header or the footer.
Dialogic VFX: Use %P in the header text to insert the current page number.
Dialogic Diva(Page number is automatically inserted).
Fax Modem:Use @COUNT_1 or @AG_PAGE in the header text
Job Preview:Use @COUNT_1 or @AG_PAGE in the header text
Keep Fax:Use @COUNT_1 or @AG_PAGE in the header text

The page number may also be inserted in the body of a fax generated using CopiaFacts built-in ASCII conversion, by referencing the COUNT_1 variable once on each page, in an annotation defined in the ASCII-template GTT file. If a coversheet precedes the ASCII file(s) then use this variable also on the coversheet.

Showing Total Page Count

Use the system variable @TPAGES. Note that the Diva board adds page number and page count automatically at the right-hand end of the line.

Showing the local CSID

Use the system variable @LOCAL_CSID. Note that the Diva board adds this field automatically, if there is space on the line to do so.

Showing the remote CSID

The following boards allow the remote answerback to be inserted in the header line:

Dialogic VFXUse %R

Board-Specific Notes

The following considerations apply to specific fax boards:

BladeWareCurrently, header text is centered, so you may wish to pad out the width of variable fields using the syntax @varname{width}.  A number of special codes are available, introduced using a % symbol:
BladeWare Header/Footer Codes
BrooktroutA number of special codes are available, introduced using a % symbol:
Brooktrout Header/Footer codes
Diva ServerWe recommend that you pad out header lines to a width of about 85 characters, using the syntax @varname{width} to create fixed width fields (see example below).  Shorter lengths will cause the Dialogic Diva software to add date, time, and local CSID fields to the left of the header (as many fields as available space permits), so using a fixed width for your custom header line avoids variations in the header format. The page number and total number of pages are always appended at the right-hand end of the header line unless the none keyword is used to suppress the header.
On Diva Server boards with drivers 8.5.14 and CopiaFacts 8.2.0.65 and later, Unicode is supported for fax header lines.  see below

Diva Custom Fax Header Lines

To use Diva Custom Fax Header lines you require Diva Driver 8.5 rev 14 or later and CopiaFacts 8.2.0.65 or later.  If the drivers are not this version the variables below are ignored.

The following variables should be set (example below):

DIVA_HEADLINE_FONTThe pathname of a TTF file to be used.  Note that a path name, not a font name is required: for example c:\windows\fonts\times.ttf, not "Times New Roman". The font must fully support the required character set: use the 'designed for' column in the Windows fonts 'detail' display to check this. It is not sufficient for a specific Unicode glyph to be included in the font.
DIVA_HEADLINE_FONTSIZEThe point size to be used.  Values less than 8 will be set to 8.
DIVA_HEADLINE_NO_DATETIMEOptional: set to a non-empty value to disable the addition of a date at the start of the text.
DIVA_HEADLINE_NO_PAGEINFOOptional: set to a non-empty value to disable the addition of a page number and count at the end of the text.
FAX_HEADER_ENUOptional: set to the header text required for the custom header.  Use this variable if you have special text for the custom header and a mixed system where some machines support custom headers and some do not.  If not supplied, the $fax_header or FAX_HEADER_EN text is used.

Examples:

Simple header valid on all supported boards:

$fax_header "To: @ROUTETO Page @COUNT_1 of @TPAGES @DATE1 @TIME2

Suppress header:

$fax_header none

Date and time in a fixed horizontal position:

$fax_header "To @ROUTETO{40} @DATE1 @TIME2

Fax header and footer (Brooktrout TR1034 and BladeWare only):

$fax_header "This text at top|~|This text at foot"

Fax header for Diva (which automatically adds date, time, CSID, pages), with Brooktrout boards in the same system getting a similar header content:

$fax_header "@ROUTETO"

$var_def    FAX_HEADER_BM "@DATE1 @TIME @LOCAL_CSID @ROUTETO{32} Page %P of @TPAGES"

Fax header for Diva using fixed-width fields to pad out the text and avoid insertion of date and time at the left:

$var_def FAX_HEADER_EN "@LOCAL_CSID{20} Fax:@RCVRFAX To: @BCF2{20} @BCF3{10} @DATE1 @TIME1"

Fax header for Diva using variable-width fields with all padding at the right.  Note that the Diva board will add page number and count at the far right:

$var_def FAX_HEADER_0  " @LOCAL_CSID Fax: @RCVRFAX To: @BCF2 @BCF3 @DATE1 @TIME1"

$var_def FAX_HEADER_EN "^FAX_HEADER_0{85}"

Note that the variable name FAX_HEADER_0 has no special significance, but is chosen to ensure that it precedes the FAX_HEADER_EN variable when a sorted variable list is generated by Job Administration.  If you are setting this up other than in Job Administration you must ensure that the two variables appear in the sequence above.

Custom Diva Headers:

$var_def DIVA_HEADLINE_FONT "c:\windows\fonts\msmincho.ttf"

$var_def DIVA_HEADLINE_FONTSIZE 14

$var_def DIVA_HEADLINE_NO_DATETIME 1

$var_def FAX_HEADER_ENU "This is a custom header sent on @DATE_L from 東京日本"