Phone Special Action Specification

$action_phone pathname|databasespec [code] [phonetype] [EmptyOK] [WSDelim] [Partial]

This command is used to specify a list file which is loaded at launch time, to specify special actions to be performed for specific phone numbers.  The command may also be placed in an FS Template file (.FST) for use in an FFBC launch.  Multiple commands may be supplied to arrange for different types of action, and commands from System, Owner and Jobtype UJP files migrate to the job instance properties in the usual way.

The same pathname should only be used once in a set of lookup files.

For more information, see Destination-Specific Processing.

The parameters on this command are used as follows:

pathnameThe pathname of the look-up file to be used.  Currently supported file extensions are:
.NDXa character-mode index file created and maintained by the PIN utility.
.TXTa list of entries to be matched
databasespecThe components of the database specifier are separated by the vertical bar symbol (|) and are described in more detail in the description of the do-not-send feature.
Database NameThe full pathname of a supported database, or a DSN source
Table NameThe name of the table to use (default table name: DNS)
Key Field NameThe name of the key field to use (default key field RECIPIENT)
Timeout ValueTimeout for look-up (defaults to ADO default value)
Data Field NameThe name of the data field to use from the matched entry.
codeA code which will be used as the default numeric action code for matched items. If not supplied, only the action code from the list will be returned.
phonetypeOne of the keywords fax, phone, poll or sms to indicate the type of phone numbers for which this file is to be used.  If no keywords are given, the file is used for all types of broadcast involving a telephone number.
EmptyOKA keyword which indicates that the index/list may be empty.  This suppresses the check that ensures that at least one entry has been loaded from the file. Failure to load any entries could be a symptom of a corrupted file.
PartialA keyword which indicates that a partial match is allowed in addition to an exact match.  Specifically, a match is also recorded if the item in the index is shorter than, and an initial substring of, the item to be tested.  This parameter is ignored if databasespec is used
WSDelimA keyword which indicates that any number of white spaces may separate the phone number and the DNS_DATA code in a loaded TXT list.  If you use this parameter, phone numbers in the list should of course not have embedded blank space.

The following processing is done on numbers to be matched:

if the value starts with sip: then the check is carried out on the portion following this string and preceding any @, if present.

in the NANP area, either two look-up operations are done on NANP numbers (with and without the leading 1 digit) or if the look-up index is known to contain only numbers with a leading 1 digit, the number looked up is forced to this format. Otherwise, non-numeric characters are removed and the numbers are then matched as entered.

The NDX file may contain a positive numeric data value for each entry, the TXT file may contain a positive numeric data value separated from the phone number entry by a single TAB character (or any whitespace, if WSDelim is used), and the database data field may also contain a numeric value.  If present, this will override the default numeric action code.

The action codes from the list(s) in which the item is matched will be returned, separated by semi-colons, in the ACTION_CODES variable in the FS file.  Action codes less than 1000 are reserved for system use, and it is recommended that only 4-digit codes are used for user applications.


A phone number matched in two lists might acquire a variable definition in the FS as follows:

$var_def ACTION_CODES "1234;2041"

The pre-process commands used to perform the appropriate actions would then be:

$if 1234 $in @ACTION_CODES



$if 2041 $in @ACTION_CODES



See also Action Codes and Variable Groups.