SOFTWARE RELEASE NOTICE for VS OFFICE INDEXER Part No. 195-126A/B/C VERSION 02.00.00 July, 1999 001187 ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 1 Release 2.00.00 -- July 1999 Table of Contents Section Page 1.0 Release Abstract . . . . . . . . . . . . . . . . . . . . 3 2.0 Pre-Requisites and Dependent Software Packages . . . . . 4 2.1 Hardware Pre-Requisites . . . . . . . . . . . . . . 4 2.2 Software Pre-Requisites . . . . . . . . . . . . . . 4 2.3 Optional Software . . . . . . . . . . . . . . . . . 4 2.4 Installability . . . . . . . . . . . . . . . . . . . 4 3.0 Restrictions and Special Considerations . . . . . . . . . 5 4.0 Enhancements . . . . . . . . . . . . . . . . . . . . . . 8 5.0 Problems Corrected . . . . . . . . . . . . . . . . . . . 9 6.0 Known Anomalies . . . . . . . . . . . . . . . . . . . . 13 7.0 Media Contents . . . . . . . . . . . . . . . . . . . . 15 7.1 OI Standard Components on Media . . . . . . . . . .15 7.2 After Installation . . . . . . . . . . . . . . . . .18 7.3 Other files created when OI is running . . . . . . .23 8.0 Software Installation & Operation Information . . . . . .24 9.0 Installing on a VS 5000 system . . . . . . . . . . . . .27 10.0 Converting the Index . . . . . . . . . . . . . . . . . .28 11.0 Moving the Index . . . . . . . . . . . . . . . . . . . .29 12.0 References . . . . . . . . . . . . . . . . . . . . . . .30 ______________________________________________________________________________ Page 2 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 1.0 Release Abstract 1.1 Functions VS OFFICE Indexer, an optional software application on the VS, provides object index, search/retrieval and certain document management capabilities across IIS, WP Plus documents and other VS objects. OFFICE Indexer capabilities: Searching the Index Result List Functions: . Edit single document or enter WP/WP Plus to edit several documents . Create a WP or WP Plus document . Add an index entry for any object . Display, copy, delete or print a document . Modify the Document Summary . Print or save the Result List . Create Package . Set Defaults for initial search/result Administering the Index . Add or delete any libraries and modify the libraries indexing type . Modify automatic indexing set-up . Update index, cancel the update, and restore index from backup copy . Display the background task log file . Cancel the background task . Set up the system constants ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 3 Release 2.00.00 -- July 1999 2.0 Pre-Requisites and Dependent Software Packages 2.1 Hardware Pre-Requisites Standard VS Configuration(not including VS 80). A 64K workstation is required for word processing. Approximately 22 megabyte disk space required for OI software. 2.2 Software Pre-Requisites VS OFFICE Indexer is supported with 4.60.10 VS/IIS or greater and VS/IIS Peripherals Release 7.20 or greater on the following operating systems: VS Operating System Release 7.53.00 or greater. VS OFFICE Indexer is supported with WP Plus 3.0 or greater and WP Plus Peripherals Release 3.0, and WP Plus Compact/Recovery Release 1.00.08 on the following operating systems: VS Operating System Release 7.53.00 or greater. The standard versions of the BACKUP, COPY, DMSTX and DISPLAY utilities. 1 megabyte Segment 2 space required for the Background Task. 2.3 Optional Software Wang OFFICE Release 3.02.00.03 or greater 2.4 Installability Customer Installable. OFFICE Indexer can be installed by the customer, with no assistance from Wang personnel. ______________________________________________________________________________ Page 4 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 3.0 Restrictions & Special Considerations 1. If the system needs to be IPLed, be sure to remove the Background Task from the Procedure Queue or run "HALTOI" to shut down the Background Task first. Failure to do this may cause permanent damage to the Background Task Log Files in library OILOG on the OI software volume. It may also be necessary after the IPL to recover the databases @OIDX@ and @OI@ through the DMSTX utility. 2. In order to enter OFFICE Indexer Administration Functions, an user must have System Security Administrator rights. 3. Any User Id under which OFFICE Indexer is run must have at least 1024K (preferably 1536K) of segment 2 memory available. 4. OFFICE Indexer may be configured as a Wang Office application by installing it as a pick on the Wang Office main menu. When this is done by the system administrator it is imperative that the unlink(UNL) option be set to YES. Any programs that use the OI API interface and are being run from the OFFICE main menu should also have the unlink(UNL) option set to YES. 5. In order to successfully run all OFFICE Indexer functions it is strongly suggested that the following system options, settable through the GENEDIT utility, have the indicated values: Maximum Open Files = 35 or greater Maximum Link Levels = 10 or greater Maximum PCEXITs = 8 or greater Modifiable data area default size = 1024 (preferably 1536) 6. The DMSTX utility must reside in the system library on the system volume. 7. Search is only supported on alpha-numeric characters and embeded hyphen, period, comma and apostrophe. 8. If the system also has Wang OFFICE installed, be sure not to remove or rename the screen file "SCREENS". 9. If a user's default Print Mode (as defined by their Logon procedure or as set from the Command Processor) is K(eep) or O(nline), then a request to print a Log File through the Administration screen for the management of Log Files will result in the generation of the print file with a Print Mode of H(old). 10. If a document is created or modified through the OFFICE Indexer at a time when the Office Indexer Background Task is not running, then the summary information entered in the OI for the document will not actually be written into the document summary at that time. This means that if the WP or WP Plus editor is entered directly, examination of the document summary will not reflect the changes made through the OFFICE Indexer. The information in the OFFICE Indexer database will not be written to the document summary until the next indexing occurs. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 5 Release 2.00.00 -- July 1999 11. If the user system does not have PACE, Memory Base, OFFICE Indexer v1.0 or v1.5 installed, then any old PACE Catalog "@PACECAT" in @PACE@ on the system volume may be deleted before installing OFFICE Indexer. 12. The disk volume to have OFFICE Indexer installed on must have the Secure ______ option set to YES. This is being done automatically by the OI ___ installation. However, in the event this gets changed for any reason, to reset it do the following: Go into the Operator's Mode, Press PF(10) DISKs, Press PF(11) Owner Information, Position cursor to the OI software volume, Press PF(10) Change, Tab cursor to Secure field, and set to YES. ______ ___ 13. If OFFICE and/or WP Plus is installed after OFFICE Indexer, it may be necessary to run the "OISTPRIV" procedure in library OILIB on the OI software volume to set privileges to certain programs in the OFFICE Indexer. 14. If after the initial create index is completed, the System Administrator wants to maximize the efficiency of index file usage, or if the maximum extents have exceeded problem occurred while indexing is in progress, the following steps should be executed: Run OIREORG in OILIB on the OI software volume, Enter the File name and the Index Volume name, Press (ENTER) to reorganize the file. 15. The OFFICE Indexer Background Task runs in a Class O initiator. To create a Class O initiator in the Procedure Queue for the Background Task: Go into the Operator Mode, select PF(7) Non-interactive Tasks, position cursor at any AVAILABLE entry and press PF(11) Initiator Control, press PF(6) Control Initiator Scheduling, type in O for Procedure Class, _ P for Dump Option and press (ENTER) to make _ modification. It may be necessary to re-create the Class O initiator after the system is IPLed. A better course of action is to create a permanent Class O initiator. 16. If OI is to be copied to a disk pack on one system, then transported to another system for installation, use BACKUP to copy the entire contents of the OI tape to the disk pack. Be certain that the system used to create the disk pack has DMS/TX activated. If it is not activated, BACKUP will remove all recovery blocks from the DMS/TX files written to the disk. ______________________________________________________________________________ Page 6 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 17. On the data base volume, the library OIEMPTY contains the customized empty data base files. In case the user needs to re-create the index, the System Administrator can copy over library OIEMPTY to library @@OIDX@A on the index volume, and then run the procedure "OIRESET" in OILIB to set OI volume and other program priveleges. 18. There is no support for underline in the programs WPDISP or WPPDISP for displaying WP documents. i. e. if some text are underlined, the underline will not show up when the document is being displayed. 19. In the case of re-installation, do not scratch the data base files, i.e., library @@OIDX@+, before reruning the Installation Procedure. The existing data base will be retained. If the volume specified for the database during installation is different from the old index volume, then the data base files will be copied to the new volume and deleted from the old index volume. If the user wishes to re-create the index instead of using the existing one, then library OIEMPTY on the data base volume should be copied over to library @@OIDX@A. Then run the procedure "OIRESET" and follow the instructions for creating the index. 20. Make sure to use "BACKUP" instead of "COPY" when copying files. 21. At installation, if the volume trying to mount with SECURE option is protected, then the System Administrator must be the owner of the volume for OIMOUNT to succeed. 22. A utility is added to perform reorganization on the WIT files for freeing up the unused space. Use this utility only to free the space that had been used for WIT indexing. Before running this utility, be certain the OI Background Task is not running and no one is running OI either. This process may take several hours to complete. User must be a System Administrator in order to run this utility. run WITREORG in OILIB on the OI volume 23. The Compact and Recovery functions are supported only in the OI Release 1.60.xx through WP Plus Release 3.0. You must have Compact and Recovery Release 1.00.08. 24. Versions 3.02.70 through 3.02.85 of the system utility, COPY, have a bug that affects files with DMSTX recovery blocks. If the users have one of these versions of COPY, then the OIREORG procedure may issue the message "File is already attached to a database. Press ENTER to continue." The message is only a warning. Press ENTER and the program will continue. 25. It is possible when running OI Release 1.60.xx using a database that was converted from Release 1.0 that you will be prompted to specify a password for a document that does not have a password. Simply press ENTER to access the document. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 7 Release 2.00.00 -- July 1999 4.0 Enhancements Year 2000 enhancements were included in release 2.00.00: 1. VS OFFICE Indexer 2.00.00 is year 2000 compliant. This release is functionally equivalent to VS OFFICE Indexer 1.60.15. The following enhancements were included in release 1.60.14: 1. OI was relinked to WPPlus Subroutines version 3.00.05 in order to correct document in use by printing problem. 2. OI now opens a document in Shared mode when it recieves a modification notification from WP or WP Plus. Full Index processing (either automatic or manually invoked) still requires the exclusive use of the document when OI is checking the summary information. ______________________________________________________________________________ Page 8 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 5.0 Problems Corrected The following problems were corrected at release 1.60.01: Problem: P200007760 Status: TEMP FIX 1.60.01 Problem Summary: The OI background task would not index WP Plus documents for which it encountered a return code of "7" upon opening. Problem: P200010520 Status: Temp Fix 1.60.01 Problem Summary: Duplicate of Problem P200007760 described above. The following problems were corrected at release 1.60.02: Problem: P200011375 Status: Temp Fix 1.60.02 WP Plus documents created through OFFICE Indexer were always assigned the language code for English, regardless of the language of the library. Problem: P200010753 Status: Temp Fix 1.60.02 Characters that are valid in German were not being correctly indexed in the translated version of OFFICE Indexer. Problem: P200011427 Status: Temp Fix 1.60.02 Background task was crashing upon encountering a document with an invalid language code. The following problems were corrected at release 1.60.03: Problem: P200007760 Status: TEMP FIX 1.60.03 Problem Summary: The OI background task would not index WP Plus documents for which it encountered a return code of "7" upon opening. This bug was fixed at 1.60.01, but was reintroduced at 1.60.02. Problem: Known Anomoly Status: Temp Fix 1.60.03 Problem Summary: In order to print a WP Plus document from OFFICE Indexer on a LCS-15 printer, users must press PF(9) Full Print Options from the print summary screen. This is because the WP+ Doc Access Routine that OI uses does not support the LCS-15 printer yet. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 9 Release 2.00.00 -- July 1999 The following problems were corrected at release 1.60.04: Problem: P200012736 Status: TEMP FIX 1.60.04 Problem Summary: The title of documents created through WP is not displayed correctly (it is blank) by Office Indexer until the next indexing session by the background task. The code has been corrected. Problem: P200012117 Status: TEMP FIX 1.60.04 Problem Summary: The file protection class on the Copy Book files (include files) released with Office Indexer was incorrect. The files OIADDCOB, OIADDPLI, OIADDC, OIRUNCOB, OIRUNPLI, and OIRUNC all had their protection class set to '@'. This has been correctly changed to '$' so that the files may be read by all users. The following problems were corrected at release 1.60.05: Problem: Unreported Status: TEMP FIX 1.60.05 Problem Summary: The summary information for WP Plus documents that is put into the OI database after creation or updating is garbage. This bug was introduced into 1.60.04. The code has been corrected. The following problems were corrected at release 1.60.06: Problem: P200012117 Status: TEMP FIX 1.60.06 Problem Summary: Print and Save of Results List does not work in some libraries. Either the document is truncated or empty or is never created. Corrected by including a new format line at the beginning of the documents. Problem: P200013741 Status: TEMP FIX 1.60.06 Problem Summary: Print and Save of Results List fails because the document exceeds the maximum allowed extents. Corrected by enlarging the initial extent. Problem: P200012994 Status: FAD Problem Summary: Auto Redlining is enabled when a document is created through OI. This is a consequence of the manner in which OI must create documents. Problem: P200012989 Status: FAD Problem Summary: Multiple archived versions of a document may be retained by OI. ______________________________________________________________________________ Page 10 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 The following problems were corrected at release 1.60.10: Problem: P200014372 Status: TEMP FIX 1.60.10 Problem Summary: Conversion of a 1.0 database to a 1.6 database failed with error code -2146746271. This was traced to an error in the 1.0 database. The problem was circumvented in the conversion process. See known anomaly (7) for a description of a side effect of this fix. Problem: P200015194 Status: TEMP FIX 1.60.10 Problem Summary: Result lists could not be printed through WP Plus libraries that had a default print route defined for them. This problem would also occur when attempting to print a document in such a library through OI. The problem has been corrected. Problem: P200015591 Status: TEMP FIX 1.60.10 Problem Summary: A user who had Read access to a WP Plus library was able to copy a document from that library using OI. WP Plus requires at least Print access in order to copy. OI has been modified to require Print access in order to copy. Problem: P200015361 Status: TEMP FIX 1.60.10 Problem Summary: OI users could neither create new WP Plus documents with passwords or edit existing ones. It was discovered that this problem was introduced in release 1.60.02 when certain character translation problems were corrected. The problem has been corrected. Problem: P200014724 Status: Known anomaly Problem Summary: If a user in OI attempts to display a WP Plus document that another user has open for editting, the function fails without any error message; i.e., the display simply doesn't happen. This was traced to the failure of the display service to return an error code in this situation. Hence OI does not detect a problem. Until such time as a correction can be made in the display utility, this behavior will persist as a known anomaly. The following problems were corrected at release 1.60.12: Problem: P100016262 Status: TEMP FIX 1.60.12 Problem Summary: OI 1.60.11 does not create a complete "Words-in-Text" index for WP+ docs that were created by WP+ older than 3.00. A search will be successful on some words, but not others. The following problems were corrected at release 1.60.14: Problem: P100014617 Status: TEMP FIX 1.60.14 Problem Summary: There is a timing problem with Indexer background task opening a document at the same time as the WP+ QUICKPRINT printing task tries to open document to print. This causes the printer to print the message 'Printout cancelled by System, I/O error'. This occurs with the QUICK PRINT function of WPPLUS. Hot Print and 'regular' WP+ printing do not exhibit this problem. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 11 Release 2.00.00 -- July 1999 The following problems were corrected at release 1.60.15: Problem: P800013957 Status: TEMP FIX 1.60.15 Problem Summary: OI background task, OIDBM, crashes with an EXTRACT message when indexing WP+ documents that reside on disk drives greater than 255. Indexing of document summary works fine, but not full indexing. Problem: P100014510 Status: TEMP FIX 1.60.15 Problem Summary: Reinstallation of OI wipes out existing error log files. The log files should be kept. ______________________________________________________________________________ Page 12 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 6.0 Known Anomalies 1. It is possible that a situation may arise in which it will be impossible to edit WP or WP Plus documents from the Office Indexer. WP and OI both use files created in the library "WPIDS" on the system volume. The files have the name "Uxx" where 'xx' is a two digit hexadecimal number equal to the device number of a workstation. When a user runs WP from the command processor a file is created in the WPIDS library with the appropriate name if it does not already exist (which should only be the case when the current version of WP had not previously been run from that workstation). When the file is created it is assigned the file protection class that the user has defined as his default output file protection class. But if any later user to run WP through OI from that workstation does not have access to the class to which the file was assigned, he will be unable to enter the editor. The solution to this problem is to modify the protection class for the file in the WPIDS library for the workstation from which the user is having trouble to be blank.(Probe F231600) 2. Users may occationally experience a long delay (approx. 40 seconds) before reaching the password screen when attempting to edit certain WP Plus documents through OFFICE Indexer. This should happen rarely and only the first time a document is accessed through OFFICE Indexer after being indexed. 3. When doing create package, users may get a GETPARM screen saying that the user does not have the required access rights for the file @WOCTL@ in library @WOCTL@ on the system volume. This is a Wang OFFICE problem and to work around the problem users should find the protection class of the file @WOCTL@ in library @WOCTL@ on the system volume and assign "WRITE" privilege to that class for the file QPACKSND in library OFFICE on the system volume. 4. F242889 When updating the index through the Admin Function and PF(1) is pressed a few seconds later, the message "Indexing is interrupted" appears. If PF(1) is pressed again the message "Indexing is in progress" reappears. 5. F242890 A document is created from the result list screen. Then an index update is run and a WIT search is done. The new document is not found unless you log out of OI and log back in and redo the search over. 6. An error (P200014372) was reported against release 1.60.00 OI involving conversion of a 1.0 database to a 1.6 database. The conversion failed with error code -2146746271. This was traced to an error in the 1.0 database. The problem was circumvented in the conversion process. As a result, however, a minor anomaly has been introduced into the conversion process. The value of the time for automatic indexing will no longer be transfered from the 1.0 database to the 1.6 database. The time will automatically be reset to midnight (00:00). If the original database had a different value for this variable, then it must be manually reset in the new database after the conversion is complete. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 13 Release 2.00.00 -- July 1999 7. If a user in OI attempts to display a WP Plus document that another user has open for editting, the function fails without any error message; i.e., the display simply doesn't happen. This was traced to the failure of the display service to return an error code in this situation. Hence OI does not detect a problem. Until such time as a correction can be made in the display utility, this behavior will persist as a known anomaly. This problem was entered as P200014724. 8. If a user of OI has Create level access to a WP Plus library, then a problem may arise if the user starts, but then aborts the creation of a document in that library through OI. When creating a document through OI, the user first specifies the library and id on one screen, then is presented with another screen for the entry of the summary information for the document. By the time this screen is presented, OI has created the document (so as to lock down the document id). If the user decides not to complete the process, but to cancel (PF16) the creation, then OI attempts to delete the empty document that it has created. But because the user has only Create rights, not Delete rights, the deletion cannot be performed. As a result, the user is returned to the result list and is presented an error message about insufficient access. This message should simply be ignored. Another consequence, however, is that an empty and untitled document has been created in the library. ______________________________________________________________________________ Page 14 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 7.0 Media Contents 7.1 OI Standard Components on media: Library - OILIB File File File Prot Blocks File Name Type Version Class Alloc Description $NEWS Consec 02.00.00 blank 2 Special Consideration $OI$ Program 02.00.00 @ 21 OI Foreground Task 00000 WP blank 2 WP+ v3.0 RULES table @PACEDDO Indexed $ 28 OI DD Object @PACEDEF Indexed blank 8 OI DDF @PACEMSG Indexed $ 62 PACE Message File ADCREATE Program 02.00.00 # 576 Admin Create Routine ADLIBFUN Program 02.00.00 # 90 Admin WP+ Lib Routine ADMENU Program 02.00.00 # 665 Admin Menu Routine CASEFLIP Consec 00.00.00 $ 1 PACE component CONVERTD Program 02.00.00 # 401 Convert Index Routine DOCSUBS Program 02.00.00 @ 1082 WP+ Doc Access Rtn EMPTYCAT Indexed blank 4 Empty PACE Catalog EMPTYDAT Indexed blank 203 OI Empty Data file EMPTYDOC Indexed blank 632 OI Empty DOCWIT file EMPTYI Indexed blank 21 OI Empty FLDWIT file ERRORMSG Consec $ 2 BG Task Error Msg file GETWPPID Program 01.99.15 @ 105 Create Package file HALTOI Program 02.00.00 @ 2 Shut down BG Task rtn LOGONOI WP blank 21 WP Plus File MBMETA Program 00.00.09 # 5 Check @PACECAT rtn OI Program 02.00.00 @ 1823 OI Foreground Task ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 15 Release 2.00.00 -- July 1999 7.1 OI Standard Components on media: (cont.) Library - OILIB (cont.) File File File Prot Blocks File Name Type Version Class Alloc Description OIADD Program 02.00.00 @ 350 OI Add Entry Rtn OIADDC Consec 01.60.00 @ 7 OIADD Include(C) OIADDCOB Consec 01.60.00 @ 11 OIADD Include(COBOL) OIADDPLI Consec 01.60.00 @ 7 OIADD Include(PL/I) OICAPI Program 02.00.00 @ 4 C to OI interface OICONVRT Consec 01.60.00 # 3 OI Conversion Proc OIDBM Program 02.00.00 @ 655 OI Background Task OIINSTL Consec 02.00.00 # 33 OI Installation Proc OIMENU Consec 02.00.00 # 7 OI Menu Procedure OIMOUNT Program 02.00.00 # 4 OI Mount w/ SECURE OIPRTWPP Program 02.00.00 @ 664 OI WP+ Print Rtn OIREORG Consec 01.60.00 # 4 OI COPY Reorg Proc OIRESET Consec 01.60.00 # 3 OI Reset OIVol proc OIRUNC Consec 01.60.00 $ 8 OIRUN Include(C) OIRUNCOB Consec 01.60.00 $ 10 OIRUN Include(COBOL) OIRUNPLI Consec 01.60.00 $ 6 OIRUN Include(PL/I) OISCREEN Indexed blank 295 OI Screen file OISECURE Program 02.00.00 # 1 OI Set privilege pgm OISTART Program 02.00.00 @ 22 OI Appl Interface OISTPRIV Consec 01.60.00 # 2 OI Set Priv proc OITOV4 WP blank 11 WP Plus File OITOV4M WP blank 4 WP Plus File PACE Program 02.00.80 # 428 PACE Manager(for OI) ______________________________________________________________________________ Page 16 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 7.1 OI Standard Components on media: (cont.) Library - OILIB (cont.) File File File Prot Blocks File Name Type Version Class Alloc Description PACEFRM Indexed # 309 Pace Form PDSCREEN Indexed blank 15 WP Plus Print Screen PROCBG Program 02.00.00 # 4 Gen "OIDBM" proc PROCVOL Program 02.00.00 # 4 Gen "OIVOL" proc QPACKSND Program 02.00.06 @ 564 Create Package rtn REORGSCR Indexed blank 8 WITREORG screen WIISSUBS Program 02.00.00 @ 465 WIIS support rtn WIISVFY Program 02.00.00 @ 18 WIIS support rtn WITREORG Program 02.00.00 # 444 WIT file reorg utility WOISTART WP blank 17 WP Plus File WPDISP Program 99.99.99 @ 52 WP Display pgm WPPDISP Program 02.05.33 @ 143 WP+ Display pgm WPPDISPS Indexed $ 6 WPPDISP Index File WPPIO Program 01.99.15 @ 257 Msg Handling Rtn WZ4DOCX Program 02.00.00 @ 474 DOCWIT Routines XPACEDDO Indexed $ 24 OI 1.0 DD Object (PACE 2.0 Version) XPACEDEF Indexed blank 8 OI 1.0 DDF (PACE 2.0 Version) Library - CSRNLIB File File File Prot Blocks File Name Type Version Class Alloc Description OI020000 Consec blank 28 OI CSRN 2.00.00 MEG SPACE required is 21.70 ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 17 Release 2.00.00 -- July 1999 7.2 After Installation: Library - @SYSTEM@ Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description OI Program 02.00.00 $ 1823 OI Foreground Task OIDBM Consec 01.60.00 $ 1 Background Task Proc OIVOL Consec 01.60.00 $ 1 Find OI Volume Proc HALTOI Program 02.00.00 @ 2 Shut down BG Task rtn Library - DOS Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description OISTART WP Y 17 WP Plus File Library - SYSTEM Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description LOGONOI WP Y 21 WP Plus File Library - WPPLUS Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description OITOV4 WP Y 12 WP Plus File OITOV4M WP Y 4 WP Plus File Library - RULES Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description 00000 WP Z 2 WP+ v3.0 RULES table ______________________________________________________________________________ Page 18 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 Library - @PACE@ Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description @PACECAT Indexed blank 5 PACE Catalog CASEFLIP Consec 00.00.00 $ 1 PACE component Library - OFFICE Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description GETWPPID Program 01.99.15 @ 105 Create Package file QPACKSND Program 02.00.06 @ 564 Create Package rtn WPPIO Program 01.99.15 @ 257 Msg Handling Rtn Library - @DMSTX@ Volume - System Volume File File File Prot Blocks File Name Type Version Class Alloc Description @OI@ $ 1 @DOCWIT@ Recovery Group @PCAT@ $ 1 @PACECAT Recovery Group @OIDX@ $ 1 @OIDX@ Recovery Group ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 19 Release 2.00.00 -- July 1999 Library - OILIB Volume - OI Volume File File File Prot Blocks File Name Type Version Class Alloc Description $NEWS Consec 02.00.00 blank 2 Special Consideration $OI$ Program 02.00.00 @ 21 OI Foreground Task @PACEMSG Indexed $ 62 PACE Message File ADCREATE Program 02.00.00 # 576 Admin Create Routine ADLIBFUN Program 02.00.00 # 90 Admin WP+ Lib Rtn ADMENU Program 02.00.00 # 665 Admin Menu Routine CONVERTD Program 02.00.00 # 401 Convert Index Routine DOCSUBS Program 02.00.00 @ 1082 Doc Access Rtn ERRORMSG Consec $ 2 BG Task Error Msg File MBMETA Program 00.00.09 # 5 Check PACE Catalog rtn OIADD Program 02.00.00 @ 350 OI Add an Entry Routine OIADDC Consec 01.60.00 @ 7 OIADD Include(C) OIADDCOB Consec 01.60.00 @ 11 OIADD Include(COBOL) OIADDPLI Consec 01.60.00 @ 7 OIADD Include(PL/I) OICAPI Program 02.00.00 @ 4 C to OI Interface OICONVRT Consec 01.60.00 # 3 OI Convert Procedure OIDBM Program 02.00.00 @ 655 OI Background Task OIINSTL Consec 02.00.00 # 33 OI Installation Proc OIMENU Consec 02.00.00 # 7 OI Menu Procedure OIMOUNT Program 02.00.00 # 4 OI Mount w/Secure pgm OIPRTWPP Program 02.00.00 @ 664 WPP Print Routine OIREORG Consec 01.60.00 # 4 OI COPY Reorg Procedure ______________________________________________________________________________ Page 20 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 Library - OILIB(cont.) Volume - OI Volume File File File Prot Blocks File Name Type Version Class Alloc Description OIRESET Consec 01.60.00 # 3 OI Reset OI Vol proc OIRUNC Consec 01.60.00 @ 8 OIRUN Include(C) OIRUNCOB Consec 01.60.00 @ 10 OIRUN Include(COBOL) OIRUNPLI Consec 01.60.00 @ 6 OIRUN Include(PL/I) OISECURE Program 02.00.00 # 1 OI set privelege pgm OISTART Program 02.00.00 @ 22 OI Appli Interface OISTPRIV Consec 01.60.00 # 2 OI Set Priv Proc PACE Program 02.00.80 # 428 PACE Manager(for OI) PACEFRM Indexed # 309 Pace Form PDSCREEN Indexed blank 15 WP Plus Print Screen PROCBG Program 02.00.00 # 4 Generate "OIDBM" proc PROCVOL Program 02.00.00 # 4 Generate "OIVOL" proc REORGSCR Indexed blank 8 WITREORG screen WIISSUBS Program 02.00.00 @ 465 WIIS support routine WIISVFY Program 02.00.00 @ 18 WIIS support routine WITREORG Program 02.00.00 # 444 WIT file reorg utility WPDISP Program 99.99.99 @ 52 WP Display program WPPDISP Program 02.05.33 @ 143 WP Plus Display pgm WPPDISPS Indexed $ 6 WPPDISP index file WZ4DOCX Program 02.00.00 @ 474 DOCWIT Routines ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 21 Release 2.00.00 -- July 1999 Library - @@OIDX@3 Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description @PACEMSG Indexed $ 62 PACE Message File OISCREEN Indexed blank 295 OI Screen file Library - @@OIDX@A Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description @@DOCUMN Indexed blank 21 FLDWIT index file @DOCUMNT Indexed blank 203 Data file @DOCWIT@ Indexed blank 632 DOCWIT index file Library - @@OIDX@D Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description @PACEDDO Indexed $ 28 OI DD Object @PACEDEF Indexed blank 3 OI Data Definition Library - OIWPIXJD Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description @PACEDDO Indexed $ 24 OI 1.0 DD Object (PACE 2.0 Version) @PACEDEF Indexed blank 8 OI 1.0 DDF (PACE 2.0 Version) ______________________________________________________________________________ Page 22 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 7.3 Other Files created when OI is running: Library - @@OIDX@B Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description @####UID blank 52 DMS/TX Recovery File Library - OILOG Volume - OI Volume File File File Prot Blocks File Name Type Version Class Alloc Description Lmmdd### blank 26 OI BG Task Log File, created by the BG Task for each index update and at create index time, mm = month dd = day of month ### = file seq number Library - OILIB Volume - Index Volume File File File Prot Blocks File Name Type Version Class Alloc Description FULLINDX blank 1 Full Index Marker File ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 23 Release 2.00.00 -- July 1999 8.0 Software Installation & Operation Information This installation procedure installs the OI application software on the OI volume and creates an empty data base for the index on the index volume you specified. Please follow the instruction steps below to install OI: 1. Ensure no users are running OI, PACE or Memory Base. 2. Run HALTOI to take down the Background Task (OIDBM) if necessary.Also the Object Catalog Server Background Task (OCSZ) needs to be taken down. 3. Log on the system as a SECURITY ADMINISTRATOR.(Segment 2 Address Space must be 1024 or greater for 6.xx Operating Systems, and 1536 or greater for OS 7.10 or higher) 4. Create a Class O initiator slot in the Procedure Queue for the Background Task if one does not already exist. 5. Reorganize the output volume for non-fragmented space if necessary. 6. Mount the provided tape. Set Volume = Volume name, Label = NL Mode = EX 7. Run BACKUP with Function=RESTORE of files OIMENU and OIINSTL in OILIB on the provided tape to OILIB on the OI volume. 8. Run OIMENU in OILIB on the OI volume. 9. The following screen appears, ****************************************************************************** OFFICE Indexer Version 02.00.00 (ENTER) to Install OFFICE Indexer (1) Change Index Volume to (16) Exit ****************************************************************************** 10. Press (ENTER) to install the OFFICE Indexer. 11. DO NOT press PF(1). PF(1) is used to move the existing Index to a different volume. Before moving the Index, make sure no one is running OI, and run HALTOI to take down the Background Task(OIDBM). Refer to the section for moving the index. ______________________________________________________________________________ Page 24 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 12. The following screen appears, ________________________________________________________________________ OFFICE Indexer Installation Procedure Version 02.00.00 INPUT Volume = OI ______ Type = TAPE (DISK, TAPE or DISKETTE) ______ Device = ___ OI Volume = ______ Index Volume = ______ Approximate number of documents to index = 1000 ____ Recovery File Volume = SYSTEM ______ ________________________________________________________________________ ENTER) to Install 16) Exit ________________________________________________________________________ Input Volume - enter the provided tape/disk volume name. Type - enter device type. Device - enter device number. OI Volume - enter the volume name for the OI software. Index Volume - enter the volume name for the index. (this can be the same as OI Volume) Approximate number of documents to index - number of documents on the system to be indexed. Recovery File Volume - usually the system volume. 13. Fill in appropriate information and press (ENTER). 14. Do not dismount the input volume as it is being read now. 15. If the output volume does not have enough space, cancel out the installation and reorganize the output volume before retry the installation. 16. If the system prompts for not enough space for file @DOCWIT@ in OIEMPTY on the Index Volume, the system administrator may decrease the output number of records to a feasible number. 17. An acknowledge message, issued by the VS COPY program, of "File is already attached to a database" for file @@DOCUMN (or @DOCUMNT, or @DOCWIT@) in library OIEMPTY on the index volume may appear. Press (ENTER) to continue. _________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 25 Release 2.00.00 -- July 1999 18. Installing OFFICE Indexer on an O.S. 6.40 system may get a warning message about the required O.S. for PACE is 7.10.00 and the current O.S. is 6.4x.xx. Press (ENTER) to continue. 19. The PACE Data Base Character Set warning screen may appear with the warning message of "YOU MAY CONTINUE TO CATALOG THIS DATA BASE, BUT ITS CHARACTER SET WILL NOT BE CHANGED TO THAT OF THE SYSTEM" if the @OIDX@ data base character set is US English and the system character set is default. Press (ENTER) to continue. 20. If an older version of OFFICE Indexer index exists on a volume that is not mounted, the user may get a PACE Data Base Removal screen with the error message "The data base volume XXXXXX is not currently mounted.". Or if the data base files no longer exist but @OIDX@ is still listed in the PACE catalog, the user may get the error message "The Data Base Definition file (@PACEDEF) cannot be found". The user can press (ENTER) Remove data base from catalog anyway, and the old data base will be removed from the catalog. 21. A Special Consideration Page will be displayed at the end of the installation, read carefully and print a hard copy for future reference. Then press PF(16) to exit. 22. The successful performance of several OFFICE Indexer functions, as well as the maintenance of an accurate index database, depends on the Background Task. This task should always be running when anyone on the system is using OI, and at the time when automatic indexing is scheduled to begin. To help insure this, it is strongly recommended that after the installation is complete, you add the following line to the WSNSTART procedure (or any other procedure that is run each time the system is IPL'ed): SUBMIT OIDBM AS $OIDBM$, CLASS=O It is also important that the Background task not be running when the system is IPL'ed. To help insure this, you should add the following line to the WSNSTOP procedure (or any other procedure that is run just prior to an IPL): RUN HALTOI 23. Refer to Section 10.0 Converting the Index if you have a Release 1.0 index and would like to convert it to the Release 1.6 format. DO NOT ______ run OI before you run OICONVRT. 24. Refer to OI User Manual for OI functionality. _____________________________________________________________________________ Page 26 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 9.0 Installing on a VS 5000 system To install the OFFICE Indexer on a VS 5000 system or any other system which does not have a tape drive or which requires the output volume to be the same as the input volume, follow the Section 8 instruction steps except replace steps 6 and 7 with the following step: Run BACKUP to restore the OILIB on the tape to OILIB on the output volume (the OI/Index Volume). Make sure you specify the same volume name for the input volume, the OI volume and the Index volume. ______________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 27 Release 2.00.00 -- July 1999 10.0 Converting the Index People who have Release 1.0 of the OFFICE Indexer will need to run a one time conversion utility. This is a process to convert the Release 1.0 database to the Release 1.5 form of the database. The conversion utility replaces the database definition and puts the information into the release 1.5 form and writes the records into the database. The objects themselves do not have to be accessed and no conversion is required for the words-in-text portion of the database. To convert the Index, run "OICONVRT" in OILIB on the OI software volume. The following screen appears: _______________________________________________________________________ OFFICE Indexer Convert Index Utility Version 01.60.00 This Utility converts the OI Index from Version 1.0 to Version 1.6. (ENTER) to Proceed (16) Exit ________________________________________________________________________ Press (ENTER) to start the conversion, the message "Index Conversion In Progress" appears on the screen; or press PF(16) to exit without doing the conversion. When the conversion is done, the following message appears: OI Index has been converted successfully. Press (ENTER) to acknowledge and exit. Press (ENTER) and you are returned to the Command Processor screen. NOTE: 1. The old release 1.0 data base files are left undeletd on the system. After the conversion is completed, the user may delete the old data base files if they are not needed any more. 2. DO NOT run OI before you run OICONVRT. If you already ran OI, you need ______ to scratch the library @@OIDX@A on the index volume, copy over library OIEMPTY to library @@OIDX@A, and run OIRESET in OILIB on the OI volume. ________________________________________________________________________ Page 28 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999 11.0 Moving the Index 11.1 Moving the library OILIB (OI software) to a different volume The OI software may be moved to a different volume, i.e. moving the OILIB to a different volume. However, after it is moved the utility "OIRESET" in OILIB on the OI software volume must be run in order to set up the correct OI software volume in the database and certain program privileges in the OI software. 11.2 Moving the OI Index to a different volume Make sure no one is running OI, and run HALTOI to take down the Background Task(OIDBM) first. Run OIMENU in OILIB on the OI volume. _________ The following screen appears, _________________________________________________________________________ OFFICE Indexer Version 02.00.00 (ENTER) to Install OFFICE Indexer (1) Change Index Volume to ______ (16) Exit _________________________________________________________________________ Type in the volume name for the Change Index Volume to field and press PF(1). The message "Move in progress" appears on the screen until the message "Index moved." comes up. Pressing PF(16) then returns you to the Command Processor screen. ________________________________________________________________________ VS OFFICE Indexer Software Release Notice Page 29 Release 2.00.00 -- July 1999 12.0 References VS OFFICE Indexer Users' and Administrator's Guide OFFICE Indexer Functional Specifications _________________________________________________________________________ Page 30 VS OFFICE Indexer Software Release Notice Release 2.00.00 -- July 1999