CopiaFacts allows special processing to be selected for specific destination phone numbers, e-mail addresses and e-mail domains.  This is controlled by 'action lists' of numbers, e-mail addresses or e-mail domains.  The lists may be in NDX or TXT format, as described for do-not-send lists.

For each action list, you can specify a numeric action code to be associated with each item matched in the list, or you can specify a separate action code for each item in the list.  NDX lists and action codes can be maintained using the PIN utility.  TXT lists (where the action code is separated from the destination with a single tab character) can be maintained using Notepad or a text editor.  Multiple lists can be specified for different purposes.

Action lists can be specified in a Job Administration instance UJP or FFBC template file, for use at launch time, or in FAXFACTS.CFG for use on all items at FS load time.  The UJP commands are documented as $action_phone and $action_email, and the similar CFG commands as $action_phone and $action_email.

Using Action Codes

Action codes for items matched in an action list are added to an FS file as a $var_def command with variable name ACTION_CODES.  The variable value is a semi-colon separated list of numeric action codes.  Action codes of three digits or less are reserved for system use.  Action codes of 1000 to 9999 are available for user applications.

Built-in System Action Codes

A number of built-in actions are available and planned.  The system action codes will appear in the ACTION_CODES variable with user action codes, if both are present, but the item will also be processed specially by the system.

Currently, the following built-in actions are available:

Max Baud Action

This action applies to both launch-time and transmit-time action codes.

101-114This action code forces a Max Baud value of  from 2400 to 33600 to be applied to fax attempts.  Subtract 100 from the code and multiply by 2400 to get the corresponding max baud value.  The value specified is overridden by a real MAX_BAUD or STEPDOWN_BAUD variable, but either the action or this variable overrides the $baud_max configuration command and the $baud_max user profile command.

Fax Consolidation

This action applies to both launch-time and transmit-time action codes.  It allows faxes to the same number to be consolidated and sent in a single call.  Faxes are processed as if for preview, without transmission but with fax headers applied, and the prepared TIF files are then saved in the CALLBACK\CONSOL folder.  The filename of the saved file is formed from the phone number and the original FS number.  The numeric part of the folder name indicates the intervals (in minutes) at which the folders are scanned and items for the same phone number are consolidated into a single FS file.  Files collected for consolidated transmission will be moved to CALLBACK\TEMP for transmission.

121-128These action codes correspond to the eight folders described in the consolidation topic.  For example fax numbers matched to action code 124 are consolidated every half-hour.

To operate Fax Consolidation, one or more instances of FFEXTERN must be running the Consolidation special process to scan the CS folders and create FS files.  The FFEXTERN special process will specify the User Profile which is to be used for the consolidated transmission.  If the consolidated transmission fails (after retries, if specified), all the individual FS files will be moved from SENT to FAIL with a single attempt record added (even if some of them have already been sent in a partially-complete transmission).  The outcome code will be 193.  If a consolidated transmission is retried, it will still have the same content, even if further items are by then awaiting transmission to the same number.

Self-Busy Checking

When matched against a phone number in a broadcast list, this (launch-time only) action inserts a variable definition in a job launch FS to override the self-busy setting in the COPIAFACTS Options/Options list.  The variable cannot be set using the Grouped Variables feature (see below) because it has to be processed from an FS file before the USR/UJP file is analyzed.

130Disable self-busy checking for matched numbers
131Enable self-busy checking for matched numbers

TLS Options

When matched against an e-mail address or domain, this action overrides the $email_options keywords controlling TLS (Transport Layer Security).

132Enable useTLS (use TLS if available) (and disable reqTLS)
133Enable reqTLS (require TLS)
134Disable both useTLS and reqTLS.


This action is only applicable for launch-time matched destinations and when it is an $action_email option.

181 - 200This action code causes an ADAPTER_INDEX variable with value of from 1 to 20 to be added in the launched FS file.

Variable Group Activation

This action is currently only applicable for transmit-time action codes.

201 - 230This action causes Variable Group 1 to 30 respectively to be activated for the call.  Only the lowest action code in this range is processed if more than one is present.  The presence of this action code suppresses the activation of a variable group using a phone mask.  The variable group to be activated is overridden by a variable group activated for a specific retry.

See the examples in the Action Codes and Variable Groups topic.

TOSEND queue override

For launch operations in FFBC and Job Admin, this action causes matched items to be launched into the nominated TOSEND queue.  When specified in a configuration file command, this action causes processing of the FS file to be suppressed when in any other than the specified queue, and instead the FS file is moved into the specified queue for processing. The following action codes are used:

301 - 399For Job Admin and FFBC launch operations, this action code causes a launch of the item into folder TOSEND1 to TOSEND99 respectively (currently lijmited to up to TOSEND15).  It overrides all other job priority specifications.  If the number exceeds the maximum defined TOSEND queue number (on the $request_dir command), it is ignored.  It is also ignored if FAST_TOSEND_SCAN is defined for the job, because this limits the JOBMON scan for end-of-job to the folder(s) defined as job priority.
When this action look-up is specified in FAXFACTS.CFG, for non-job items, this action code causes the loaded FS file to be moved to the specified TOSEND queue (if not already in that queue) instead of being processed immediately.

Take care when using this feature: if you launch or move the file to a TOSEND queue not configured for items of its type, it will never be processed at all.

TOSEND queues numbered above 15 are only available to licensees of the CopiaFacts Job Administration feature.

When combined with the Partial keyword on an $action_phone command, this feature could be used for example, to launch items with a specific country code into a special TOSEND folder for processing by a designated engine node.

See the examples in the Action Codes and TOSEND Queues topic.

Custom Action Codes

For user applications, you would normally reference the action code in a preprocess operation:

$if 1234 $in @ACTION_CODES



$if 2041 $in @ACTION_CODES



At preprocess time, the ACTION_CODES variable may contain both launch-time actions and actions added from a match to the CFG action list.  However only the former are written back to the FS file in SENT, FAIL or for retry.  If you require a CFG action code for later use in the processed FS file, you should assign it to another variable.