2.1 Setting Environment Variables

2.1.1 Setting Environment Variables (Windows NT)

2.1.2 Setting Environment Variables (UnixWare)

2.1.3 Setting Environment Variables (Solaris)

2.2 Modifying Your CT Access Configuration File

2.2.1 Sample CT Access Configuration File

2.3 Modifying the Board Configuration File

2.3.1 Modifying the Configuration File for AG Quad Boards

2.3.2 Modifying the Configuration File for AG 2000 and AG 4000 Boards

2.3.3 Sample AG Configuration File for AG Quad T1

2.3.4 Sample Configuration File for AG 2000/200

2.3.5 Sample Configuration File for AG 4000/1600

2.4 Verifying the Installation

2.4.1 Verifying the NaturalFax Library

2.4.2 Sending and Receiving a Fax

Using AG Boards

Using QX Boards

2.1 Setting Environment Variables

This section describes how to set the environment variables for the following platforms:

• Windows NT

• UnixWare

• Solaris

2.1.1 Setting Environment Variables (Windows NT)

The installation program modifies the following environment variables (unless you specify not to):

NFXTEXTFONT=c:\nms\nfx\text.fnt
NFXHEADERFONT=c:\nms\nfx\header.fnt

If you changed the default directory during installation, replace c:\nms with the path you specified for your system.

Note: If you specify that the installation should not modify the environment variables, you will need to modify the variables yourself, using the Windows NT Control Panel, before running any NaturalFax applications.

Proceed to Section 2.2 to complete your installation.

2.1.2 Setting Environment Variables (UnixWare)

You must add or modify the environment variables NFXTEXTFONT and NFXHEADERFONT for the user environment in which the NaturalFax application will run. You can run a NaturalFax application from any user environment, including the superuser environment, if the environment variables for that user are properly configured. Make sure that these environment variables are added to the appropriate user environment.

To set the NaturalFax environment variables:

1. Open a Terminal window.

2. Log in as the designated user for the NaturalFax application. If you will be running the NaturalFax application from the root user environment, log in as root at your shell's command prompt by entering:
   su -

3. Enter the password when prompted.

4. With a text editor, open the shell script file executed by the user's login shell as part of the login sequence.
   For the Bourne or Korn shell, edit the /.profile file to modify the following environment variables:

5. Create the environment variable NFXTEXTFONT to specify the text font file. For example:
   NFXTEXTFONT=/opt/nms/nfx/text.fnt
   export NFXTEXTFONT

6. Create the environment variable NFXHEADERFONT to specify the header font file. For example:
   NFXHEADERFONT=/opt/nms/nfx/header.fnt
   export NFXHEADERFONT
   For the C shell, edit the /.login file to modify the following environment variables:

7. Create the environment variable NFXTEXTFONT to specify the text font file. For example:
   setenv NFXTEXTFONT /opt/nms/nfx/text.fnt

8. Create the environment variable NFXHEADERFONT to specify the header font file. For example:
   setenv NFXHEADERFONT /opt/nms/nfx/header.fnt

Save the modified shell script file and exit the text editor.

For the changes to the user's environment parameters to take effect in every open UNIX window in which that user is logged in, log out and then log back in as the designated user.

Proceed to Section 2.2 to complete your installation.

2.1.3 Setting Environment Variables (Solaris)

You must add or modify the environment variables NFXTEXTFONT and NFXHEADERFONT for the user environment in which the NaturalFax application will run. You can run a NaturalFax application from any user environment, including the superuser environment, if the environment variables for that user are properly configured. Make sure that these environment variables are added to the appropriate user environment.

To set the NaturalFax environment variables:

1. Open a Terminal window.

2. Log in as the designated user for the NaturalFax application. If you will be running the NaturalFax application from the root user environment, log in as root at your shell's command prompt by entering:
   su -

3. Enter the password when prompted.

4. With your text editor, open the shell script file executed by the user's login shell as part of the login sequence.
   For the Bourne or Korn shell, edit the /.profile file to add the following environment variables:

5. Create the environment variable NFXTEXTFONT to specify the text font file. For example:
   NFXTEXTFONT=/opt/nms/nfx/text.fnt
   export NFXTEXTFONT

6. Create the environment variable NFXHEADERFONT to specify the header font file. For example:
   NFXHEADERFONT=/opt/nms/nfx/header.fnt
   export NFXHEADERFONT
   For the C shell, edit the /.login file to add the following environment variables:

7. Create the environment variable NFXTEXTFONT to specify the text font file. For example:
   setenv NFXTEXTFONT /opt/nms/nfx/text.fnt

8. Create the environment variable NFXHEADERFONT to specify the header font file. For example:
   setenv NFXHEADERFONT /opt/nms/nfx/header.fnt

Save the modified shell script file and exit the text editor.

For the changes to the user's environment parameters to take effect in every open UNIX window in which that user is logged in, log out and then log back in as the designated user.

Proceed to Section 2.2 to complete your installation.

2.2 Modifying Your CT Access Configuration File

The CT Access configuration file, typically called cta.cfg, is used by the CT Access process daemon (ctdaemon). If you will be using ctdaemon as part of your application environment, you must define all CT Access services that the application will use by specifying the service and service manager names in the CT Access configuration file.

Modify the cta.cfg file if:

• The application will be running with ctdaemon.

• The application will use tracing for any of its CT Access services, including the NaturalFax services.

You can develop and run a NaturalFax application without using ctdaemon. If you do not use ctdaemon, you must make sure that the application's CT Access services and service managers are explicitly defined in your application code. For more information about ctdaemon and the CT Access development environment, see the CT Access Developer's Reference Manual.

A NaturalFax application will use the following services:

This service...	With this service manager...	Provides the...
NFX	NFXMGR	NaturalFax API
FAX	FAXMGR	Group 3 fax protocol (ITU T.30)
FXM	ADIMGR for AG boards QDIMGR for QX 2000 boards	Interface to the hardware for sending or receiving a fax
NCC	ADIMGR for AG boards QDIMGR for QX 2000 boards	CT Access call control API
ADI	ADIMGR for AG boards QDIMGR for QX 2000 boards	CT Access call control prior to NCC

The default cta.cfg file includes the ADI service. Modify the file to add the NFX, FAX, and FXM services. The cta.cfg file is located in the following directories:

Windows NT : c:\nms\ctaccess\cfg
UNIX: /opt/nms/ctaccess/cfg

A sample CT Access configuration file, which includes the NaturalFax services, is installed with the NaturalFax software. The sample file is located in the following directories:

Windows NT: c:\nms\nfx\demos
UNIX: /opt/nms/nfx/demos

2.2.1 Sample CT Access Configuration File

For details about the CT Access configuration file, see the CT Access Developer's Reference Manual. The following code excerpt is an example of a CT Access configuration file that includes NaturalFax and its services:

#==========================================================================
# cta.cfg
#
# This is an example of a file that specifies CT Access configuration.
# It allows you to:
#   - specify generic operational settings that apply to CTA Server,
#     ctdaemon,and all CTA applications.
#     Note: these settings can be overwritten by a CTA application via 
#           ctaInitialize.
#   - specify application specific settings
#   - specify CTA Server and ctdaemon specific settings
#   - redefine service specific parameter defaults
#
#==========================================================================



#==========================================================================
# CT Access System Configuration (ctasys)
#
# Valid options are:
#   Service = name, dll        - tells the daemon about available "services"
#                              - tells the CT Access server what "services" 
#                                to export
#
# Note: NCC should always precede ADI when both services are listed.
#==========================================================================
[ctasys]
Service = ncc, adimgr
Service = adi, adimgr
Service = dtm, adimgr
Service = ppx, ppxmgr
Service = swi, swimgr
Service = vce, vcemgr
Service = oam, oammgr

Service = nfx, nfxmgr  # add this line for NaturalFax
Service = fax, faxmgr  # add this line for NaturalFax

Service = fxm, adimgr  # add this line for NaturalFax with
                       # AG boards
Service = fxm, qdimgr  # add this line for NaturalFax with
                       # QX 2000 boards

#==========================================================================
# CT Access application configuration (application)
#
#==========================================================================
[application]
# CTAmode = {0|1|2}  - Execution mode for CTA application
# 0 - Library mode(default)
# 1 - Server mode (requires CTA Server to be running)
# 2 - Multi mode (requires CTA Server to be running)
CTAmode = 0

# ContextNameUniqueness = {0|1}  - Specification of responsibility for 
#                                  the context name uniqueness
#                                  (application or CTA Server)
# 0 - CTA Server is responsible for the context name uniqueness.
#     Allow context name modification by CTA server to ensure name
#     uniqueness (default)
# 1 - Application is responsible for the context name uniqueness.
#     Disallow context name modification by CTA server, 
#     uniqueness error expected from CTA server
ContextNameUniqueness = 0



#==========================================================================
# CT Access Server configuration (server)
#
#==========================================================================
[server]
# ParmFlags = {0|1|2}   -  CTA Server parameter flags
# 0 - Parameter management done by CTA Server. Ignore parameters in ctdaemon 
#     (default).
# 1 - Parameter management done by CT Access ctdaemon
#     (requires ctdaemon to be running; otherwise CTA Server exits).
# 2 - Parameter management done by CT Access ctdaemon if running; 
#     otherwise done by CTA Server.
ParmFlags = 0

# TraceMode = {0|1|2}   -  CTA Server trace mode
# 0 - Disable tracing (default)  
# 1 - Enable tracing; immediate write to trace memory (default mode) 
#     (requires ctdaemon to be running)
# 2 - Write trace memory on error only; keep local trace memory for each
#     context  
TraceMode = 0

# Remote tracing parameters
#   TraceMask = mask           - defines the default tracing mask
#   TraceFile = filename       - defines trace file name
#   StartTraceServer = {0|1}   - 0 disables starting of remote-trace server
#   StartWebServer = {0|1}     - 0 disables starting of built-in web server
#   StartCtaServer = {0|1}     - 0 disables starting of built-in CT Access
#                                server
#   HttpPort = num             - TCP port on which web-server should listen
#   TracePort = num            - TCP port on which trace-server should listen
#   TraceMaxControllers = num  - num. clients allowed to set tracemask
#   TraceMaxMonitors = num     - num. clients allowed to monitor trace msgs
TraceMask = 0
# TraceFile = cta.log
StartTraceServer = 1            
StartWebServer   = 1            
StartCtaServer   = 1            
HttpPort  = 1100                
TracePort = 1101                
TraceMaxControllers =  1        
TraceMaxMonitors    = 10        



#==========================================================================
# CT Access Default Parameter Changes (ctapar)
#
# Valid syntax for changes is:
#   service[.x].category.field = value
#
#==========================================================================
[ctapar]

# by default, no changes are made


#==========================================================================
[eof]

2.3 Modifying the Board Configuration File

If you are using a system with AG hardware, you must modify the configuration file to run the NaturalFax software. OAM uses the configuration file to load and initialize all AG boards in your system.

To use NaturalFax in your AG-based system, the configuration file must:

• Explicitly allocate the DSPs on the AG board to perform fax functions.

• Specify the NaturalFax runtime software to be downloaded at board initialization.

Refer to Chapter 4 - Configuration and Performance Optimization for further information about fax performance and configuration files.

For information about OAM, refer to the OAM System User's Manual. For more information about the keywords specified for each board, refer to the appropriate installation and developer's manual.

Note: There are no configuration modifications necessary to run NaturalFax on a QX 2000-based system. If you have a combination of AG and QX boards in your system, only modifications to the configuration file for AG boards are required.

Use the sample configuration files provided with NaturalFax as models. When you choose a model configuration file, make sure you choose one that corresponds to the AG hardware installed in your system.

The following table shows the sample configuration files for each AG board that supports NaturalFax. The table includes the OAM configuration files that invoke these files as well as the files that are located in the following directories:

Windows NT: c:\nms\ag\cfg
c:\nms\oam\cfg

UNIX: /opt/nms/ag/cfg
/opt/nms/oam/cfg

AG board	File Name	OAM Configuration File	Description
AG Quad T	agpiqt1fax.cfg	agqt1fax_oamsys.cfg	mu-law fax transmit and receive configuration file
AG Quad E	agpiqe1fax.cfg	agqe1fax_oamsys.cfg	A-law fax transmit and receive configuration file
AG 2000/200 AG 2000/400	agpi2fax.cfg	ag2fax_oamsys.cfg	mu-law fax transmit and receive configuration file
AG 2000/200 AG 2000/400	agpi2faxa.cfg	ag2fax_oamsys.cfg	A-law fax transmit and receive configuration file
AG 4000/800	agpi4_8fax.cfg	ag4fax_oamsys.cfg	mu-law fax transmit and receive configuration file
AG 4000/800	agpi4_8faxa.cfg	ag4fax_oamsys.cfg	A-law fax transmit and receive configuration file
AG 4000/1600	agpi4fax.cfg	ag4fax_oamsys.cfg	mu-law fax transmit and receive configuration file
AG 4000/1600	agpi4faxa.cfg	ag4fax_oamsys.cfg	A-law fax transmit and receive configuration file
AG 4000/3200	agpi4dfax.cfg	ag4dfax_oamsys.cfg	mu-law fax transmit and receive configuration file
AG 4000/3200	agpi4dfaxa.cfg	ag4dfax_oamsys.cfg	A-law fax transmit and receive configuration file
QX 2000	None.	None.	Not required

Note: These configuration files are valid for both CompactPCI and non-CompactPCI boards.

2.3.1 Modifying the Configuration File for AG Quad Boards

For the AG Quad T/Dual T and the AG Quad E/Dual E, complete the following steps to modify an oam.cfg file to incorporate NaturalFax:

1. Verify that fax.leo is in the line beginning with the DLMFiles keyword as shown:
   DLMFiles[x] = fax.leo

2. Verify the following files are in the line beginning with the DSP.C5x.DSPFiles keyword as shown:
   DSP.C5x.DSPFiles = m4r_baud.dsp, m4x_tx.dsp, m4r_300.dsp, m4x_300.dsp, voice.dsp, m4r_samp.dsp, m4x_17.dsp

3. Save the changes to the oam.cfg file and exit the text editor.

4. Run OAM to configure and initialize the AG board(s) as specified in the oamsys.cfg file.

2.3.2 Modifying the Configuration File for AG 2000 and AG 4000 Boards

For AG 2000 and AG 4000 boards complete the following steps to modify an oam.cfg file to incorporate NaturalFax:

1. Verify that ag2fax.leo is in the line beginning with the DLMFiles keyword as shown:
   DLMFiles[x] = ag2fax.leo

2. Verify the following files are in the line beginning with the DSP.C5x[x].Image keyword as shown:
   DSP.C5x[x].Image = ag2fax.c54

3. Save the changes to the oam.cfg file and exit the text editor.

4. Run OAM to configure and initialize the AG board(s) as specified in the oamsys.cfg file.

2.3.3 Sample AG Configuration File for AG Quad T1

The following sample configuration file sets up an AG Quad T1 board for NaturalFax:

#--------------------------------------------------------------
#                                   agpiqt1fax.cfg
#
#  --- Alliance Generation Plug-Ins Configuration ---
#
# Sample configuration file for AG-Quad T1 with NaturalFax
#
# Board settings:
#   Product = AG_Quad_T1  
#--------------------------------------------------------------

# Uncomment the appropriate Trunk Control Protocol(s)

TCPFiles[0] = nocc.tcp    # "no trunk control" protocol
TCPFiles[1] = wnk0.tcp    # 2-way wink protocol

DLMFiles[0] = fax.leo

XLaw = MU-LAW

CCMode = none
RunFile = sysqn.run

Clocking.HBus.ClockSource = OSC 
Clocking.HBus.ClockMode = STANDALONE 

NetworkInterface.T1E1[0..3].LineCode  = AMI_ZCS
NetworkInterface.T1E1[0..3].FrameType = D4

DSP.C5x.DSPFiles = m4r_baud.dsp m4r_samp.dsp dtmf.dsp voice.dsp callp.dsp tone.dsp m4x_tx.dsp m4x_17.dsp m4r_300.dsp m4x_300.dsp
DSP.C5x[0..7].Limits[0..9]=7

2.3.4 Sample Configuration File for AG 2000/200

The following sample configuration file sets up an AG 2000/200 board for NaturalFax:

#--------------------------------------------------------------
#                                   agpi2fax.cfg
#
#  --- Alliance Generation Plug-Ins Configuration ---
#
# Sample configuration file for AG-2000/200 or AG-2000/400 with NaturalFax
#
# Board settings:
#   Product = AG_2000  
#--------------------------------------------------------------

# Uncomment the appropriate Trunk Control Protocol(s)

TCPFiles[0] = nocc.tcp    # "no trunk control" protocol
TCPFiles[1] = lps0.tcp    # Loopstart protocol

DLMFiles = gtp.leo voice.leo svc.leo ag2fax.leo
DSP.C5x[0].Image = ag2fax.c54

XLaw = MU-LAW

Clocking.HBus.ClockSource = OSC 
Clocking.HBus.ClockMode   = STANDALONE 

DSP.C5x[1..3].Files = mf signal callp  tone  dtmf  ptf  voice   # default DSP file for AG 2000

2.3.5 Sample Configuration File for AG 4000/1600

The following sample configuration file sets up an AG 4000/1600 board for NaturalFax using A-law:

#--------------------------------------------------------------
#                                   agpi4fax.cfg
#
#  --- Alliance Generation Plug-Ins Configuration ---
#
# Sample configuration file for AG-4000/1600  with NaturalFax
#
# Board settings:
#   Product = AG_4000_2T1  
#--------------------------------------------------------------

# Uncomment the appropriate Trunk Control Protocol(s)

TCPFiles[0] = nocc.tcp    # "no trunk control" protocol
TCPFiles[1] = wnk0.tcp    # 2-way wink protocol

DLMFiles = gtp.leo voice.leo svc.leo ag2fax.leo
DSP.C5x[7..15].Image = ag2fax.c54

XLaw = mu-LAW

Clocking.HBus.ClockSource = OSC    
Clocking.HBus.ClockMode   = STANDALONE 


NetworkInterface.T1E1[0..1].LineCode  = AMI_ZCS   
NetworkInterface.T1E1[0..1].FrameType = D4



DSP.C5x.DSPFiles = mf  callp  tone  dtmf  ptf  voice   # default DSP file for AG 4000

2.4 Verifying the Installation

Once you have installed the NaturalFax software, verify that the system is operational before you continue.

Before running the NaturalFax verification procedures, make sure that:

• CT Access is properly installed.

• Your system hardware includes at least one AG or QX board that can support NaturalFax.

• The NMS board is initialized and operating correctly.

2.4.1 Verifying the NaturalFax Library

Use the CT Access version checker utility, ctavers, to verify that the NaturalFax software can be successfully loaded. The CT Access version checker verifies that all the CT Access libraries defined in the CT Access configuration file (cta.cfg) are accessible. The version checker program displays a list of the versions of all CT Access components.

To run ctavers:

• From the command line, enter:
  ctavers

See Section 2.2.1 for more information about the CT Access configuration file.

2.4.2 Sending and Receiving a Fax

Use nfxsend and nfxrecv to send and receive a test fax. You can use the sample TIFF_F file, sample.tif, to verify your installation.

Using AG Boards

To send a fax:

• From the command line, enter:

       nfxsend -b board -s stream:timeslot -r resolution -e encoding 
                        -p protocol -v   -d telno transmit_file_1 [transmit_file_2 [...]]
  
  

To receive a fax:

• From the command line, enter:

       nfxrecv -b board -s stream:timeslot -r resolution -e encoding 
                        -p protocol -v   receive_file_1 [receive_file_2 [...]]
  
  

Refer to Chapter 8 for more information about the nfxsend and nfxrecv demonstration programs.

Using QX Boards

To send a fax:

• From the command line, enter:

       nfxsend -q -s stream:timeslot -r resolution -e encoding 
                        -p protocol -v   -d telno transmit_file_1 [transmit_file_2 [...]]
  
  

To receive a fax:

• From the command line, enter:

       nfxrecv -q -s stream:timeslot -r resolution -e encoding 
                        -p protocol -v   receive_file_1 [receive_file_2 [...]]
  
  

Refer to Chapter 8 for more information about the nfxsend and nfxrecv demonstration programs.