Phone Lines icon GFI Support

Articles in this section

See more

Customizing the Caller ID and TSID Values of Outbound Faxes

Author: Abas Lazem Updated

Overview

 

When sending faxes, GFI FaxMaker sets the caller ID/Caller Line Identity Presentation (CLIP) to the sender's fax number configured in the Active Directory or GFI Directory. The Transmission Subscriber Identification (TSID) value is also set to the Local Fax ID specified in the fax line settings.

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 PABX 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.

 

Information

 

The goal of the steps outlined below is to change the From field information in the SIP header when using a FoIP device (Brooktrout SR140 or XCAPI), which is more related to the CLIP value rather than the TSID value. Although some may want to specifically configure the TSID value, configuring the CLIP value incorrectly can cause transmission errors. When viewing the CLIP value in Wireshark capture, you will usually encounter a 404 not found error, which may vary from phone system to phone system. All registry keys and values, including explanations, are listed below.

The scenarios below will overwrite the From field information listed in the XCAPI and SR140 configurations. Set the value of UseSenderFaxNumber to 0 if you want the From field to be static, and if you intend to overwrite what is listed in the SR140 or XCAPI configurations.

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

<Number>@<IP_Address:port number used>

Example:

123456789@10.10.10.10:5060

Scenario 1

Conditions

  • UseSenderFaxNumber is set to 1

  • The From field in SIP header contains the fax number: 123456789 (for example)

Output

The fax number value will be pulled from the directory service that is currently in use.

Scenario 2

Conditions

  • UseSenderFaxNumber is set to 0 and UseLocalIdForClipis set to 1

  • The From field in the SIP header will only contain the fax number: 123456789 (for example)

Output

The fax number value will be pulled from the Local fax ID field found in the Line options tab, which you can find in the FaxMaker Configuration's Lines and Devices Properties dialog box for the receiving line:

lineoptions.png

Scenario 3

Conditions

  • UseSenderFaxNumber is set to 1

  • AppendDomainToClip is set to 10.10.10.10:5060

Output

  • Using the same number, IP address, and port number from the previous scenarios, the From field in the SIP header will show:

    123456789@10.10.10.10:5060

  • The CLIP value will be the fax number pulled from the directory service. The @ sign and the domain will be appended at the end of the CLIP value.

 

Process

 

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:

    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.

 

back to list

 

Appending a Domain to the CLIP Value

Adding a custom domain to the CLIP value is sometimes required by certain FoIP systems.

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.

 

back to list

 

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.

  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.

 

 

back to top