Specify MSMQ name for writing notifications

$notify_qname node qname [maxttr]

This command specifies the name of a private MSMQ queue to which messages will be written as each outbound fax or e-mail is sent, failed or attempted and rescheduled, or when an inbound fax is received. There is also an option to write messages from FFVIEWER as the received fax is manually routed.

The parameters on this command are used as follows:

node the nodename of the machine which is to use this queue, or * for all nodes.
qname the name of an existing private queue to which this node has permission to write.
maxttr the maximum time to receive in hours. If omitted, the message will not expire.

The content of messages is specified using the NQL_... control variables (for the message label) and NQM_... (for the message body).  If the appropriate NQL message content is empty, no message is written.  If there is a syntax error in the FS file it may not be possible to determine whether it is a fax or e-mail transaction.  In this case these 'fax' variant of the message specification variables will be used.

The message IDs for the various messages are allocated as follows:

1fax complete
2voice complete
4email complete
8SMS complete (submitted)
17fax scheduled for retry
18voice scheduled for retry
20email scheduled for retry
24SMS scheduled for retry
256fax received

There are also special NQOK... variables to which a value of OK is written if the message was successfully written to the queue.  Because the message is generated right at the end of the call, the only place where these variables can be tested is in a user-supplied call-control DLL in the FFCallClose function.

When using this command we recommend that you add a $system_dlls command with a keyword msmq to ensure that CF8MSMQ.DLL and the Windows MQRT.DLL are loaded.


$notify_qname * MNAME\private$\copia_notify 168 ; keep messages 1 week