Skip to main content

Automatic reply for FoIP Messages

Article # 3035016 - Page views: 44


Setting up auto reply for FoIP in 7 Steps


Step 1: Configure a NULL-TUM channel

  • Start the WCONFIG program with the command-line option –a
"C:\MT\78601\WCONFIG.EXE c:\mt\myinst –a"
  • Within the 'HW/SW assignment' select: 'NU NULL channel', the “slave” for this channel should be 1.0 (primary master)


Step 2: Change following configlines within the NULL TUM channel

Configline 2: R a new, unused channelgroup.
Configline 6: Autoreply channel FoIP omment within the line statistics.
Configline 24: 2 automatic distribution for sending copies.
Configline 41: 30330 Default termination for created sendorders.
Configline 42: NU:Automatic Reply Default originator for created sendorders.


Step 3: Create a Mask +MAIL5V/A+R 

  • Remove any leading ---A4--- lines within the mask
  • Select “No Cover” within the send options
  • The first 2 lines of the mask are fixed
  • Beginning with line 3 the text can be customized
  • The mask should contain the Mask variable $N1370$ anywhere after line 2
++FF $O1070$;
This is the Autoreply message for a FoIP message
The configurable text for the user is $N1470$


Step 4: Create a service that uses this mask 

  • The prefix of the service should point to the channelgroup of the NULL TUM channel configured in step 1
  • Mask +R (created in step 3.) and the B-Send-switch should be used
  • The Send switch advises the NULL TUM channel to create sending copy files:

Service Name: AUTOREPLY
Service Type: Free format
Description: Autoreply for FoIP messages
Abilities: Image, Text, restricted Text
Prefix: R:+RB;

Step 5: Create a distribution Directory +MAIL5V/AVV99 

  • The important entry within the VV99 file is the 2nd line
  • If there already is an existing +MAIL5V/AVV99, simply add the 2nd line to the existing VV99

++FF \;,\

Step 6: Create an IN Event for the user you're setting up the autoreply service for

  • The event can be auto-terminating or not, depending on the requirements of the customer

Number: Any free text which should be user specific, e.g. the username, fax number,…

Example for the User MM:
        Service: AUTOREPLY
        Number: Max Muster

Step 7: Extend the ARR99 for routing international numbers based on the TSI received


For example:
**ROUTE F:*43186353~,F:<I>~ F:*431~,F:~ F:*43~,F:0~ F:*~,F:00~

*** How does it work
  • An incoming FAX message triggers a sendorder to service FXI plus received DDI digits.
  • The originator of this inbound sendorder is of service FAX (configured in configline 42 of the FAX channel) plus the TSI of the sending machine, for example:
  • Originator of FAX Inbound sendorder: F:*43186353601
  • Then the normal FAX inbound routing is executed and the message is distributed to a user (based on the received sub-addressing digits).
  • If the FAX message reaches the inbox of the user (lets assume inbox of user MM), the configured INEVENT using service AUTOREPLY is activated.
  • The originator of this event sendorder is the user for whom the event was defined, appending the original originator (which is the service FAX plus the received TSI of the sending FAX machine), so for the example above:
  • Originator of the Event sendorder: MM :F:*43186353601
  • The recipient of this event sendorder is built according to the definition within the event, so when resolving the service prefix for the service AUTOREPLY, the recipient of the event sendorder will be:
  • Recipient of the Event sendorder: R :+RB;Max Muster
  • The channelgroup R is polled by the NULL TUM channel.
  • This sendorder is using the mask +R, where 2 mask variables are included:

$O1070$ will remove the MM : part from the originator (see above)
$N1470$ will remove the R :+RB; part from the recipient (see above)

  • So the message as it is received on the NULL TUM channel looks like:

++FF F:*43186353601                                             ;
This is the Autoreply message for a FoIP message
The configurable text for the user is Max Muster

  • Because of using the NULL TUM Send switch B, the NULL TUM channel will create a sending copy document, which looks exactly the same as the message shown above (the sending copy is an exact copy of the message as it is received on the NULL TUM channel). The filename of this sending copy document is '+MAIL5V/ATUxxxx'.
  • Because of configuring configline 24 of the NULL TUM channel to value 2, there will be automatic distribution of this generated sending copy document. This means that TCOSS will search the VV99 table for matching entries and will generate a sendorder if it finds a matching entry.
  • In our case, TCOSS will find a match on the 2nd line of the VV99 table. This 2nd line of the VV99 table uses a search string with variables.
  • In the VV99 entry these are marked with a backslash character:

++FF \;,\

  • So TCOSS searches through the content of the sending copy document to see if it finds a string that starts with "++FF " (do not forget the blank after ++FF) and ends with a semicolon character.
  • The string parts placed in between the “begin-” and “end-mark” is represented by the backslash character:

++FF \;.\
++FF F:*43186353601 ;

  • Similar as in the Arr99 the backslash character can be used on the right side of the VV99 entry where the sendorder for this match is defined.
  • The comma after the semicolon character is the separator between searchstring and sendorder definition, so in our case TCOSS will create a sendorder for the sending copy document that goes to:


which is in fact the originator of the original FAX inbound sendorder. The originator for this sending copy sendorder is taken from configline 42 of the NULL TUM channel. The termination of this sending copy sendorder is taken from configline 41 of the NULL TUM channel.

  • Recipient of sending copy sendorder: F:*43186353601
  • Because of the **ROUTE entries within the Arr99 file it is ensured that the “international” number format, as it is used within the TSI, is routed to a local number. In our case F:<I601>
  • Originator of sending copy sendorder:  NU:Automatic Reply
  • Message content of the sending copy sendorder:

++FF F:*43186353601                                                 ;
This is the Autoreply message for a FoIP message
The configurable text for the user is Max Muster

  • This is where an undocumented feature of the FAX module shows its face. The FAX module, which processes this sendorder, skips the ++FF line. This means that the message that's received on the FAX machine consists of only lines 3 and 4:

This is the Autoreply message for a FoIP message
The configurable text for the user is Max Muster


Note: There is a simillar solution which describes the same procedure for ISDN fax autoreply. The above mentioned solution for FoIP autoreply is a workaround because the "++HEADER" and "++BODY" mentioned in the other solution are not understood by FoIP. Therefore a SPR was created (SPR00090628). This has been fixed and will be implemented in KCS 9.2.

Level of Complexity 



Applies to  

Kofax Communication Server 9.x, 10.x      



Article # 3035016
  • Was this article helpful?