Kofax Communication Server 10.3.0 Technical Manual

Brand: Kofax

Model: Communication Server 10.3.0

Type: Technical Manual

Kofax Communication Server

Fax over IP Technical Manual

Version: 10.3.0

Date: 2019-12-13

Kofax is a trademark of Kofax, Inc., registered in the U.S. and/or other countries. All other trademarks

are the property of their respective owners. No part of this publication may be reproduced, stored, or

transmitted in any form without the prior written permission of Kofax.

Table of Contents

Preface...........................................................................................................................................................7

Related Documentation................................................................................................................................. 8

Chapter 1: Introduction.............................................................................................................................. 9

Voice and Fax over IP....................................................................................................................... 9

Kofax Solution.....................................................................................................................................9

Use Cases........................................................................................................................................ 10

Installation with Kofax Communication Server......................................................................10

Standalone Configuration...................................................................................................... 11

International Standards and Recommendations.............................................................................. 11

IP Infrastructure Requirements..............................................................................................11

Compatibility...........................................................................................................................12

Unicode Support.................................................................................................................... 12

Chapter 2: Installation.............................................................................................................................. 13

Prerequisites..................................................................................................................................... 13

Setup.................................................................................................................................................15

Personal Firewall Settings..................................................................................................... 18

Standalone Installer (FoIP.msi)........................................................................................................ 19

Uninstalling KCS FoIP........................................................................................................... 20

Reboot Warning When Upgrading FoIP on Windows Server 2008...................................... 20

Upgrade from Older Releases......................................................................................................... 21

Upgrade from KCS FoIP 3.11.xx – 3.18.xx (KCS 9.0 – 9.2).................................................21

Upgrade from KCS FoIP 3.06.xx (KCS 8.2)......................................................................... 21

Basic Configuration...........................................................................................................................21

General...................................................................................................................................22

List of Call Peers................................................................................................................... 22

Advanced Configuration................................................................................................................... 23

VoIP/FoIP Network.................................................................................................................23

Voice.......................................................................................................................................26

Fax......................................................................................................................................... 27

H.323 Signaling......................................................................................................................28

SIP Signaling......................................................................................................................... 29

SSL Certificate....................................................................................................................... 31

HTTP...................................................................................................................................... 32

KCS Integration......................................................................................................................33

Kofax Communication Server Fax over IP Technical Manual

Storage Settings.................................................................................................................... 34

Advanced............................................................................................................................... 34

Saving Configuration........................................................................................................................ 36

Running FoIP in a Console Mode................................................................................................... 37

Policy-based Quality of Service....................................................................................................... 38

Chapter 3: Web Portal.............................................................................................................................. 44

Call Peer Statistics........................................................................................................................... 45

Send Fax via Storage...................................................................................................................... 46

Sending in Loop-Back Mode................................................................................................. 47

Fax Header Line.................................................................................................................... 48

Fax Storage...................................................................................................................................... 49

Maintaining Fax Storage........................................................................................................49

Inbound Messages.................................................................................................................50

Outbound Messages..............................................................................................................51

Chapter 4: Integration with KCS............................................................................................................. 53

Installation of Fax for KCS...............................................................................................................53

Step 1: Set Up TCOSS Server for FoIP............................................................................... 53

Step 2: Set Up FoIP..............................................................................................................54

Step 3: Verify Installation.......................................................................................................54

Step 4: Set Up Call Peers.................................................................................................... 55

Installation of Message Wait for KCS.............................................................................................. 55

Step 1: Configure KCS FoIP................................................................................................. 56

Step 2: Configure CallManager and Test Message Waiting................................................. 56

Step 3: Create Services and Events in TCfW...................................................................... 56

Message Wait via SIP Notify (RFC 3842).............................................................................57

Installation of Voice for KCS............................................................................................................ 57

Install Voice Server................................................................................................................57

Configure Voice Support in FoIP...........................................................................................59

Enable Voice in the UFI Channels........................................................................................59

Test the First Incoming Voice Call........................................................................................ 60

Leave a Messages via Telephone.........................................................................................60

Test Outgoing Voice Call with TC/Player.............................................................................. 60

Unique Single Number Support............................................................................................ 61

Hints....................................................................................................................................... 62

Supplementary Services...................................................................................................................62

Call Diversion (Redirecting Number).....................................................................................62

DTMF Reception....................................................................................................................64

DTMF Generator for Two-Stage Outbound Dialing...............................................................64

Kofax Communication Server Fax over IP Technical Manual

Call Transfer.......................................................................................................................... 65

Configuration Hints........................................................................................................................... 65

Setting Own Calling Party Number....................................................................................... 65

Fax on Demand..................................................................................................................... 66

High Availability Support........................................................................................................66

SIP Registrar and H.323 Gatekeeper................................................................................... 73

Behavior If an Incoming Call Is Rejected..............................................................................74

FoIP and Internet Telephony Service Providers....................................................................74

V.34 Fax.................................................................................................................................75

Support Variable Gateway IP for Outgoing Calls.................................................................. 76

Support of Static NAT............................................................................................................77

Endpoint Name...................................................................................................................... 78

T.38 vs. G.711 Pass Through Fax........................................................................................ 78

T.38 Redundancy................................................................................................................... 79

Encryption of VoIP/FoIP Network Traffic...............................................................................80

Voice Prompts........................................................................................................................87

Multiple FoIP Instances......................................................................................................... 88

Configuration Values.........................................................................................................................88

UFI Channel Configuration.................................................................................................... 88

Description of UFI Specific Configuration Lines....................................................................92

Tracing Possibilities in FoIP.................................................................................................. 93

Log Entry Filtering................................................................................................................. 95

Chapter 5: Migration to KCS FoIP...........................................................................................................97

Migration from KCS Line Server Model 305....................................................................................97

Migration of FoIPv2 (XCAPI)............................................................................................................98

Migrate TCOSS 7.80.04 with XCAPI 3.03.36 (H.323) to FoIPv3.......................................... 98

Roll Back from FoIPv3 to XCAPI.......................................................................................... 98

Feature Comparison of FoIPv2 and FoIPv3......................................................................... 99

Migration of Message Wait via H.323..............................................................................................99

Step 1 – Configure KCS FoIP...............................................................................................99

Step 2 – Verify New Message Waiting Indication Functionality.......................................... 100

Step 3 – Change the Prefix of Message Waiting Services................................................. 100

Step 4 – Update Arr99 File................................................................................................. 101

Step 5 – Disable Old Message Waiting.............................................................................. 101

Migration of H.323 Voice Engine................................................................................................... 101

Step 1 – Reinstall KCS Server Package............................................................................ 102

Step 2 – Update Registry....................................................................................................103

Step 3 – Configure KCS FoIP.............................................................................................104

Kofax Communication Server Fax over IP Technical Manual

Hints..................................................................................................................................... 104

Feature Comparison............................................................................................................ 104

Chapter 6: Administration...................................................................................................................... 105

Errors Codes in TCfW....................................................................................................................105

Two-Character TCOSS Error Codes................................................................................... 105

Additional Error Details........................................................................................................107

Error Codes in FoIP....................................................................................................................... 107

Error Categories...................................................................................................................107

Error Codes..........................................................................................................................109

Connection Level................................................................................................................. 117

Event Log Entries........................................................................................................................... 118

Chapter 7: Development Tools.............................................................................................................. 119

Send Fax in Real Time.................................................................................................................. 119

T.38 Player......................................................................................................................................120

Prepare the T.38 Fax Stream to Replay............................................................................. 121

Initiating a Call..................................................................................................................... 122

Showing Current State of the Call...................................................................................... 123

Interrupting a Call................................................................................................................ 124

Fax Replay Limitations........................................................................................................ 125

T.38 PCAP Converter..................................................................................................................... 125

Test Server......................................................................................................................................126

Chapter 8: Web Service Functions....................................................................................................... 127

Chapter 9: Specifications....................................................................................................................... 128

Supported TIFF Options.................................................................................................................128

How to Create a TIFF File for Faxing............................................................................................128

Microsoft Office Document Image Writer............................................................................ 129

KCS Printer Driver............................................................................................................... 129

TCIMG32..............................................................................................................................130

Chapter 10: Acknowledgments..............................................................................................................131

Preface

This document describes Kofax Communication Server Fax over IP (FOIP) solution (Using IP Call Control:

V3.03). It is mainly intended for system administrators responsible for installing and configuring FoIP and

VoIP in their environment.

Related Documentation

This document refers to the following documentation:

• Environment Guide - Platform System Manual

• Line Server Model 305

• PBX documentation (PBX Integration Technical Manual and PBX Requirements Technical Manual)

• TCOSS Application Module Manual

• TCOSS Configuration Manual

• TCOSS System Manual

• TC/FoIP Tracing Technical Manual

• Voice Server documentation (Voice Platform Technical Manual, Voice xSP Integration Technical

Manual)

• VoIP / FoIP Environment Guide

The full documentation set for Kofax Communication Server is available at the following location:

https://docshield.kofax.com/Portal/Products/en_US/KCS/10.3.0-SihMvq5oti/KCS.htm

Chapter 1

Introduction

This chapter describes fax and voice over IP solutions in general, the architecture and use cases of Kofax

Communication Server Fax over IP and international standards and recommendation.

Voice and Fax over IP

Since 1990s, Voice over IP (VoIP) solutions have gradually been replacing traditional telephony. VoIP

networks share the infrastructure that already exists for data communication. If a company has multiple

locations, data connections between these locations can be used for internal telephone calls. Establishing

and maintaining a WAN infrastructure between the different locations may produce lower costs than

paying a telephony network provider for every call.

In 1998 ITU released the T.38 recommendation dealing with the transmission of faxes over IP networks

in real time. This standard guarantees interoperability between fax over IP terminals. T.38-compatible

gateways are used to adopt the T.38 protocol to PSTN (typically via ISDN) so that communication with

conventional Group 3 fax machines in the public PSTN is possible. Today, T.38 is an industry standard

which is supported even by low cost VoIP gateways.

Fax transmission is also possible over VoIP networks using the so called G.711 pass through mode. This

kind of operation does not require T.38 support by the IP environment but it is much more sensitive for

network jitter, packet loss and clock synchronization problems.

Kofax Solution

The fax over IP solution communicate with the H.323 or SIP network. It supports FoIP using T.38

recommendation, FoIP G.711 pass through mode and VoIP.

Kofax Communication Server Fax over IP is composed of the following components:

• FoIP core

• Web interface: Allows to monitor the status and send/receive test faxes

• Call peers: Responsible for communicating with T.38 compatible devices

• TCOSS connection: Responsible for connection with TCOSS; distinguishes between voice and fax

• Voice connection: Responsible for connection to the Voice Server

• Fax storage: Acts as an inbox and outbox for faxes when TCOSS is not used

Kofax Communication Server Fax over IP Technical Manual

The switch in the FoIP Core (see Basic Configuration) allows to set up the destination of incoming faxes.

Incoming faxes can either be received into TCOSS or into internal fax storage of FoIP (see also the next

section on Use Cases). Incoming voice calls are supported via TCOSS connection only.

Use Cases

Kofax Communication Server Fax over IP was designed for two main scenarios:

• Installation with Kofax Communication Server

• Standalone configuration

Installation with Kofax Communication Server

FoIP can be configured to receive incoming faxes directly into Communication Server (TCOSS). In this

scenario, FoIP can be used as a full-featured replacement of existing fax over IP solutions for TCOSS.

The scenario with TCOSS involves at least three of the five FoIP components: TCOSS connection, FoIP

core, and connection to call peers, such as a FoIP gateway. Outgoing messages from TCOSS are sent

in real time (without storage) to their intended recipient. Similarly, incoming messages are delivered to

TCOSS.

Kofax Communication Server Fax over IP Technical Manual

Because the messages are stored in TCOSS, the FoIP internal fax storage is not used in this scenario.

The web interface is an optional component as well; it can be used to monitor the status of the solution

and for troubleshooting.

FoIP can also be configured to transfer voice messages to the Kofax Voice Server. In this scenario, an

additional component is required, the Voice connection.

Standalone Configuration

Owing to its modular architecture, for fax communication, FoIPv3 can also be used without TCOSS.

Incoming faxes are stored in its internal fax storage. Outgoing faxes are queued in the fax storage and

sent out. Faxes can be managed by the web interface monitoring tool.

Additionally, FoIP can provide fax functionality to other applications, such as Kofax Capture or Avalin

products. These applications can use Web Services to send and receive faxes via FoIP. This configuration

is recommendable for testing, troubleshooting or demonstrations, however, it is not supported for

productive use.

International Standards and Recommendations

Fax over IP is compliant to the following standards and recommendations:

• T.38: ITU-T recommendation on real time fax transmission over IP networks (Versions 0, 1, 2 and 3)

• T.30: ITU-T recommendation on faxes

• SIP: Session Initiation Protocol defined in RFC 3261 by IETF (UDP, TCP and TLS transports are

supported)

• SIP Call Transfer: The Session Initiation Protocol Refer Method defined in RFC 3515 by IETF

• H.323: ITU-T recommendation defining protocols for audiovisual communication in packet networks

• DTMF via H.245 (alphanumeric and signal) and RFC 2833 (RTP-NTE)

• Various call diversion standards; see Call Diversion (Redirecting Number).

IP Infrastructure Requirements

This section defines the generic requirements to an VoIP/FoIP environment in order to support basic

functionality with KCS FoIP. More detailed information about compatibility, configuration and hints with

various different systems can be found in the VoIP / FoIP Environment Guide.

• The IP system must support either H.323 or SIP signaling.

• When using H.323, one of the following connection options must be supported:

• Integration as H.323 trunk like a standard gateway

• Integration via H.323 gatekeeper as terminal

• Integration via H.323 gatekeeper as gateway

• When using SIP, one of the following connection options must be supported:

• Integration as SIP gateways with optional UserId/Password authentication

• Integration via SIP registrar with optional UserId/Password authentication

• The IP system must support VoIP using G.711 (A-law or u-law)

Kofax Communication Server Fax over IP Technical Manual

The following additional requirements are needed for fax support via T.38 only.

• T.38 Version 0 (according to T.38 1998 ASN.1). According to the standard, version 0 must be supported

by all T.38 compliant devices.

• The mode changes from Voice to T.38 must be signaled using H.323/SIP message (protocol based

switch-over). Proprietary methods like NSE-based switch-over (may be used by gateways connected

via SCCP protocol to an IP environment) are not supported.

Compatibility

FoIP is compatible with the following third-party products.

VoIP/FoIP Gateways

• Cisco 2600 and 2800 series*

• Innovaphone

• Audiocodes

• Patton

• Vegastream

• Mediatrix

Software PABX

• Cisco Call Manager 4*

• Cisco Unified Communication Manager 6*

• Cisco Unified Communication Manager 9

• Siemens HiPath 4000 V4 (H.323 and SIP)

• Siemens OpenScape Voice (former known as HiPath 8000)

• Asterisk

Internet Telephone Service Provider

• Sipcall (www.sipcall.com)

*For configuration, refer to the VoIP / FoIP Environment Guide.

Unicode Support

Unicode is supported for fax over IP. It is not supported for voice (for example, text-to-speech engines).

Chapter 2

Installation

This chapter describes the installation procedure as well as general configuration.

Prerequisites

This section provides the prerequisites for a standard installation. The actual requirements may be

reduced (for example, if optional components are disabled or the size of storage/trace file is reduced).

• Operating System: Any currently supported Operating System. For more details about supported

operating systems, refer to the Environment Guide - Platform System Manual.

• Minimum free disk space: 100 MByte

• Minimum available memory: 50 MByte + 4 MByte for each used TCOSS channel

• Available network bandwidth between FoIP and gateway per channel:

• Minimum 100 kb/s during call establishment and in voice mode (before switching to T.38 mode)

• Minimum 30 kb/s during transmission of T.38 data (V.17 w/o T.38 redundancy). See T.38

Redundancy for details

• Network turnaround trip time between FoIP and gateway:

• Maximum 2 seconds turnaround trip time (Fax)

• Maximum 400ms turnaround trip time (Voice)

• Network jitter between FoIP and gateway:

• Maximum 400ms jitter for T.38 fax

• Maximum 30ms jitter for G.711 pass through fax

• Maximum. 60ms jitter for voice mode

Additional prerequisites if FoIP is used with Kofax Communication Server (TCOSS)

• TCOSS 7.80.04 or higher

• Network bandwidth between FoIP and TCOSS 7:

• Minimum 30 kb/s available bandwidth per channel

• The average packet turnaround time with 260 byte block size must be:

• less than 400ms for up to 4 channels

• less than 200ms for up to 30 channels

• less than 80ms for up to 60 channels

• less than 20ms for up to 180 channels

• Single interruptions are tolerated up to 2000 ms. Longer interruptions may lead to a break in the

current transmission. If the network is interrupted for more than 9 seconds, the KCS system may

Kofax Communication Server Fax over IP Technical Manual

restart the KCS FoIP. Note that this 9s time-out may be increased as described in the TCOSS

Configuration manual chapter “Network interruptions to LS1 and FoIP”.

• The numbers above describes the network requirements for channels with up the 14.400 bps (V.17). A

V.34 (were up to 33.600 bps are used) channels has the same requirement as two V.17 channels.

• Up to 180 channels (V.17 or V.34) are supported on a single physical computer when using T.38 Fax.

Up to 120 channels (V.17 or V.34) are supported on a single virtual machine when using T.38 Fax. Up

to 120 G.711 passthrough mode channels are supported on physical or virtual machines.

• The following CPU resources must be available.

FoIP usage [SPECInt_Rate_Base2006] per channelChannel type

Physical machine Virtual machine

T.34 fax channels with V.17 mode 1.0 1.0

T.34 fax channels with V.34 mode 1.5 1.5

G.711 pass through mode 2.0 2.5

Voice channel 1.5 1.5

1. CPU performance results for many systems are published at www.spec.org. Start search at http://

www.spec.org/cgi-bin/osgresults?conf=cpu2006 and use the SPECInt_rate_base2006 value from

a system that is similar to your hardware.

2. The maximum number of channels can be calculated with the following formula:

(CpuPerformance - ReservedForOtherProcesses)

MaxChannels=----------------------------------------------

FoipUsagePerChannel

Here are some typical example values.

Maximum number of channels

Hardware Deployment

T.38 (V.17) G.711

HP ProLiant ML350 G5 (1x X5355 Quad

core, 2.66 GHz, SCPECInt_rate_base2006

= 44)

Physical machine 30 15

HP ProLiant DL380G5 (2*X5420 Quad

core, 2 GHz, SCPECInt_rate_base2006 =

80)

Physical machine 60 30

Virtual machine (1/12 cores) 30 10

Virtual machine (2/12 cores) 60 20

Virtual machine (4/12 cores) 120 40

Virtual machine (8/12 cores) 180

Virtual machine (12/12 cores) 180

120

HP Proliant DL380G8 (2*Xeon E5-2640 6-

core, 2.5GHz, SCPECInt_rate_base2006 =

445)

Physical machine 180

120

1. The maximum number are channels are rounded under the assumption that up to 20% from total

available CPU may be consumed by other high priority processes on the same virtual/physical

machine.

Kofax Communication Server Fax over IP Technical Manual

2. On virtual machines this column also indicates the number of assigned CPU cores.

3. Maximum number of channels is additionally restricted by 120/180 channel limit as described above.

• The operation with G.711 pass-through mode is real-time critical. In case of insufficient CPU

performance you may receive send/reception errors with TCOSS error code JO, error category

BAD_LOCAL_PERF (LPERF).

• The support of G.711 pass-through channels on virtual machines critical due to real-time requirements.

VoIP gateways generate a signal dropout on jitter buffer overrun/underrun. Such a dropout may

interrupt the fax call (RTP packet generation must not be deferred more than about 50ms). At least

2 cores should be reserved for optimum quality. Refer to the Environment Guide - Platform System

Manual for further details.

Additional prerequisites if FoIP is used for voice with Kofax Communication Server (TCECP)

• TC/SP 7.86.00 or higher

• Network bandwidth between FoIP and TCECP server per channel:

• Minimum 150 kbps available bandwidth

• Maximum 0.5 seconds turnaround trip time

• Up to 30 concurrent voice calls are supported with a single FoIPv3 application.

Setup

KCS FoIP is installed as a part of KCS server package.

If you had previously installed the standalone variant of KCS FoIP (using FoIP.msi), you have to uninstall

this application. See Standalone Installer (FoIP.msi) for more information about the standalone installer.

If you decide to preserve existing configuration when uninstalling the standalone variant, you can later

import this configuration into FoIP included in server package.

Kofax Communication Server Fax over IP Technical Manual

1. Start the setup by launching SETUP.exe. From the Fax over IP (Group), select FoIP.

Kofax Communication Server Fax over IP Technical Manual

If you have previously used the standalone variant of FoIP on the same computer, and if you opted to

preserve its configuration, you can now import it.

Kofax Communication Server Fax over IP Technical Manual

2. Enter TCSRV settings and click OK.

KCS FoIP is installed into the C:\TOPCALL\FOIP\00\ directory.

After the installation, KCS FoIP configuration opens. See Basic Configuration and Advanced

Configuration.

The following new shortcut is added into the start menu:

Personal Firewall Settings

If you are using a personal firewall on your machine, you may get a warning as shown in the following

figure.

Kofax Communication Server Fax over IP Technical Manual

Either disable the personal firewall or click Unblock to allow the Merlin Process to access network.

Note Merlin Process is the framework used by FoIP.

Standalone Installer (FoIP.msi)

Before KCS 9.0, KCS FoIP was delivered as a standalone installer, FoIP.msi. This section lists the

differences to standard installation.

The default installation directory is C:\Program Files\Kofax\Fax Connector\FoIP\.

After a successful installation, the following new shortcuts are added into the start menu.

Kofax Communication Server Fax over IP Technical Manual

Start Menu shortcuts

Shortcut Target of the shortcut Description

KCS FoIP Configuration

Utility

C:\Program Files\Kofax\Fax Connector

\FoIP\00\Configure.bat

See Basic Configuration.

KCS FoIP Status Monitor http://localhost:25081 See Web Portal.

KCS FoIP Trace Directory C:\Program Files\Kofax\Fax Connector

\FoIP\00\trace

Useful for troubleshooting.

Uninstalling KCS FoIP

1. Do one of the following to uninstall the application:

• Start the installation package again and click Remove.

• In the Control Panel, click Add or Remove Programs, select Kofax Communication Server Fax

over IP and click Remove.

The following window is displayed:

2. Click No to delete all files created by KCS FoIP or click Yes to keep configuration files and the fax

storage file on the disk.

Reboot Warning When Upgrading FoIP on Windows Server 2008

When FoIP is upgraded by a normal user (not the built-in “Administrator” account) on Windows Server

2008 where UAC (User Account Control) is active, the following reboot warning is displayed during the

installation:

You can ignore the displayed warning. No reboot is necessary. Click OK.

You can also stop the KCS FoIP service before starting the upgrade. The reboot warning will not appear.

Page is loading ...

Kofax Communication Server 10.3.0 Technical Manual

Kofax Communication Server 10.3.0 Technical Manual

Kofax Communication Server 10.3.0 Technical Manual

Related papers

Other documents