My Document
OpenText RightFax 10.6Integration Module
Administrator Guide
Edition
OpenText RightFax 10.6 Integration Module.
This document was last updated January 22, 2014.
Trademarks
OpenText is a registered trademark of Open Text Corporation Corporation. All other company names, brand names, and product names are the property and/or trademarks of their respective companies.
Copyright Notice
2014 Open Text Corporation All rights reserved.
Open Text Corporation275 Frank Tompa DriveWaterloo, Ontario, CanadaN2L 0A1(519) 888-7111http://www.opentext.com
Copyright Statement
Portions of this product Copyright 2002-2006 Glyph & Cog, LLC. Portions Copyright 2001 artofcode LLC. This software is based in part on the work of the Independent JPEG Group. This software is based in part on the work of the Freetype Team.Portions Copyright 1998 Soft Horizons. Portions Copyright 2001 URW++. All Rights Reserved. Includes Adobe PDF Library technology. Adobe, Acrobat and the Acrobat logo are trademarks of Adobe Systems Incorporated. Portions Copyright TMS, Inc. 1994-2001. All rights reserved.
OpenText RightFax 10.6 2 Integration Module Administrator Guide
http://www.opentext.com/
Contents
Chapter 1: Introduction 8
Features of the Integration Module 9
Understanding document recognition 10
Understanding Document Distribution 10
Chapter 2: Connecting the OpenText RightFax Integration Module 12
Guidelines for Common Connection Methods 13
Using the Integration Setup Wizard 15
Chapter 3: Configuring the Integration Module to Receive Data 18
Creating an Input Device 18
Setting Up a Named Pipe Capture 19
Setting Up Directory Scanning 21
Setting Up a Serial Capture 23
Setting Up a TCP/IP Port Capture 25
Setting Up an IBM WebSphere MQ Connection 26
Chapter 4: Creating Filter Templates 29
Understanding Filter Templates 29
Preparing to Create Filter Templates 30
Creating a New Filter Template 31
Understanding the Field Types 38
Troubleshooting 41
Creating an Input Channel for Filter Documents 42
Chapter 5: Reusing FCL Commands Across Many Documents 44
Understanding Include Files 44
Creating Include Files 46
Linking Include Files 46
Chapter 6: Creating and Attaching Cover Sheets and Other Files 48
Understanding Cover Sheets 48
Creating Cover Sheet Templates 49
Attaching a Cover Sheet to a Document with FCL 53
RightFax Cover Sheet Logic 55
Example Cover Sheet and Document 56
Attaching Other Types of Files 57
Chapter 7: Defining Fax Page Appearance 59
Drawing Shapes 59
OpenText RightFax 10.6 3 Integration Module Administrator Guide
Embedding Signatures with FCL 63
Embedding Graphics with FCL 64
Setting Margins 65
Setting Tabs with FCL 66
Selecting and Configuring Fonts 67
Setting Page Orientation 69
Setting Fax Image Quality 70
Chapter 8: Document Transmission and Noti-fications 71
Creating Notification Messages with FCL 72
Creating Notification Templates 73
Creating Notification Channels 79
Including the {{Notifyhost}} Command in Documents 89
Testing That the Host Application Is Correctly Receiv-ing Notifications 91
Troubleshooting Notification Messages 92
Setting Up Actions on Document Transmission 94
Chapter 9: Programming for the RightFax XML Interface 99
Introduction to the RightFax XML Interface 99
Installing the XML Interface 99
XML Interface Functions 100
Transports 102
Understanding Body and Cover Text 104
The Schemas 106
Sample Documents Based on the Schemas 116
Chapter 10: Creating FCL Documents 125
Understanding the Format of FCL Commands 125
Setting Defaults for FCL Documents 126
Sending Basic FCL Jobs 129
Creating and Linking Background Forms 133
Example FCL Documents 134
Chapter 11: Programming for the RightFax API for Java 137
Installing the API for Java 137
Sending Outbound Documents 138
Querying Documents 142
Performing Actions on Documents 143
Using Debug Mode 146
Error and Status Codes for XML- and Java-Based Documents 146
Chapter 12: Creating FCL Documents with Inter-netLink Commands 148
System Requirements 148
Verifying the name of the e-mail server 148
Understanding the InternetLink FCL Commands 148
Attaching Native Files to InternetLink Documents 150
Sending Documents as Email if Faxes Fail 152
Receiving Notification When a Fax Fails and Is Sent as an Email 152
OpenText RightFax 10.6 4 Integration Module Administrator Guide
Chapter 13: OpenText RightFax Connector for Oracle Purchasing 11i 153
Activating the Oracle Purchasing 11i Connector 153
How the Oracle Purchasing 11i Connector Works 153
Editing the Default Templates 154
Sending Documents by Email 160
Chapter 14: RightFax Integration Module Pro-grams 161
Chapter 15: FCL Commands 163
ABORT 163
ADDCOPIES 163
ALTFAX 163
APPROVAL 163
ATTACH 163
BATCH 164
BEGIN 164
BEGINCVT 165
BEGINNATIVE 165
BILLING 167
BILLING2 167
BM 168
BOX 168
CC 168
CLEARTABS 169
COMMENT 169
COMPANY 169
CONTACT 169
COVER 169
COVERTEXT 170
CSI 170
DATE 171
DELAY 171
DEPT 171
EMAIL 171
EMPID 171
END 172
ENDCOVERTEXT 172
ENDCVT 172
ENDNATIVE 172
ENDPOLY 172
EXECUTE 172
FAX 173
FF 173
FILE 173
FILLBOX 173
FONT 174
FORM 175
FROM 175
IMAGETYPE 175
OpenText RightFax 10.6 5 Integration Module Administrator Guide
INCLUDE 176
LIBDOC 176
LINE 176
LINETO 176
LINEWIDTH 177
LIST 177
LM 177
LOOKUP 177
LP, LPR, or PRINTER 178
MOVETO 178
NOCOVER or NO_COVER 179
NOTE 179
NOTIFYHOST 179
ONERROR 179
ONSUCCESS 181
ORIENT 182
OWNER 182
PDFUSER 182
PLACE 183
PLACEALL 183
PLACELAST 183
PLACEXY 184
POSITION 184
PREVIEW 184
PRINTER 184
PRINTNOW 184
PRIORITY 185
QUALITY 185
RBOX 185
REM 186
REPLYTO or REPLY_TO 186
RFILLBOX 186
RLINE 186
RLINETO 187
RMOVETO 187
RSTARTPOLY 187
RTI 188
SETTAB 188
SIGN, SIGNED, or @ 188
SIGNATURE 188
SMS 188
SMSMSG 189
STARTPOLY 189
SUBJECT 189
TAB 189
TERMID 190
TIME 190
TM 190
OpenText RightFax 10.6 6 Integration Module Administrator Guide
TO 191
TRANID 191
TYPE 191
UNDERLINE 192
UNIQUEID or UNIQUE_ID 192
UNITS 192
USER1, USER2, or USER3 193
USERID 193
UTC 193
VOICE 194
WINSECID 194
OpenText RightFax 10.6 7 Integration Module Administrator Guide
Chapter 1: Introduction
Chapter 1: Introduction
The OpenText RightFax Integration Module enables information exchange by integrating with applications on mainframe, mid-range, and local area network host systems. Together, OpenText RightFax and the Integration Module will send any document created by these applications via fax, e-mail, or over the Internet.
The Integration Module automates batch-oriented, repetitive processes. It is designed to support applications that produce output that traditionally is sent to a printer, printed on pre-printed forms, folded, stuffed in envelopes, and then mailed or manually faxed. These documents can include invoices, itineraries, purchase orders, statements, order confirmations, loan applications, bills of lading, change orders, financial reports, and material safety data sheets.
The RightFax system can integrate with many applications. The integration options are listed in the following table, along with the RightFax documentation where you can find more information.
Integration option For more information
Integration Module services on the RightFax server with Facsimile Command Language (FCL)
Chapters 2-9 in this guide, and the RightFax Administrators Guide
RightFax XML Interface Programming for the RightFax XML
Integration option For more information
Interface on page 99
RightFax API for Java Programming for the RightFax API for Java on page 137
RightFax C, C++, and Visual Basic API
www.opentext.com
To meet the needs of small, medium, and large enterprises, the Integration Module comes in two versions: the Integration Module which includes full functionality, and the RightFax Business Integration Module which includes a limited set of features for use by smaller organizations.
Module Features
Integration Module l 70 input channels. l Output methods of fax, certified email,
encrypted email, or print. l Up to 70 filter templates. l Up to 128 notification channels. l Unlimited notification messages.
RightFax Business Integration Module
l Two input channels. l One output method (fax or print) per
input channel. l Two fax channels for each fax output.
OpenText RightFax 10.6 8 Integration Module Administrator Guide
Chapter 1:
