Phone Do-Not-Send Checking

$dns_phone pathname|databasespec|FailAll [code] [phonetype] [EmptyOK] [WSDelim] [Partial]

This command is used in a Job Administration UJP file to specify a do-not-send look-up file for use at launch time for phone items (fax, voice, poll, SMS).  The command may also be placed in an FS Template file (.FST) for use in an FFBC launch.  Multiple commands may be supplied, 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.

The advantages of the launch-time do-not-send and white-list commands are described in the Configuration topic and an overview appears in Lauch-Time Do-Not-Send Checking.

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
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.
FailAllA keyword which indicates that all numbers are to be failed.  In this case only those numbers in a whitelist (if any) specified by a $whitelist_phone command will be used.  This keyword must be the first or only parameter on the command (code and phonetype may follow it).
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 in the same file 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 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 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 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 of System, Owner and Jobtype entries and in the reverse sequence to that in which they appear in each file.  The outcome code reported will be that of the file in which the item was first matched, if specified.  In an FEB2 broadcast type (two list columns) a matched item will be rejected even if fax transmission was specified to occur second.

Default:  No launch-time checking will be performed.


$dns_phone  @FFBASE\dnsphone.ndx 200

If you use the default global look-up file DNS.NDX on this command (rather than a custom look-up file) you should disable the transmit-time look-up in the same file.  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