Software Release Notice for VS Multiline Facsimile Gateway GetronicsWang VS QuickFax Version 02.00.00 October 6, 1999 SRNLIB/0020/DOCS _______________________________________________________________________________ Page 1 GetronicsWang VS QuickFax Utility, Release 2.00.00 RELEASE ABSTRACT ________________ GetronicsWang VS QuickFax: -------------------------- The GetronicsWang VS QuickFax, Release 02.00.00, QuickFax Fax API application is designed to send VS files through the VS Multiline Facsimile Link Controller (FLC). Because this is a GETPARM application, QuickFax can be run in standalone, from a VS Procedure, or in an application that has been developed to interface with the GETPARM screens of this application. QuickFax is a VS Multiline Facsimile API application and requires the Fax API SSL, FAPILIB, to be installed. The user running QuickFax must have a Logon ID associated with the API "Profile Type" in the VS Multiline Fax User Profiles. A VS Multiline Fax administrator can add a user by running FAXPROF in @SYSTEM@ on system volume or by running the PACE AB, PROFILE. For more information on VS Multiline Fax User Profile, see the VS Multiline Facsimile Gateway, Release 01.03.01 CSRN. QuickFax allows the maximum of 255 items and a maximum of 999 recipients to be included in a fax package. NOTE: Although 255 items may be included in fax package, the total number of pages/images for a fax package may not exceed 359 pages. NOTE: This utility is Y2K compliant. A DLAYDATE entered as 010101 will be recognised as January 1, 2001. A DLAYDATE entered as 990101 will be recognised as January 1, 1999. In general, the two digit year, YY, will be taken to lie between 1980 and 2079. NOTE: QuickFax requires VS Multiline Facsimile Gateway, Release 2.00.00 or later. NOTE: QuickFax supports VS files only. The following is a list of valid VS file type and record sizes excepted: File Type Record Size -------------- ----------- VS Consecutive 0 - 250 VS Print 0 - 252 VS WIIS Image 1 VS WIIS Image 64 VS WIIS Image 2048 VS WP Plus VS WP NOTE: VS WIIS Image file can be in TIFF or WIFF format NOTE: VS OFFICE is not required for QuickFax. _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 1 GetronicsWang VS QuickFax Screens: ---------------------------------- VALIDATE Screen: ---------------- This is a hidden GETPARM screen and is accessible from a VS Procedure or program making calls to PUTPARM. This screen is not display in standalone mode. The purpose of VALIDATE is to validate all items entered in the ITEM screens. The default is set to YES. Accessing this GETPARM and setting the value to NO will speed the process of sending a fax however, failures may occur during the actual calls to the Fax APIs. This will result in the fax package being aborted with an error indicating the problem. If VALIDATE = NO and any item entered does not exist or is in use, this will cause the fax package to be aborted. QuickFax will complete with a return code indication the item number in error, i.e. if an error occurred with item 4 the return code will be 1004. NOTE: If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO, validation of the required fields will be ignored. This may result in a failure to send the fax package. ____________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: VALIDATE Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 Validate Items and Recipients Information, Default: 'YES' VALIDATE = YES Press ENTER to Continue. ____________________________________________________________________ _______________________________________________________________________________ Page 2 GetronicsWang VS QuickFax Utility, Release 2.00.00 FUNCTION Screen: ---------------- The FUNCTION screen has three (3) functions. (1) To Send a Fax starts the process of send a fax package. This is done by validating that the user running this application has a Fax API profile before continuing. (2) To Check Fax Status checks the current status of a fax in the Fax Queue database. (16) Exit Exits the application. When accessing this screen from a procedure the keyword FUNCTION is required, i.e. ENTER FUNCTION 1 for pfkey (1). ______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: FUNCTION Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 Select one of the following options: (1) To Send A Fax (2) To Check Fax Status (16) Exit ______________________________________________________________________________ _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 3 SENDER Screen: -------------- This screen represent the information that will be imposed on the cover page of a fax package and entered in the Fax Queue database. If a cover page is not used this information will be entered in the Fax Queue database The fields are as follows: Required fields: ---------------- TITLE -- This represent the title name of the fax package being sent. NAME -- This field is filled in by QuickFax. The name used is the name provided in the Fax Profile database. The name is associated with the VS Logon Id entered in the Fax Profile database by the VS Multiline Fax administrator. If the user running QuickFax does not have a VS Logon Id in the Fax Profile database the user's logon name is used and an error is reported stating the user does not have access to run this application. Logon ID This field is filled in by the QuickFax application and is not modifiable. This ensures the user running this application has access to do so as indicated by a Fax Profile record. FORMAT - This field is filled in by QuickFax from the user's Fax Profile database record. This is the format of the Fax Cover Page and is defined by the VS Multiline Fax administrator. The cover page name can be modified. However, the cover page must be defined in the VS Multiline Facsimile Gateway configuration file. SUPPRESS Suppress the cover page of a fax being sent. This if set to YES will suppress the cover page of all recipients. If a fax package was going to 4 recipients then the cover page would be suppressed for all four recipients. Optional fields: ---------------- ADDRESS1, ADDRESS2, ADDRESS3 Used as the company and address of the originator of the fax package. PHONE - This is the contact phone number that will appear on the cover page if the cover page option is set to NO, i.e. SUPPRESS = NO. The contact phone number represents the originator's phone number. _______________________________________________________________________________ Page 4 GetronicsWang VS QuickFax Utility, Release 2.00.00 SENDER Screen continued: ------------------------ Optional fields: ---------------- DLAYDATE DLAYTIME DLAYDATE and DLAYTIME work together. This would allow a fax package to be queued to be sent at some time in the near future. If today were Friday, May 5, 1995 and a fax package needed to be sent at 2 a.m. Saturday, May 6, 1995 the fields would be entered as: DLAYDATE = 950506 (YYMMDD) DLAYTIME = 020000 (hhmmss) NOTE: It is important the VS be running. If the VS is down at the time the fax package was queued to be sent, the fax would not go and would need to be resent. NOTE: If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO, validation of the required fields will be ignored. This may result in a failure to send the fax package. NOTE: The first position of any field being used MUST NOT be blank. ______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: SENDER Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 Enter the following Cover Page information: TITLE = NAME = Recipient name ADDRESS1 = ADDRESS2 = ADDRESS3 = PHONE = Logon ID = XXX FORMAT = SYS DEF COVER SUPPRESS = NO (To Suppress Cover Page Enter YES) DLAYDATE = (YYMMDD) DLAYTIME = (hhmmss) Press ENTER to Continue; PF16 to Exit. ______________________________________________________________________________ _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 5 ITEM Screen: ------------ The ITEM screen represents the file chosen to be inserted into the fax package. There can be up to 255 items entered into one fax package. After selecting the first item the next ITEM screen will appear. Leaving the second ITEM screen blank and pressing ENTER will continue to the RCIPIENT screen. NOTE: At least one item must be selected before leaving the ITEM screen blank. Required fields: ---------------- TITLE Represents the title for the current item. The TITLE and item number, as indicated by 'Message Id', will be entered into the Fax Queue database for item information. NOTE: Only one of the following fields may be selected per item. WP Document: WPDOC The name of the WP document to be selected. WPDOC is represented by nnnnx where nnnn is a number and x is the WP library, i.e. 0035a. 0035 is the WP document and 'a' is library 'DOCMNTAA'. WPPASS The password (if required) on a WP document. WP Plus Document: WPPDOC The name of the WP Plus document to be selected. WPPDOC will accept a number only to represent the WP Plus document, i.e. 5 for document AF000005. WPPLIB The name of the WP Plus library as in WPPXXX. WPPPASS The password for the WP Plus document (if required). VS File: FILE The name of the VS Consecutive or VS Print file to include in the fax package. LIBRARY The library name of the VS Consecutive or VS Print file. VOLUME The volume name of the VS Consecutive or VS Print file. VS Image File: IMGFILE The name of a Wang VS Image File. This file can be a VS WIFF or TIFF file format. IMGLIB The library name of the Wang VS Image File. IMGVOL The volume name of the Wang VS Image File. Image Document: LOCATOR The name of the WIIS document locator. IMGDOCID The Document Locator Id of the image associated with LOCATOR to be included into the fax package. _______________________________________________________________________________ Page 6 GetronicsWang VS QuickFax Utility, Release 2.00.00 ITEM Screen continued: ---------------------- NOTE: Wang VS QuickFax will not bypass WP or WP Plus security. If a document is password protected, a password must be supplied or access will not be granted to the document. NOTE: If the user running QuickFax does not have the proper access rights to access a WP Plus document, access will be denied. NOTE: Limitations imposed by QuickFax for a VS Consecutive and VS Print files are as follows: 1) a VS Consecutive file can have a record size no larger than 250 bytes per record. 2) a VS Print file can have a record size no larger than 252 bytes per record. NOTE: A Wang VS Image File can reside on a magnetic disk or on optical disk. NOTE: If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO, validation of the required fields will be ignored. This may result in a failure to send the fax package. NOTE: The first position of any field being used MUST NOT be blank. ______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: ITEM Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 Select one of the following for this Item: Item Title: TITLE = WP Document: WPDOC = WPPASS = or WP Plus Document: WPPDOC = WPPLIB = WPPPASS = or VS File: FILE = LIBRARY = VOLUME = or VS Image File: IMGFILE = IMGLIB = IMGVOL = or Image Document: LOCATOR = IMGDOCID = Press ENTER to Continue; PF16 to Exit. ______________________________________________________________________________ _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 7 RCIPIENT Screen: ---------------- The RCPIENT screen represents the recipient information. There can be up to 999 recipients to receive a fax package. There are two ways that data can be entered for recipient information. 1) Using a Data entry (DATENTRY) file containing a list of recipients for which a fax is to be sent. If the file/lib/vol option is selected, the second recipient screen will not appear. QuickFax will process the file selected. See comment on FAXENTRY for more information. 2) Entering the recipient data manually or via a procedure. Required fields: ---------------- NAME The name of the recipient of the fax package being sent. PHONE The phone number of the the recipient to received the fax package being sent. Optional fields: ---------------- ADDRESS1 ADDRESS2 ADDRESS3 Used as the company and address of the recipient receiving the fax package. BILLING This field does not appear on any of the Fax Queue database screens however, is accessible through a VS PACE query. See VS PACE Query Reference (800-1160C) for more information on generating a PACE query. NOTE: If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO, validation of the required fields will be ignored. This may result in a failure to send the fax package. _______________________________________________________________________________ Page 8 GetronicsWang VS QuickFax Utility, Release 2.00.00 RCIPIENT Screen continued: -------------------------- Using the FILE/LIBRARY/VOLUME fields of the RCIPIENT screen will process the file selected for recipient of a fax package. The list file is created and edited by using FAXENTRY, which is a control file. To add recipients to the list first run DATENTRY and select the file name to create or edit. Then enter FAXENTRY in Fax Control Library on Fax Control Volume. The following field names are: COMMENT, NAME, PHONE, ADDRESS1, ADDRESS2, ADDRESS3, BILLING. The COMMENT field is what is used by QuickFax to include or not include a record from the list into the fax package. If the COMMENT field is blank, the recipient data for that record will be included in the fax package. Any record containing a non-blank character in the COMMENT field will not be included in the fax package. Required fields: ---------------- NAME The name of the recipient of the fax package being sent. PHONE The phone number of the the recipient to received the fax package being sent. Optional fields: ---------------- ADDRESS1 ADDRESS2 ADDRESS3 Used as the company and address of the recipient receiving the fax package. BILLING This field does not appear on any of the Fax Queue database screens however, is accessible through a VS PACE query. See VS PACE Query Reference (800-1160C) for more information on generating a PACE query. NOTE: If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO, validation of the required fields will be ignored. This may result in a failure to send the fax package. NOTE: The first position of any field being used MUST NOT be blank. _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 9 RCIPIENT Screen continued: -------------------------- _______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: RCIPIENT Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 Enter the following Recipient Information: FILE = LIBRARY = VOLUME = or NAME = PHONE = ADDRESS1 = ADDRESS2 = ADDRESS3 = BILLING = Press ENTER to Continue, PF16 to Exit, or PF1 for Previous Item. _______________________________________________________________________________ _______________________________________________________________________________ Page 10 GetronicsWang VS QuickFax Utility, Release 2.00.00 RESULTS Screen: --------------- This is a hidden GETPARM screen and can be accessed via a VS Procedure. This screen will give the results of the QuickFax return code, as well as a possible VS Multiline Facsimile API return code. This screen is not displayed in standalone mode. PKGID This indicates the current id of the fax package just processed. RTCODE This indicates the return code of QuickFax. In general the return code of QuickFax will indicate what item or recipient caused a failure of a fax package. FAXCODE This indicates the error from the Fax API call. If the hidden GETPARM screen VALIDATE is accessed and "VALIDATE" is set to NO and RTCODE is not equal to zero then FAXCODE will contain the error code associated with the the failure of RTCODE. Otherwise, a GETPARM screen will issue indicating the error. If a GETPARM screen is issued then it will need to be satisfied to continue further processing. _______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: RESULTS Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 VS Package Id 00156 Status: CONVERSION PKGID = 00156 VS Package Id Processed RTCODE = 00000 QuickFax Program Return Code FAXCODE = 00000000 Fax API Return Code An explanation of Fax API Return Codes can be found by running FAXMSGS in @SYSTEM@ on GRUNT1 from the Command Processor Press ENTER to Continue. _______________________________________________________________________________ _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 11 GETSTAT Screen: --------------- The GETSTAT screen is accessible from the FUNCTION screen by selecting PF 2 or from a VS Procedure and program by entering the correct function, i.e. ENTER FUNCTION 2. This screen will call the FAXRESLT screen. PKGID This is used to get the Fax Queue status of a fax package. Upon completion of this screen, the next screen (FAXRESLT) will appear. _______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: GETSTAT Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 To check on the current status of a FAX enter the VS Package Id: PKGID = 156 Press ENTER to Continue; PF16 to Exit. _______________________________________________________________________________ _______________________________________________________________________________ Page 12 GetronicsWang VS QuickFax Utility, Release 2.00.00 FAXRESLT Screen: ---------------- The FAXRESLT screen is accessed via the GETSTAT screen. The FAXRESLT screen will display the current status of a fax package in the Fax Queue database. STATUS This indicates the status of the fax id requested in the Fax Queue database file. FAXCODE This indicates the Fax API return code if a failure to access the fax id requested from the Fax Queue database. _______________________________________________________________________________ Wang VS GETPARM v 7 Parameter Reference Name: FAXRESLT Message Id: 0001 Component: QCKFAX Information Required by PROCEDURE Active Subprogram is QUICKFAX Wang VS QuickFax 2.00.00 (c) Copr. GetronicsWang Co. 1999 VS Package Id 00154 Status: IN QUEUE STATUS = 03 Fax Status Code FAXCODE = 00000000 Fax API Return Code An explanation of Fax API Return Codes can be found by running FAXMSGS in @SYSTEM@ on GRUNT1 from the Command Processor Press ENTER to Continue. _______________________________________________________________________________ _______________________________________________________________________________ GetronicsWang VS QuickFax Utility, Release 2.00.00 Page 13 RETURN CODES: ------------- The following return codes are generated by GetronicsWang VS QuickFax: 4 - Error Opening QuickFax Data file. This is the file created using DATENTRY and the FAXENTRY control file. 5 - QuickFax Recipient List File is currently in use. 16 - Exit QuickFax Application. 20 - User has no Fax API Profile record. 21 - User has Fax API Profile record but Fax Access NO. 49 - Wrong version of FAPILIB SSL is installed. 1001 - 1255 - Error with Item. The item is the number minus 1000, i.e. 1005 is an error with item 5. 2001 - 2999 - Error with Recipient. The recipient is the number minus 2000, i.e. 2220 is an error with recipient number 220. 3000 - Bad Coverpage. 4000 - Bad Fax Package Id. 6000 - The Fax API abort failed. Had a problem with the fax package. 7000 - Unable to terminated failed package. 8000 - Fax status failed. 8500 - Send fax package failed. _______________________________________________________________________________ Page 14 GetronicsWang VS QuickFax Utility, Release 2.00.00