Equisys Technical Notes

Technical guidance, explanations and fixes for our products

FIX: Faxes received from certain FoIP Gateways fail to route because CSID, CLI and DID information is missing or contains unexpected characters

Print

ZTN1770

ID: ZTN1770

This Zetafax technical note applies to:

  • Zetafax v2009 SP1 with Platform Feature Pack
  • Zetafax v2010

Symptom

When receiving a fax through particular models of FOIP gateway, the CSID, CLI and DID information sent to Zetafax Server, i.e. the information used to route the fax, is either missing or contains unexpected prefixes and suffixes. As a result, the fax is not routed to the correct user.

Cause

When you receive the remote fax station’s CSID, CLI and DID, the FOIP Gateway provides the numbers along with other information that Zetafax Server does not recognise.  For example*:

  • TA:10.22.5.6:1720,TEL:000352335747,NAME:000352335747,000352335747
  • 02072034000@192.168.45.67
  • 4704;phone-context=cdp.udp

*In some cases, the above strings may only be visible in the device tracelog so will not appear in the Zetafax Server Monitor.  Please contact Equisys technical support for assistance with enabling the log.

Resolution

There is a patch available from Equisys Technical Support that resolves this issue.  The patch adds options to format the string so that unexpected characters are stripped from either the beginning or end.

The options can be used to modify the CLI, CSID or DID strings.  Each are given three options to strip the prefix and suffix.

Each of these can be added to the SETUP.INI file in the [Zetafax Server directory]/System/Z-DB/ folder.  These lines can go anywhere in the device paragraph for your FOIP device, e.g. the [BTB-G1] paragraph.

Note: only one of the three options can be used for each type of call strings.

DID
  • DIDPrefix: < prefix string to strip from the beginning of a DID>
  • DIDSuffix: < suffix string to strip from the beginning of a DID>
  • DIDIgnoreDigits: < number of numerical digits to strip from the beginning of a DID> or < character which marks where preceding string is stripped>
CLI
  • CLIPrefix: < prefix to strip from the beginning of a CLI>
  • CLISuffix: < suffix to strip from the beginning of a CLI>
  • CLIIgnoreDigits: < number of numerical digits to strip from the beginning of a CLI> or < character which marks where preceding string is stripped>
CSID
  • CSIDPrefix: < prefix to strip from the beginning of a CSID>
  • CSIDSuffix: < suffix to strip from the beginning of a CSID>
  • CSIDIgnoreDigits: < number of numerical digits to strip from the beginning of a CSID> or < character which marks where preceding string is stripped>

Examples of use

  1. The CLI is presented to Zetafax as the string “TEL:000352335747”. In order to strip the preceding string “TEL:” we can use either one of the following options in SETUP.INI:
  2. CLIPrefix: TEL:

    or

    CLIIgnoreDigits: 4

    or

    CLIIgnoreDigits: :

  3. The DID is presented as “4704;phone-context=cdp.udp” when “4704” is the only relevant information.  You can strip the suffix with the following command in SETUP.INI:
    DIDSuffix: ;phone-context=cdp.udp

Status

This behaviour was corrected as a patch available from Equisys Technical Support.

Last updated: 13th August 2010 (JW/LS/GR/MW)

Keywords: Device Controllers, FOIP, Routing

EquisysLogo

Recent news

This article describes the new features and other improvements in the August 2019 release of the Zetadocs Expenses service. Zetadocs Expenses ...

This article describes the new features and other improvements in the latest release of Zetafax. This improves support for using Fax over IP (FoIP) with SIP trunks and public SIP fax services, ...