Phone Do-Not-Send Checking

$dns_phone pathname [code] [phonetype] [EmptyOK] [WSDelim] [Partial]

This command is used to specify a global do-not-send look-up file which is pre-loaded by the COPIAFACTS engine.  If you include this command in your FAXFACTS.CFG file, the use of the legacy file DNS.NDX will be suppressed, but a legacy file named on a DNS_PATH configuration file variable will still be used, with a warning message on startup.

Job Administration users should not normally use this command: instead use $dns_phone commands in SYSTEM.UJP to perform global do-not-send checking at launch time.

Multiple commands may be supplied.  The advantages of pre-loading the do-not-send lists are described in the Configuration topic.

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- or numeric-mode index file created and maintained by the PIN utility.
.TXTa list of entries to be matched
The timestamp of the file will be checked each time a fresh scan of the TOSEND folders is started (typically every 20 seconds) and the file will be reloaded if it has changed.
codeA code which will be used to override the default failure outcome code for matched items. The default value is 188. The code range 200-249 is suggested for custom outcome codes. If you use the override outcome code on the command, failed items will NOT be protected from accidental transmission if you ignore the warning and enter 'Z' on the JOBADMIN Resubmit Fail dialog.
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.

Items matched in a $whitelist_phone specification at launch time (in Job Administration or by FFBC) will not be checked.

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 base phone, fax, or voice number in the FS file is the number that is always matched against the list, before any $phone_mask processing has been performed on it.

The NDX file may contain a positive numeric data value for each entry, and the TXT file may contain a positive numeric data value separated from the phone number by a single TAB character (or white space, if WSDelim is used).  If present and greater than one the value will be saved as the value of a variable named DNS_DATA in the launched FS file.

When multiple commands are specified, items will be checked in the order in which they appear in the file.  The outcome code reported will be that of the file in which the item was first matched, if specified.

Default:  No transmit-time checking, or only legacy checking will be performed.


$dns_phone  @FFBASE\dnsphone.ndx 200