═══ 1. About HKFaxPbk ═══ The FaxWorks (c) phone book generation software allows the user to generate the fax phone book entries from the IBM Works (c) address book. The application allows the initial generation or the regular update and merge. Entries in the fax phone book are updated with the values of the IBM Works address book on the basis of comparing the fields for last name, first name and optionally the company. Entries in the FaxWorks phone book which do not exist in the IBM Works address book are kept unchanged in the FaxWorks phone book. Additionally the program allows the generation of general *.CSV files out of general dBase (c) *.DBF files with a wide variety of selection and generation criteria. ═══ 1.1. Version and Requirements. ═══ The actual version of HKFaxPbk is 1.3, dated 7th of may, 1995. The minimum requirements are: o a computer system running OS/2 version 2.x or higher o the OS/2 REXX language environment installed o the VX-REXX runtime library VROBJ.DLL installed o 1 Mb disk space to install HKFaxPbk ═══ 1.2. What is new in this version ═══ Version 1.1 With the parameter /S or /s the program will start the fax phone book action with the actual saved settings without user interaction, so that this task can be performed regularly using the IBM Works appointment scheduler. Using the capital letter (/S) causes the program also to exit, whereas /s will keep it open. ═══ 1.3. Limitations of the Unregistered Copy ═══ The unregistered copy of HKFaxPbk has the following limitation: The program handles the total number of input records, but it only writes the first ten records from each input file to the output file. ═══ 1.4. Registration Fees ═══ The registration fee for this product amounts to: o CHF 25,--/US $ 20,-- per copy for private users. o CHF 50,--/US $ 40,-- per copy for commercial users. For each ten copies a reduction of five percent is given, up to a maximum of fifty percent for hundred and more copies. A handling fee of CHF 5,--to 15,--/US $ 5,-- to 15,-- is added to any order, regardless of the number of copies ordered. All payments have to be done in Swiss francs (CHF) or US $, any checks have to be drawn on a Swiss bank. Registration via the COMPUSERVE registration service (GO SWREG) is recommended. The product identification number is 4792. ═══ 1.5. How To Register Your Copy ═══ You can use several methods to register your copy of the product: o Using the REGISTER menu entry to produce the registration form and send it with cash or a check to the author o Using the COMPUSERVE registration service GO SWREG. This is the recommended way for the registration. After the registration you will be mailed a registration document stating the registration number. You use the REGISTER menu entry to enter this number and its associated information into the application. If the application can verify the registration number, the application will have the registered status fron then on. In general the registration remains valid for all subsequent versions if not stated explicitly otherwise. ═══ 2. Disclaimer ═══ Disclaimer - Agreement Users of this product must accept the following disclaimers of warranty: "THIS PRODUCT IS SUPPLIED BY THE AUTHOR AS IS. THE AUTHOR DISCLAIMS ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT LIMITATION, THE WARRANTIES OF MERCHANTIBILITY AND OF FITNESS FOR ANY PURPOSE. THE AUTHOR ASSUMES NO LIABILTY FOR DAMAGES, DIRECT OR CONSEQUENTIAL, WHICH MAY RESULT FROM THE USE OF THIS PRODUCT." "THE AUTHOR MAKES NO WARRANTIES AS TO THE INFORMATION IN THIS GUIDE." "THE SOFTWARE IS PROTECTED BY THE COPYRIGHT LAWS OF SWITZERLAND AS WELL AS BY THE COPYRIGHT LAWS OF MANY OTHER COUNTRIES PURSUANT TO INTERNATIONAL TREATIES. ALL RIGHTS RESERVED. NO PART OF THIS COMPUTER PROGRAM, DOCUMENTATION OR RELATED FILES MAY BE REPRODUCED, PHOTOCOPIED,STORED ON A RETRIEVAL SYSTEM, OR TRANSMITTED EXCEPT AS PROVIDED BY SWISS COPYRIGHT LAW." ═══ 3. Trademarks ═══ OS/2, REXX and IBM Works are registered trademarks of the International Business Machines Corporation (IBM). VX-REXX is a trademark of the Watcom International Corporation. dBase, dBase III or dBase IV are trademarks of Borland Corporation. FaxWorks is a trademark of the Keller Group Inc. Other trademarks are the trademarks of their respective trademark owners. ═══ Data Base File ═══ Enter the fully qualified filename of the dBase database file from which you like to export data or set the filename using the menu entry Data Base File in the file menu. ═══ Output File ═══ Enter the fully qualified filename of the file where you want the data to be exported or set the filename using the Output File entry in the file menu. ═══ File Disposition ═══ This spin button has the values Overwrite The defined output file is overwritten or created Append. The defined output file is backed up (*.BAK) and the exported records are added to the file ═══ Separator ═══ This spin button allows to set another field separator character than a comma for the output file ( only in case of exporting to a general *.CSV file, not for the FaxWorks phone book ). ═══ Debug Trace ═══ With this check box you can request, that the file and database records be printed out or written to a log file, using the VX-REXX console facilities. ═══ Export Definition ═══ This panel is used to define the fields in the database which are to be exported. The possibilities are: Add All All fields from the database ared added to the output file field definition window. You can then remove single fields from that list. Add The selected field from the database fields window is added to the output file fields list. Append The selected field from the database fields window is appenden to the selected field in the output file fields list. This means that the output file will contain one field with the combined contents of several fields in the database. The field name is the name of the first field. Remove The selected field is removed from the output file fields list. Appended fields are removed from the end to the beginning one by one. Rem. All All fields are removed from the output file fields list. You can specify new field names for the output file by double-clicking on an existing field name in the new names list. An entry box lets you change the name. If you finished the definition, click on "OK" to switch to the window for the specification of the search criteria. ═══ Selection criteria ═══ After definition of the database fields to export, the selection criteria for identifying the records to export may be given. If no selection criteria are set up, all records will be exported. The windows contains in the upper left corner the field showing the defined test statement and the the follwing controls: Database fields In this listbox you select the database fields whose contents are to be tested. Comparison This group box contains the various comparison operators. You enter them by clicking on the corresponding pushbutton. Logical Pushbuttons for entering logical comparison values (after an comparison operator). String Pushbuttons to enter string comparison functions (after selecting a string field). The test can be made on the occurrance of a substring in the string ( "contains" pushbutton) or if a string starts with a substring ( "begins" pushbutton ). Value Here you enter the comparison value. Make sure to enclose string values in double quotes ("). You click the "Enter" pusbutton to add the value to the test statement. The pushbuttons in the upper right corner (" (", ")") add parentheses to the test statement or allow the logical combination of tests by ".AND." and ".OR.". With the "OK" pushbutton you terminate the specification and transfer the test statement into the program. The "Clear" pushbutton clears the test statement, and with the "Cancel" button you leave the definition without setting a test statement. ═══ Fax Phone Book ═══ This panel is used to specify the details for the generation of the FaxWorks phone book out of the IBM Works adddres data base. generate ... This option is used to generate the FaxWorks phone book by extracting the appropriate records from the database. If a "fax.pbk" file already exists, it is backed up as "fax.bak". merge ... The existing "fax.pbk" file is backed up as "fax.bak", the appropriate records are extracted from the IBM Works database and merged with the existing records in "fax.pbk". For records where LNAME and FNAME ( and COMPANY if requested) are equal, the emaining values are taken from the database. If "Debug trace" is on, such records are printed out, if the modification date of the "fax.pbk" file is greater than the modification date of the database record. With the Selection Criteria radio buttons you can define, if only the records with Fax 1 or Fax 2 numbers or both are extracted. In any case the first fax number found is used. If your address book contains other labels for the the fax numbers, you may change the entries in the fields accordingly. As default only LNAME (last name) and FNAME(first name) must be equal to denote an equal record. If you wish, you can specify that also COMPANY must contain the same value before records are considered to be equal. ═══ 4. File Menu ═══ The File menu contains commands that you use to create, open, and save data files. In addition, it also contains the command that you use to exit the application. The following commands appear in the File menu: Data base file Opens the database file Output file Opens the result file Save Actual Settings Saves the actual state of the settable variables Close Quits the application ═══ 4.1. Data base file ═══ Opens the standard file dialog to access the dBase *.DBF file as input file. ═══ 4.2. Output file ═══ You can open a file that exists on any drive or in any directory by using the Output file command. To open a file, do the following: o Select the File menu and choose the Output file command. The standard file dialog box appears, showing you a list of files in the current directory. If you want to export to the FaxWorks phone book, choose the appropriate path and file. HKFaxPbk saves the actual file with an extension of ".BAK". If you want to export to or merge with a *.CSV (comma separated) file, choose the path and file accordingly. ═══ 4.3. Save actual settings ═══ You use the Save command to save changes you've made to the setup of the application (e.g. file names, switches, parameters). To save changes to the setup, do the following: o Select the File menu and choose the Save command. The actual values will be saved to the HKFaxPbk.INI file, which will be opened in the actual directory if it does not exist. ═══ 4.4. Close ═══ You quit the application by using the Close command. To quit the application, do the following: 1. Select the File menu and choose the Close command. ═══ Help for Open ═══ ═══ Help for Open ═══ 1. Select the down arrow to the right of the Drive list to display all the drives on your system. 2. Select a drive from the Drive list. 3. Select a directory from the Directory list. 4. Select a file name from the File list or type in a file name and select the Open pushbutton to display the file you want to edit. For specific help, select a topic below. ═══ List of Fields ═══ File name Type of file Drive File Directory Open pushbutton ═══ Help for File name ═══ ═══ Help for File name ═══ Type the name of the file you want to open in the File name field and select the Open pushbutton. For more help, select a topic below. ═══ List of Fields ═══ File name Type of file Drive File Directory Open pushbutton General help ═══ Help for Type of file ═══ ═══ Help for Type of file ═══ Select the down arrow to the right of the Type of file field to display the available file types. The sample has set this field for all file types. For more help, select a topic below. ═══ Help for Drive ═══ ═══ Help for Drive ═══ The Drive list displays the drives on your system. Select the drive that contains the files you want to edit. For more help, select a topic below. ═══ Help for File ═══ ═══ Help for File ═══ The File list displays all the files in the directory you selected from the Directory list. Select the file you want to open. For more help, select a topic below. ═══ Help for Directory ═══ ═══ Help for Directory ═══ The Directory list displays the directories on the selected drive. Select a directory to display the list of files from that directory in the File list box. For more help, select a topic below. ═══ Help for Open ═══ ═══ Help for Open ═══ Select the Open pushbutton to display the file you want to edit. For more help, select a topic below. ═══ Help for Save ═══ Use Save to store the file you are editing. After the file is saved, the text remains in the window so that you can continue editing it. Note: If you are editing a new file, select the Save or Save as choices to display the Save as pop-up so that you can name the file you are editing. A file must have a title to be saved. ═══ Help for Save as ═══ Use Save as to name and save a new file or to save an existing file under a different name, in a different directory, or on a different disk. ═══ Help for Save as ═══ ═══ Help for Save as ═══ 1. Select the down arrow to the right of the Drive list to display all the drives on your system. 2. Select a drive from the Drive list. 3. Select a directory from the Directory list. 4. Type the name of the file you want to save in the File name field and select the Save pushbutton. For specific help, select a topic below. ═══ List of Fields ═══ File name Type of file Drive File Directory Save pushbutton ═══ Help for File name ═══ ═══ Help for File name ═══ Type the name of the file you want to save in the File name field and select the Save pushbutton. For more help, select a topic below. ═══ List of Fields ═══ File name Type of file Drive File Directory Save pushbutton General help ═══ Help for Type of file ═══ ═══ Help for Type of file ═══ Select the down arrow to the right of the Type of file field to display the available file types. The sample has set this field for all file types. For more help, select a topic below. ═══ Help for Drive ═══ ═══ Help for Drive ═══ The Drive list displays the drives on your system. Select the drive that contains the files you want to save. For more help, select a topic below. ═══ Help for File ═══ ═══ Help for File ═══ The File list displays all the files in the directory you selected from the Directory list. Select the file you want to rename and save. For more help, select a topic below. ═══ Help for Directory ═══ ═══ Help for Directory ═══ The Directory list displays the directories on the selected drive. Select a directory to display the list of files from that directory in the File list box. For more help, select a topic below. ═══ Help for Save ═══ ═══ Help for Save ═══ Select the Save pushbutton to save the file to the drive and directory you selected and with the file name you specified. For more help, select a topic below. ═══ 5. Actions ═══ The Actions menu contains the commands for the definitions and the export of the database data. ═══ 5.1. FaxWorks export ═══ Performs the export of the data of the IBM Works address book to the FaxWorks phone book file. The original phone book file is saved with *.BAK extension. New entries from the database are added, entries which exist in the phone book but not in the database are kept in the phone book. Entries existing in both files are updated in the phone book using the data from the database. An entry is considered to be in both files if the field values for LNAME and FNAME are equal. If requested by user setting, also the field value COMPANY must be equal. ═══ 5.2. Define CSV ═══ If exporting to a user defined comma separated (*.CSV) file, this action is activated to define the database fields to export, as well as their sequence and possibly new names in the CSV heading line. Export to the CSV file can only take place after this definitions have been set. ═══ 5.3. Select CSV ═══ After defining the fields to export from the database to the *.CSV file, this panel is called to select the search criteria for the records to be exported. If no selection criteria are specified, all records will be exported. ═══ 5.4. Export CSV ═══ Performs the export of the data of the IBM Works address book to the user specified comma separated (*.CSV) file according to the field and selection definitions. If necessary, the Define CSV and Export CSV commands can be used several times, appending different selections to the output file. ═══ 5.5. Edit CSV ═══ Calls the enhanced editor for the user defined CSV file. ═══ Help Menu ═══ Access to the standard and application specific help panels and the product informations. ═══ Product Information ═══ This dialog shows the product name, version, short description, and copyright noice. ═══ 6. Registration ═══ This product is shareware. This means that you are entitled to test the software for 30 days. If you wish to use the software after this period of time you must purchase a usage license. The license fee is indicated in the product description under the heading Registration fees. Payment has to be made only in the currancy as stated there, in cash or by checks drawn on the banks as stated. Another possibility is using the COMPUSERVE registration service ( GO SWREG ). In any case, the registration form has to be sent to the author by clicking on the "Register" menu entry, filling in the appropriate values and printing the form. ═══ 6.1. Sending the Registration Order ═══ If you wish to register your copy of the product, click on the Register menu entry. Fill in the Name and Address fields. Make sure that the entries are complete (address must at least contain one entry) and correct. In case you want a commercial license, check the corresponding button and enter the number of simultaneous users in the Nodes field. Click the Send Reg. button. The amount due will be determined and the corresponding registration form will be printed on the default printer. Save a copy and send the form to the author. You will get back your Registration Number which you should enter into the application. ═══ 6.2. COMPUSERVE Registration Service ═══ Registration can be made via the COMPUSERVE registration service. This speeds up the registration process and eases the payment, as the registration fee is debted to your COMPUSERVE account. Use the product identification number as given in the Registration fees paragraph above. Please make sure that you also send the Registration Order to the author, as you can get the registration number only via this order. ═══ 6.3. Registration Number ═══ When you recieve your registration documents and your registration number from the author, activate the registration panel by clicking the Register menu entry. Enter the Name, Address, Date and Registration Number fields EXACTLY as you see them on the recieved registration document. If you ordered a commercial license, also check the checkbox and enter the Nodes value. If the registration number can be verified successfully by the application, it will change to the registered status and the Register menu entry will be disabled. Leave the application and restart it to access the capabilities which were limited in the unregistered state. The registration number will in general remain valid for the subsequent version unless explicitly stated otherwise. ═══ 6.4. Shareware ═══ Definition of SHAREWARE software Shareware software distribution gives users a chance to try software before buying it. If you try shareware software and continue using it, you are expected to register. Individual programs differ on details - some request registration while others require it, some specify a maximum trial period. With registration you get anything from the simple right to continue using the software to an updated program with printed manual. Remember that Shareware is a distribution method, not a type of software. You should find software that siuts your needs and pocketbook, be it distributed commercially or via shareware channels. The shareware system makes fitting your needs easier to you, because you can try before you buy. And because overhead is low, prices are low also. Shareware software has the ultimate money-back guarantee - if you don't use it, you don't pay for it. The essence of the shareware method is to provide personnel computer users with quality software without high prices, and yet to provide incentive for programmers to continue to develop new products. Shareware authors are professional software developers who use the inexpensive distribution method to reach a sufficiently large market. It is part of this method, that you are encouraged to pass along shareware products to your friends and collegues, as long as you transfer the complete, unchanged package without charging any fees, except the cost for the media on which you hand it over (diskettes e.g.). It is essential that you understand and accept, that shareware is protected by the copyright laws and that you have to register if you use the software after a reasonable trial period. Support the shareware method, which provides you with inexpensive software product by a fair registration policy. ═══ 6.5. Copyright ═══ Copyright laws apply to both shareware and commercial software, and the copyright holder retains all rights, with a few specific exceptions as stated below: The author specificially grants the rigth to copy and distribute the complete and unmodified software in order to hand it over to other users for trial. ═══ 6.6. Authors Address ═══ The author can be reached by surface mail or via COMPUSERVE. Mail address: H. Kiesbauer 4U - Software Steinackerweg 21 CH-4513 Langendorf COMPUSERVE ID: 100121,2715 Please send your questions and comments preferrably via COMPUSERVE, I will check my mailbox aproximately once a week. ═══ OK ═══ The OK button closes the Product information dialog. ═══ ═══ Denotes a dBase data file which normally has the extension *.DBF ═══ ═══ Denotes a "comma separated file" which normally has an extension of *.CSV. This is a structured sequential file with character data lines. The fields within a line are separated by commas or another separator character. The first line may be built up by the field names separated by the separator character. This file format is often used to export and import record data from databases.