Programming Information | NDC comm CompuFax specification

1 0

Programming Information

CompuFax provides tw o facilities to customize its user interface:

•Database Interface

•Callable Command Interface.

10.1 User-Written Database Applications

CompuFax supports an interface to a database lookup application, which allows database keys to be translated into fax phone numbers. It also allows mail-merge operations on documents to be done automatically, using data from database records.

A simple database lookup program, FAX_DB.EXE, has been provided with CompuFax, but you may wish to write your own application, using the supplied library of functions. The library functions allow you to interface CompuFax to your own database programs.

Developing an interface between CompuFax and your own database application is relatively easy. An object library of callable functions has been provided to take care of most of the overhead of communications and other CompuFax internal considerations.

This allows the user to easily interface to their existing database without the necessity of maintaining a separate database for CompuFax. It is also possible to allow each user to have his own database.

It is not necessary that the database application respond to requests in the order that they are received. It is up to the implementor whether to respond to requests one at a time or to implement processing that may complete a later request before an earlier one.

Before writing a CompuFax database application, you may want to consider the possibility of using your existing database to create a file compatible with FAX_DB. In some cases the existing report generation capabilities of a database can be used and the overhead of writing an application saved.

10.1.1 Work ing Wit h Com puFax

The CompuFax database application is a detached process. It wakes up whenever it receives a request from the CompuFax server or the command processor. These requests are serviced and the results returned to the requestor. The mechanics of communications are handled by the FDB (CompuFax database) interface

7 8

Image 102

NDC comm CompuFax user manual Programming Information, User-Written Database Applications, Work ing Wit h Com puFax

Contents

T WO R KI N G D Y N a M I C S C O R P O R a T I O N Copyright Notice January Networking Dynamics Corporation Software License Agreement Warran TY Service CompuFax Version Quick Installation Instructions Page CompuFax Hardware Installation and Configuration Page Preface Overview Intended Audience Table of Contents Other Commands Summary of Commands and Directives Appendix a CompuFax Installation Modem Cabling Hardware InstallationFax Modem Devic e Term inal Port Charac t erist ic s Mult iple Syst em s Software InstallationServer Port Charac t erist ic s Evaluat ion Wit hout Modem Full Devic e Server Set up CustomizationFull Devic e Server Inst allat ion $ Show System Full Devic e Server St art upRem ot e Fax Server Inst allat ion $ FAX Show Device $ Edit FAX$DIRFAXREMSTART.COM Rem ot e Fax Server Set upRemote Fax Server Startup $ FAX Show Server Getting Started What Is CompuFax?Getting Started As a CompuFax User $ FAX Show Queue $ FAX Sending a FaxChecking If Your Fax Was Sent FAX Exit An Even Sim pler Way t o Send Embedding Fax Numbers Into DocumentsPrinting To The Fax Device $ FAX SEN D TESTFAX.2 Sending Faxes Using VMS Mail Using Com puFax Qualifiers w it h VMS MailEm bedding Num bers in VMS Mail CC Psmith Getting HelpFrom VS4000PSMITH 15-JUN -1994 To FAX% $ FAX HelpPage Sending Different File Types More About Sending FilesSending Multiple Files $ FAX SEN D doc.1, doc.2, doc.3, doc.4, doc.5 / N UMBER= Post Sc ript Files Tex t FilesBit m apped Files $ FAX SEN D FILE.COMPRESSED / FORMAT= T4 / N UM= $ FAX SEN D TESTFAX.2 / FON T= Using Different FontsSending Landscaped Files # # FON T Sending Faxes With Coversheets # # Remark This is a coversheet configuration fileSending Files With Overlays $ FAX SEN D BILL.CFG Sending Breakup Files # # EN Dfax # # Breakup# # N Ewfax # # N Umber This results Using The Lookup Feature$ FAX SEN D FILE.A, FILE.B, FILE.C $ FAX SEN D TESTFAX.1 / LOOKUP= Fred Smith Personalizing Broadcast Faxes Lookup With WildcardBroadcasting Faxes $ FAX SEN D TESTFAX.1 / LOOKUP= F Merging From The Command Line $ FAX SEN D MERGE.TXT / LOOKUP= CITY= Los Angeles $ FAX SEN D TESTFAX.2 / AFTER= 12-APR-199621530 Deferred SendingDeleting Entries After Sending $ FAX SEN D TESTFAX.2 / Delete CompuFax queue report as of 10-JUN -1995 Setting PrioritiesLogos and Letterheads $ FAX SEN D TESTFAX.2 / N Ologo Next we execute it Other CommandsUsing Command Files $ @REPORTSEN D Verify Command Show QueueFAX @REPORTSEN D.FAXCMD Show Queue Delete Command $ FAX SEN D TESTFAX.1 / LOOKUP= $ FAX Show Queue$ FAX Delete / EN TRY= 4 / ALL $ FAX Show Queue Keeping Track Of What You Did FAX Logoutput TEST.LOG Receive to Disk Receiving Faxes Prin TER / N Obestway / Bestway / N Oburst / N Oburst Qualifier Default valuePrinting Faxes Osheetfeed / N Osheetfeed / SIZE= XXX / SIZE= LetterPage Fax Print er Set up Print Com m Viewing FaxesVerifying Print er Opt ions FAX Show Prin TER Using CFRECTOOLS.COM View c om m Qualifiers Converting Fax FilesConvert Com m $ FAX SET Prin TER / Receive / N Odelete / N Otify PCL Ex am plesFAX or T4 Prin TER or Text Here are some conversion examples $ FAX CON Vert in .X / Prin T Installation Personal Computer InterfaceIntroduction PostScript Driver Initialization \ Cfin Stal E\ FAX\ Pcif Adding a Print er Driver \ CFTEMP.PS Unknown local port Window s 3.1 Post Sc ript Driver Init ializat ion Using the PC InterfaceAdding a Port Nam e Disc laim er Feat ures Sending a FaxDest inat ion Sc reen Lookup Screen Coversheet Selec t ion Sc reen Edit ing an Ent ryCoversheet Sc reens Coversheet Inform at ion Sc reen Resolut ion When t o SendSet up File List Default s 1Server Pat hCoversheet s Making Things Easier How to Modify a Coversheet Sam ple Configurat ion FileFrequent ly Used Files Sam ple File Ex plained Inc lude FilePage CON Vert Summary of Commands DirectivesCommands Format Otify TopmarginFAX CON Vert in .X / FORMAT= Text OUT.Y / FORMAT= PCL Local DeleteALL Exit SIN CE AfterBefore User Class QuitSEN D Commen T LAN Dscape FON TPostscript or PS FAX or T4 Prin TER or Text Logo Overlay MergeUmber Portrait Resolution = Standard ResolutionResolution = Fine Portrait D Completion SON LY Oreceive / Resolution Speed / SPEED2Disable EN Able Form CopiesFlag Model Queue = Run Length Encoding = N o CompressionOTE Sheetfeed Show Device TrailerSH OW Full Usern AME Shutdown Show Prin TERShow Server Start Down Scale Verify on Verify OFFView Maxpages Startpage DirectivesFile Direc t ives Breakup EN Dfax CH Aractersize# # Charactersize Millimeters 4.0 # # FON T Stdfon T LAN Dscape # # Portrait Mail-Merge Direc t ivesOverlayfile Position Cursor Mergeen D MergedisableMergeen Able Mergestart CompuFax Files And Logical Names DirectoriesFiles CFREC.H Ascjn L.COMCF31.RELEASEN Otes COMPUFAX.PS, COMPUFAX.T4, COMPUFAX2.PS, COMPUFAX2.T4 FAXDB.DAT Faxcmdsh ARE.EXEFAXCVT.EXE FAXDB.EXE FON Tmap Faxsylogin .COMFAXSYSTARTUP.COM GIRL.PS CompuFax Logical Names FAX$RECDIR FAX$PSDIRFAX$QUEUE FAX$SCRATCH Severit y Levels CompuFax MessagesFac ilit y Codes FAX Alphabetical Listing of Messages Message Rout ing Close DevaccessCallterm Cmdreaderr Devstatfail DevrespfailDevstart Devstop Faxdon E FaxcompleteFaxdevice Faxfail Illserreq Illn UMIllpri Illsqueue Ivmsg Ivdevin DVEN TRY Ivqsize Odbn Umber MemallocfailEwstream Odest Ofaxclass OdeviceOefn Ofile Opriv OmatchOmorefields Ormal PH on Ebusy PriadjustOtin Queue PN Umber Retry QueuefullRemcsi SEN Ddon E Taken Down SH UtdownStats Tooman Yfax Programming Information User-Written Database ApplicationsWork ing Wit h Com puFax Using The FDB Rout ines Fdbclose streamid Com puFax Dat abase Func t ion Library 10.1.3.1 FdbcloseFdbget Fdbdeletemsg messagePage Type userdefined Access write only Mechanism by reference Fdbgetcon Text streamid, context , maxsize , size Fdbinit Fdbin IT contextsize, savecontextArguments Fdbnomatch One. Errors are signaledType userdefined access read only Mechanism by reference Fdbn Omatch streamid Fdbscan Fdbscan scancontext, streamidOne Fdbsetfield Type charactercoded text string Access read onlyFdbsenddata Fdbsen Ddata streamid, message Mechanism by descriptorfixed length string descriptor FdbsetmatchFdbsetnumber Fdbsetmatch message, matchkey value Fdbsetstatus message, status code FdbsetstatusFdbstartmsg Fdbstartmsg message Shutdown Look UPClose This sends a shutdown message to the database application Callable Com m ands Faxcmdproc commandlineCompuFax Callable Interface Faxcmdproc Faxcmdsethan DLE handleraddress Faxcmdsetin PUT inputproc, parminputproc Faxcmdsetoutput outputproc Faxcmdsetuser usernameFaxcmdforceexit Link ing Modules Dbcon DKEY.C DBGETDIR.C Dbmain .C DBN EXTREC.C FAXCMD.CPage Appendix a Release 3.1.00 ChangesRelease 3.0.01 Changes See FAX Help Filedirective Position Cursor Known ProblemsSolution # # FON T filename See FAX Help Filedirective FON T Release 2.2.00 Changes Release 2.1.00 ChangesPage Release 1.2.04 Changes Page Glossary AsciiAXP CSI FAX% Faxdb Help Pending Null stringOverlay Percent sign % Scaleable font RecordRemote server Secondary key TSI VAXVMS Page 446-4511