NMS Logo

NaturalFax Developer's Reference Manual

P/N 9000-60009-15
Version

Table of Contents Index NMS Glossary Previous Page Next Page Version

Table of Contents

1 Overview of NaturalFax

1.1 NaturalFax Overview
1.1.1 NaturalFax Capabilities
1.1.2 NaturalFax System Architecture
1.2 Fax Application Overview
1.2.1 Natural Access Components
1.2.2 Preparing the Hardware Environment

2 Configuring NaturalFax

2.1 Overview of Configuring NaturalFax
2.2 Setting Environment Variables
2.2.1 Setting Environment Variables Under Windows
2.2.2 Setting Environment Variables Under UNIX
2.3 Modifying the Natural Access Configuration File
2.3.1 NaturalFax Services
2.3.2 Sample Natural Access Configuration File
2.4 Modifying the Board Configuration File
2.4.1 Configuring AG Quad Boards
2.4.2 Configuring AG Boards
2.4.3 Configuring CG Boards
2.4.4 Sample AG Quad T1 Configuration File
2.4.5 Sample AG 2000/200 Configuration File
2.4.6 Sample AG 4000/1600 Configuration File
2.4.7 Sample CG 6000C Configuration File
2.5 Verifying NaturalFax
2.5.1 Verifying the NaturalFax Library
2.5.2 Sending and Receiving a Fax

3 Developing NaturalFax Applications

3.1 A Typical Fax Application
3.2 A Typical Fax and Voice Application
3.3 Setting Up the Natural Access Environment
3.3.1 Initializing NaturalFax
3.3.2 Creating Event Queues and Contexts
3.3.3 Opening Services
3.4 Establishing a Call
3.4.1 Placing a Call
3.4.2 Receiving a Call
3.5 Using Document Queues
3.5.1 Building a Document Queue
3.6 Transmitting and Receiving Faxes
3.6.1 Transmitting Faxes
3.6.2 Receiving Faxes
3.6.3 Polling the Called Fax Terminal
3.6.4 Answering a Poll Request
3.6.5 Resetting a Document Queue
3.7 Performing Image Conversion
3.7.1 Performing Offline Image Conversion
3.7.2 Performing Online Image Conversion
3.8 Monitoring Fax Session Status
3.8.1 Tracing NaturalFax Applications
3.8.2 Error Handling During a Fax Session
3.9 Terminating and Shutting Down
3.9.1 Tearing Down or Resetting a Document Queue
3.10 Closing Natural Access Services

4 Optimizing Performance

4.1 Overview of Optimizing Performance
4.1.1 Strategies for Optimizing Performance
4.2 Maximizing Ports For Fax Transmission
4.3 Maximizing Universal Ports
4.4 System CPU Load Test Examples
4.4.1 AG Board Example
4.4.2 QX 2000 Board Example
4.4.3 CG Board Example

5 Image Format Characteristics

5.1 About Image Format Characteristics
5.1.1 Encoding Formats
5.1.2 Resolution Formats
5.1.3 Page Width Formats
5.2 Options for Storing and Converting Image Data
5.3 T.37 and TIFF-S

6 NaturalFax Function Summary

6.1 Function Summary Introduction
6.2 Using Document Queues
6.3 Transmitting and Receiving Documents
6.4 Managing Image Format Conversion
6.5 Managing Pages and Document Contents
6.6 Monitoring Status

7 NaturalFax Function Reference

7.1 Function Reference Introduction
nfxAnswerFaxPoll
nfxCheckTIFF
nfxConvertFileDirect
nfxCreateQueue
nfxDestroyQueue
nfxEnqueueDoc
nfxGetDocStatus
nfxGetSessionStatus
nfxMergeFile
nfxReceiveFax
nfxResetQueue
nfxSendFax
nfxSplitFile
nfxStopSession

8 NaturalFax Demonstration Programs and Utilities

8.1 About the Demonstration Programs and Utilities
8.2 Using Voice and Fax: caller
8.3 Using Voice and Fax: faxback
8.4 Receiving a Fax: nfxrecv
8.5 Sending a Fax: nfxsend
8.6 Verifying TIFF-F or TIFF-S Format: nfxcheck
8.7 Converting TIFF-F or TIFF-S Files: nfxcnvrt
8.8 Merging TIFF-F or TIFF-S Files: nfxmerge
8.9 Splitting TIFF-F or TIFF-S Files: nfxsplit
8.10 Converting ASCII Files: nfxtxttf

Appendix A NaturalFax Error Codes and Events

NaturalFax Error Codes
Alphabetical Error Summary
Numerical Error Summary
NaturalFax Events
Completion Events
Informational Events
Confirmation Events

Appendix B NaturalFax Data Structures

About NaturalFax Structures
Parameter Structures
NFX_TRANSMIT_PARMS
NFX_RECEIVE_PARMS
NFX_DOC_PARMS
NFX_CONVERT_PARMS
Status Structures
NFX_FAX_STATUS
NFX_DOC_STATUS
NFX_CHECK_STATUS

Appendix C DSP Requirements for AG and CG Boards

NaturalFax DSP Requirements for AG Quad Boards
NaturalFax DSP Requirements for AG 2000 and
AG 4000 Boards
NaturalFax DSP Requirements for CG Boards

Appendix D Group 3 Fax Technology

Fax Protocols
Group 3 Protocol
Phase A - Call Setup
Phase B - Pre-Message Procedure
Phase C - Image Transfer and Message Transmission
Phase D - Post-Message Procedures
Phase E - Call Release
Non-Standard Facilities Frame

Appendix E Modem Metrics

About Modem Metrics
Signal To Noise Ratio (SNR)
Training Check Frame (TCF)
Using SNR and TCF Together

Appendix F Sub-Addressing

About Sub-Addressing
Using Sub-Addressing

Table of Contents Index NMS Glossary Previous Page Next Page Version

Want to send us feedback on our documentation? Email: Tech_Pubs@nmss.com
Copyright © 2001, NMS Communications Corporation. All rights reserved.