The FFBC Template File (also used by FFBCMD) contains CopiaFacts FS commands, most of which are replicated into all the FS files for the job (the exceptions are indicated below).  As the command is replicated, named variables such as @BCFn will be replaced by values in each row of the list, allowing customization of cover sheets, header lines, and other broadcast features for every different recipient.

In FFBC, you can edit the template manually using the editor on the FS Template tab, or you can enter data on the Broadcast tab in the fields indicated below.  The E-Mail tab contains additional fields used for e-mail broadcasts.

All FS file commands are valid in the template file and can be used for example to set up pre- or post-processing of each item.  The commands with special significance for broadcast applications are as follows:

$fax_user userprofile

This a a required command.  It specifies the user profile for the broadcast, which controls factors like the retry strategy and various default parameters.  You can pick the user profile you want to use (normally FAX.USR) from the field in the top panel of the FFBC Broadcast tab:

This dialog also allows you to view and edit the selected profile using the rightmost icon (COPIAEDIT).

$fax_phone @BCF1

This command defines the template as a fax broadcast template. Since fax broadcast is the default, this is not a required command, but if used it overrides the voice and poll phone commands. The example shown above picks the phone number from the first column of the list (Broadcast Field 1, BCF1).

If you have used the options OmitListHeader and CreateBCXVars (described below), you can refer to the column by name instead of by number.  For example if a column header row contains a heading "FaxNo" for a column, your $fax_phone command can contain:

   $fax_phone @BCX_FAXNO

An older syntax for this command is also available: you can use a ? to select the first column, or follow the ? by the field number (with no spaces). So ?3 picks the phone number from the third column of your list (as would @BCF3 instead).

Finally, on the Broadcast List tab of FFBC, you can use the right-click menu in the column header to set up the selected column as that containing the fax phone number.

$voice_phone @BCF1 infobox

This command defines the template as a voice broadcast template. The example shown above picks the phone number from the first column of the list (Broadcast Field 1, BCF1).  The infobox parameter defines an infobox sequence containing the message to be played in the broadcast: it can either be a constant value or might be another list variable (for example @BCF2) in a broadcast where a different message is to be played for some recipients.  Note that the infobox parameter can only be specified on the FS Template tab.

If you have used the option OmitListHeader (described below), you can refer to the column by name instead of by number.  For example if a column header row contains a heading "Phone" for a column, your $voice_phone command can contain:

   $voice_phone @BCX_PHONE

An older syntax for this command is also available: you can use a ? to select the first column, or follow the ? by the field number (with no spaces). So ?3 picks the phone number from the third column of your list (as would @BCF3 instead).

Finally, on the Broadcast List tab of FFBC, you can use the right-click menu in the column header to set up the selected column as that containing the voice phone number.  You will still need to visit the FS Template tab to enter the infobox parameter.

$poll_phone @BCF1 mailbox

This command defines the template as a poll broadcast template.The example shown above picks the phone number from the first column of the list (Broadcast Field 1, BCF1).  The mailbox parameter specifies the mailbox to collect the fax document: it can either be a constant value or might be another list variable (for example @BCF2) in a broadcast where a different mailboxes are to be used for some recipients.  Note that the mailbox parameter can only be specified on the FS Template tab.

The options for using question-mark and BCX header syntax are as described for $fax_phone and $voice_phone above.  The option to select this broadcast type from the Broadcast List tab is not currently available.

$email_address @BCF2

This command defines the template as an e-mail broadcast template. The example shown above picks the phone number from the second column of the list (Broadcast Field 2, BCF2).  If the template also contains a $fax_phone command then the transmission may be attempted as both e-mail and fax, the $email_options command specifying which is tried first. Obviously, the two commands should reference different columns in the list, and if the e-mail address column is blank the e-mail transmission will not be attempted.

If you have used the option OmitListHeader (described below), you can refer to the column by name instead of by number.  For example if a column header row contains a heading "E-Mail" for a column, your $email_address command can contain:

   $email_address @BCX_E-MAIL

An older syntax for this command is also available: you can use a ? to select the first column, or follow the ? by the field number (with no spaces). So ?3 picks the address from the third column of your list (as would @BCF3 instead).

Finally, on the Broadcast List tab of FFBC, you can use the right-click menu in the column header to set up the selected column as that containing the e-mail address.

$fax_receiver fieldspec

You should normally use one or more @BCFn or @BCX_column variable names in this field to select a name from your list to use on cover sheets and to identify the recipient.  The content of the command is available in the @ROUTETO variable.  Note that the ?n syntax is not supported in this field.  You can optionally use punctuation such as commas between the fields.

The fieldspec also has special syntax, now deprecated, to assist with changeover from the legacy applications FAXBC and WBC. You can use from one to four single question marks, space or punctuation separated, to specify how many fields (starting from the second field in each record) comprise the recipient name in a fax broadcast. This feature allows list files prepared for FAXBC or WBC to be used with FFBC, but the default is to use one field only for the complete recipient name. FAXBC and WBC default to concatenating first-name and last-name fields into the recipient name.  The number of fields used is specified by the number of '?' symbols in the fieldspec parameter. The default fieldspec if no command is given is a single "?", which causes just field 2 to be used for the complete recipient name. For example a fieldspec of "? ?, ?" could be used if fields 2, 3 and 4 contained first-name, last-name and company, to produce a recipient name such as "Steve Hersee, Copia International" from three separate fields "Steve","Hersee","Copia International".

Finally, on the Broadcast List tab of FFBC, you can use the right-click menu in the column header to set up the selected column(s) as those containing the recipient name.  Select the first or only column to be used and then add to it the additional columns.  Any required punctuation must be added on the FS Template page.

$fax_tosend n

This command is used to force FFBC to save the generated FS file in the appropriate TOSEND directory, where n is a number between 1 and 9, or between 1 and 15 if your CopiaFacts installation includes optional additional TOSEND folders. FFBC checks that this directory exists.

You can also pick the TOSEND folder from the Priority panel near the bottom of the FFBC Broadcast tab:

$fax_cover "filename"

$fax_header "headertext"

$fax_csid "csid"

These commands are used to specify the cover sheet template file (if used), and the fax header line and CSID (answerback).  The header line and CSID can also be specified in the selected User Profile.  You can also specify the values the panel at the top of the FFBC Broadcast tab:

$fax_sender "ownername"

This command is used to specify the sender of the fax for reference and accounting purposes, and can be placed on a fax cover sheet or header line using @SENDER. It also helps to identify the item in the administrator mode of STATUS, which shows all items.  If no command is provided in the template, and if the CopiaFacts Client is installed and has identified a name for the current user, FFBC will insert this name.  You will be warned when this happens, because the template will need to be saved. You can also specify the value in the panel near the bottom of the FFBC Broadcast tab:

The 'Monitor with STATUS' checkbox enables the addition of FS files generated from FFBC to your records visible in the Client mode of the STATUS program. If you do not have the COPIAFACTS Client installed so this option will not be available.  Note also that the option is disabled if you still have legacy $job_owner and $job_id commands in your Template, although these fields are no longer shown on the FFBC Broadcast tab.

$var_def name value

$var_def BCFn selection

$var_def FFBC_OPTIONS "DeDupe OmitListHeader CreateBCXVars"

$var_def DEDUPE_FIELD_NUMBERS value

You may define any variables which are to be used in cover sheets or header lines, or to be recorded (as DATAn) in the daily log file.  These are added to the generated FS files, along with all the BCFn and BCX_column variables derived from the list rows.

Special "variable definitions" using the names of BCF fields are used in the template file for record selection. When any such variables are defined, a record is only used in a broadcast if its instance of that field value equals the template selection value.  You can use multiple definitions of the same or different variables and records will be selected which match any of the definitions. Comparisons ignore the case of alphabetic characters. These special selection commands in the FST file are not transferred to the generated FS files.

The FFBC_OPTIONS variable name is also special.  Its value can be one or both of the keywords shown. The OMITLISTHEADER keyword causes the first data row of the broadcast list to be discarded from the broadcast, on the assumption that it is a header line containing field names.  If in addition you specify CREATEBCXVARS, the values from the first list row are used to create BCX_column variables in each generated FS file, allowing the row variables to be referenced by column name in addition to column number (BCFn). CREATEBCXVARS is ignored if OMITLISTHEADER is not enabled.

The DEDUPE keyword causes the broadcast list to be checked for duplicates as the broadcast is launched. Duplicated items will fail with outcome code 127. The first item found of each duplicated set is the one which is retained.  The default is to use the destination (phone or email) plus the $fax_receiver value to check for duplicates. This can be overridden using the DEDUPE_FIELD_NUMBERS variable, described in Appendix D.

Variables can also be entered on the FFBC Broadcast Tab, and the FFBC_OPTIONS variable can be created and edited using the two supplied checkboxes:

$fax_send_date MM/DD/YYYY

$fax_send_time starttime [endtime [days [DEST|override]]]

These commands control the broadcast schedule and allow a broadcast either to be delayed or to be sent only between certain hours.  The time can be based on local time, on a specific timezone, or can be automatically calculated from the area code or country code of the phone number.  See the Timed Delivery by Destination topic.  The commands can also be maintained on the FFBC Broadcast Tab, where pressing the Set Schedule button brings up a dialog to enter the schedule parameters:

$fax_pages ?

This command (with the special '?' parameter) causes FFBC to calculate the number of pages defined by the $fax_filename and $fax_cover commands in the template file. This feature may be needed if a bureau client uploads a master document for an automatically launched broadcast, and the number of pages to be sent cannot be determined in advance. The calculation takes account of multiple-page TIFF/F, but any ASCII file is counted as a single page only unless you use the pre-conversion (ASCII_TEMPLATE) option. It requires that the machine running FFBC can see the image directories.

In addition to the special processing described above, FFBC warns if the filenames on the $fax_user, $fax_filename and $fax_cover commands cannot be found. It also generates $fax_request_date and $fax_request_time commands giving the time that the broadcast is generated.

Do-Not-Send processing

When you need to exclude specific phone numbers, it improves efficiency if you do this at the time the broadcast is launched.  An FS file will still be generated, but marked so that be handled on any free line/thread in the engine and failed immediately without additional processing.  This ensures that it participates in any statistics or post-processing that you may have specified.  The details are described in the topic Launch-Time Do-Not-Send Checking.

The commands to use are placed in the template file:

$dns_phone pathname [code]

$dns_email pathname [code] [domain|combined]

These commands are used to specify the pathname of a list or index (NDX) which will be used to exclude items from the broadcast when the phone number or e-mail address matches an entry in the file supplied.  Multiple commands of each type can be used.

If you use the default global look-up files DNS.NDX and DNS_MAIL.NDX on these commands (rather than a custom look-up file) you should disable the transmit-time look-up in the same files.  This is done as follows:

$dns_phone @FFLOG\DNS.NDX ; use DNS.NDX look-up at launch time

$var_def DNS_PATH none    ; suppress send time DNS.NDX look-up

$dns_email @FFLOG\DNS_MAIL.NDX ; use DNS_MAIL.NDX look-up at launch time

$var_def DNS_MAIL_PATH none    ; suppress send time DNS_MAIL.NDX look-up

The use of the $dns_file command is now deprecated.  It has the disadvantage that this command in the template will cause no FS files to be generated for matched entries, so the items excluded at this stage will never appear in any reports or summaries or statistics.  However if you do use this command, the Broadcast List Tab will show a matched entry in red font color.

These special do-not send FST file commands are not valid commands for FS files and is therefore never carried through to the generated FS files.