Phone Lines icon GFI Support Home

Articles in this section

See more

Customizing the CLIP and TSID Values of Outbound Faxes

Author: Stephen White Updated

Overview

When the CLIP (Calling Line Identity Presentation or caller ID)  and TSID (Transmitting Subscriber Identification T.30 fax value) values are altered in a FoIP (Fax over IP) setting, transmission errors can be experienced, such as an unknown error 3 or call failed 46, as the From field in the SIP transmission is changed.  The settings in this article can also alter the Caller ID for all outbound faxes. 

This article provides the steps on how administrators can make changes to the following default values:

 

Prerequisites

Before applying any changes, it is recommended to check how your PBX (Private Branch Exchange) and your telecommunications service provider handle custom CLIP and TSID values. Certain telephony systems or providers may override or block custom CLIP and TSID values.

Important: These customizations require changes to the Windows registry. Problems may occur if you modify the registry incorrectly. DO NOT modify the Windows registry unless you are confident with the values and subkeys you are editing. For added protection, back up the registry before you make modifications, which will allow you to restore the registry if problems occur.

 

Solution

When sending faxes, GFI FaxMaker sets the CLIP to the sender's fax number configured in the Active Directory or GFI Directory by default. The TSID value is also set to the Local Fax ID specified in the fax line settings. 

Generally, the From field in a SIP header needs to be in the following format: 

<Fax Number (DID)>@<IP_Address:port number used>

Example:

123456789@10.10.10.10:5060

The CLIP has the most effect on FoIP (Brooktrout SR140 or XCAPI) setups as this changes the From field in the SIP configuration.  The PBX usually has to authenticate the sender of a SIP transmission for security reasons.  Although this will vary from PBX to PBX, the DID (Direct Inward Dialing) portion of the From field is used to authenticate the sender to the PBX.  If this is changed then the sender cannot authenticate to the PBX and since that number cannot be found on the list to authenticate, the PBX will return a SIP 404 not found error and cause the fax transmission to fail.  

There are 3 registry settings we use to setup the CLIP, TSID or the From field.  

UseSenderFaxNumber - This DWORD changes the CLIP for outbound calls which changes the DID portion of the From field in a SIP message.    This setting has several options which are outlined in the steps listed below.   Default 1, setting not visible in the registry.  To change you would have to add the DWORD.  

UseLocalIdForClip - This DWORD allows or disables the use of the Local Fax ID in fax line settings to be used as the CLIP as well as the TSID.  Default 0, setting not visible in the registry.  To change you would have to add the DWORD.  

AppendDomainToClip-   This is a STRING value setting and allows alphanumeric entries.  This will add the @ sign as well as your entry in the registry as the domain portion of the From field in the SIP message.  There is no default setting and this is not visible in the registry by default.  To change you would have to add the String.  

 

Not altering the From field or CLIP

Not Changing the CLIP/DID portion of the SIP From field

If the PBX can only do DID authentication, the we must ensure FaxMaker doesn't change the From field in the SIP message by ensuring the CLIP value of the outbound faxes does not change. 

  1. Open the Registry Editor on the GFI FaxMaker server.

  2. Navigate to the following folder:

    32-bit HKEY_LOCAL_MACHINE\SOFTWARE\GFI Fax & Voice\FAXmaker\Config
    64-bit HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\GFI Fax & Voice\FAXmaker\Config

  3. Create a DWORD value with the name: UseSenderFaxNumber.

  4. Change the value of the newly-created UseSenderFaxNumber registry key to 0

  5. Close the Registry Editor.

  6. Restart the Fax Server service from the Services.msc to apply changes.

 

Altering the From field or CLIP

Setting the CLIP's/TSID's Value to a Sender's Fax Number

To change the CLIP or TSID values of outbound faxes to the sender's fax number configured in the Active Directory:

  1. Open the Registry Editor on the GFI FaxMaker server.

  2. Navigate to the following folder:

    32-bit HKEY_LOCAL_MACHINE\SOFTWARE\GFI Fax & Voice\FAXmaker\Config
    64-bit HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\GFI Fax & Voice\FAXmaker\Config

  3. Create a DWORD value with the name: UseSenderFaxNumber.

  4. Change the value of the newly-created UseSenderFaxNumber DWORD to one of the below values:

    DWORD Value Description

    0
    CLIP Not set
    TSID Local Fax ID configured in the fax line settings screen

    1
    CLIP Sender's fax number configured in the Active Directory or GFI Directory
    TSID Local Fax ID as configured in the fax line settings screen

    Note: The configuration above will be the default configuration if the UseSenderFaxNumber key has not been set.

    2
    CLIP Not set
    TSID Sender's fax number configured in the Active Directory or GFI Directory

    3
    CLIP Sender's fax number configured in the Active Directory or GFI Directory
    TSID Sender's fax number configured in the Active Directory or GFI Directory

    6
    CLIP Not set
    TSID Sender's fax number configured in the Active Directory or GFI Directory (without any spaces)

    7
    CLIP Sender's fax number configured in Active Directory or GFI Directory (without any spaces)
    TSID Sender's fax number configured in Active Directory or GFI Directory (without any spaces)

    Note: If the fax number has not been in the Active Directory or GFI Directory when using  options 2, 3, 6 or 7, the TSID value will be set to the Local Fax ID as configured in the fax line settings screen.

  5. Close the Registry Editor.

  6. Restart the Fax Server service from the Services applet to apply the changes.

  

Appending a Domain to the CLIP Value

Adding a custom domain to the CLIP value is sometimes required by certain FoIP systems.  The PBX may accept different CLIP values, but when FaxMaker overwrites the CLIP value it overwrites the whole From field.  Appending the domain will complete the From field and allow the use of different CLIP values from different users. 

To append a custom domain name to the CLIP value of outbound faxes: 

  1. Open the Registry Editor on the GFI FaxMaker server.

  2. Navigate to the following folder:

    32-bit HKEY_LOCAL_MACHINE\SOFTWARE\GFI Fax & Voice\FAXmaker\Config
    64-bit HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\GFI Fax & Voice\FAXmaker\Config

  3. Create a STRING value with the name: AppendDomainToClip.

  4. Change the value of the newly-created AppendDomainToClip registry key to the domain that needs to be appended with outbound fax CLIP numbers. 

    Example: If the value of the AppendDomainToClip key is set to example.com, the CLIP value of outbound faxes will be 123456@example.com. GFI FaxMaker will automatically add the @ symbol.

  5. Close the Registry Editor.

  6. Restart the Fax Server service from the Services applet to apply changes.

  

Setting the CLIP's Value to the Local Fax Line ID

To change the CLIP values of outbound faxes to the Local Fax ID as configured in the fax line settings screen:

Important: If theUseSenderFaxNumber key has been configured,  the UseLocalIdForClip key will be ignored, since the UseSenderFaxNumber key takes precedence.  If using this process, the UseSenderFaxNumber should be set to 0.

  1. Open the Registry Editor on the GFI FaxMaker server.

  2. Navigate to the following folder:

    32-bit HKEY_LOCAL_MACHINE\SOFTWARE\GFI Fax & Voice\FAXmaker\Config
    64-bit HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\GFI Fax & Voice\FAXmaker\Config

  3. Create a DWORD value with the name: UseLocalIdForClip.

  4. Change the value of the DWORD you have just created to:

    DWORD Value Description
    0 (Default) This value is the default configuration, where the CLIP value is set to the sender's fax number as configured in the Active Directory or GFI Directory.
    1 Setting the DWORD's value to 1 will change the CLIP value to the Local Fax ID as configured in the fax line settings screen.

  5. Close the Registry Editor.

  6. Restart the Fax Server service from the Services applet to apply the changes.

Make sure you have set the Local Fax ID field in the line properties, as described in the Fax Over IP Outbound Fax Failures article.

 

 

Confirmation

Once you have set the configuration as it is required by your environment, test to ensure the correct CLIP, TSID or From field is being transmitted.  You can verify this in the FaxMaker faxserver log.  To verify the information, follow the steps below:

  1. On the Faxmaker server, navigate to the following location: C:\Program Files (x86)\GFI\FaxMaker\logs.  This is the default logging location in the FaxMaker installation directory.  

  2. Locate the faxserver.gfi_log.txt file and open it in a text editor.

  3. Search for the terms setting CLIP and setting TSID.

  4. Your results should return like in the screenshot below.

    cliptsid.PNG

  5. Confirm the output is what was set previously in the article's steps above.  

  6. If the output is correct, verify with the carrier that these settings are not being overwritten by their settings.  This is usually the issue if the output in the faxserver log is correct.

Related articles