
 IBM SearchManager/2 (Single Workstation) Version 1.0
 Program Number: 5622-018
 Service Level: 0000010
 English

 INSTALLATION
 ============

 Important Notice
 ----------------
   If you have been using the Demonstration version of SearchManager/2
   or the product IBM SearchManager LAN Server/2 and Client/2 Version 1.0,
   Service level 0000000, ensure that you deinstall these programs before
   installing this product.
   You can save your index files before deinstallation; this is
   described in the User's Guide.

   If you have been using IBM SearchManager/2 (Single Workstation)
   Version 1.0, Service level 0000000, you can use the update option
   of the installation program to upgrade to the current service level.
   Be sure to invoke the installation program from the diskette using
   the OS/2 command A:SM2INST.

 Prerequisite: REXX
 ------------------
   SearchManager/2 installation requires OS/2's REXX feature to be
   installed. Use Selective Install of OS/2 to install REXX if you
   excluded it when you installed OS/2.

 If you install only the Online Documentation
 --------------------------------------------
   If you install only the online documentation, the documentation
   is copied to your disk, but no object is created for it on your
   desktop. To look at the documentation, in an OS/2 session use OS/2's
   VIEW program to view the file EHSA7MST.INF which is located in the
   product programs directory that you specified during installation,
   for example:

        VIEW C:\SM2\EHSA7MST.INF

   Note: C:\SM2 is the default SearchManager/2 Product programs
         directory; you may have specified a different name during
         installation.

 Installation verification
 -------------------------
   Some OS/2 2.1 installations may experience problems in displaying the
   metafiles in the sample documents. This is an error in the EPW.EXE
   that has been reported to OS/2 2.1.
   A temporary solution is to remove the RUN statement for the EPW.EXE
   program from your CONFIG.SYS file and to start EPW.EXE from the
   STARTUP.CMD file if required.


 Deleting and updating components of SearchManager/2
 ---------------------------------------------------
   You should delete, install, and update components using the
   Installation Utility object in the product folder. You can also
   do this using the SM2INST command either from the Installation
   diskette or from a directory to which the diskette files
   have been copied. Always access this directory directly before
   entering SM2INST.

   If the SearchManager product folder or the Installation Utility
   is not available, because, for example, deinstallation has been
   interrupted after these objects have been deleted, enter EHSINSTS
   in an OS/2 session to resume deinstallation.

   Use the Update option only to update an installed product to a
   later service level, if available.
   If you need to refresh an existing product at the same level,
   do not use the Update option; instead, delete the product,
   restart the system, and then install the product again.

   If, however, deletion of the product is interrupted and cannot be
   continued, it may be necessary to use the Update option first to
   bring the system back into a state that allows a successful delete
   operation.

 Deleting SearchManager/2 and keeping the document index
 -------------------------------------------------------
   While deleting SearchManager/2 you are prompted if you want to delete
   the document index or if you want to cancel deletion of SearchManager/2.
   You do not need to cancel deinstallation to save your document index files.
   You can save your index files in a separate OS/2 session,
   and then continue with deinstallation.
   However if you have cancelled deinstallation of SearchManager,
   enter EHSINSTS in an OS/2 session to resume deinstallation after
   saving the index files.

 Temporary space requirement during installation
 -----------------------------------------------
   You will need approximately 500 KB free space on the boot disk for
   temporary files during installation.


Hints and tips for SearchManager/2
==================================

 Starting SearchManager/2 under OS/2 2.0 CSD Level XR06055 (ServicePak)
 ----------------------------------------------------------------------
   If you are using SearchManager/2 under OS/2 2.0 CSD Level XR06055
   you may get an Internal Error message when opening the SearchManager/2
   folder. To prevent this error occurring again, move the SearchManager/2
   folder into another folder and restart the system.

 Objects initially out of sight
 ------------------------------
   Depending on the resolution of your display, on some OS/2 installations
   the objects in the SearchManager/2 folder and the Search Service folder
   may initially be scrolled out of sight.
   Use the Arrange option or the scroll bar to make them visible.

 Running many programs on your system
 ------------------------------------
   Make sure that the drive that contains the SWAPPER.DAT file has
   sufficient free space available if you are running many programs
   in parallel. Otherwise the performance of your system will decrease.

 Shutting down your system
 -------------------------
   If you cannot shut down your system, make sure that the Index
   Administration notebook has been closed. Shut down will then continue.

 Restoring the SearchManager/2 Workplace Shell objects
 -----------------------------------------------------
   If the OS/2 INI files were reset or the disk partition containing
   the OS/2 operating system was formatted, the information
   about SearchManager/2 objects is lost.
   The following utility programs are available to restore them:

   - EHSINNEW to register the SearchManager/2 Workplace Shell classes
              and to create the SearchManager/2 product folder on the desktop.
              If the classes are already registered, only the objects are
              created.
     Required parameters are:
        path1: the path where the product programs are installed
               (example: C:\SM2)
        path2: the path where the sample documents are installed
               (example: C:\SM2\DOCS)

   - EHSINDEL to delete/deregister SearchManager/2 objects/classes
     Use one of the following parameters:
        B  to delete the User's Guide object
        S  to delete the local search service
        A  to delete the entire product folder
        R  to deregister all SearchManager/2 Workplace Shell classes


 Cleanup
 -------
   The cleanup function of SearchManager/2 administration is available
   when you use the OS/2 File System library services DLLs
   EHSLSCFS.DLL and EHSLSSFS.DLL shipped with the SearchManager/2 product.

   If you use different library services DLLs, then :
   - the Cleanup push button on the Explicit page of the Administration
     notebook is unavailable.
   - the Cleanup function on the Status page of the Administration notebook
     has the status "Prevented."

   Note: The names EHSLSCFS.DLL and EHSLSSFS.DLL are reserved names and
         must not be used for your own library services unless you want to
         supply a different set of library services for the OS/2 file system.
         If you use these reserved names for a library other than the
         OS/2 File System, then you are able to select the cleanup function,
         but it clears your index, erasing its contents.

 Indexing documents containing large paragraphs
 ----------------------------------------------
   SearchManager/2 can index documents having paragraphs that contain
   up to 2500 lines. An indexing message warns if this number of lines
   is exceeded.

 Using IBM OS/2 LAN Server Version 2.0 or 3.0
 --------------------------------------------
   To index files located on a LAN file server, the following
   CSD level is required on the OS/2 Requester workstations:
   - for IBM LAN Server Version 2.0: CSD level IP06030
   - for IBM LAN Server Version 3.0: CSD level IP07001.

Using Lotus Notes(*)
====================
 The Lotus Notes support was developed using Lotus Notes Version 3 Toolkit
 Beta drivers. If you are using more recent versions, please check with
 your IBM Product Service Operation for additional information.

 You find information on using SearchManager/2 with Lotus Notes
 in the User's Guide 'IBM SearchManager/2: Retrieval and Indexing',
 SH12-5986 under the following index entries:
        Lotus Notes
        document index administration
        document indexing
        document types
        library service
        libraries
        properties

 The following information is not included in the User's Guide:

 Queuing Lotus Notes databases
 -----------------------------
   In the 'Add to Queue' window the 'Documents' list shows a list of names
   identifying the documents. The names have the following format:

        local!!path\database_name\note_id         (local database)
        server_name!!path\database_name\note_id   (remote database)

 Results of a query
 ------------------
   The meaning of the following 'Details' view attributes differ from the
   meaning for the OS/2 file system:

        Title:       a string built from the note summary items, separated
                     by backslashes

        Location:    path\database_name\note_id-database_title
                     or
                     server_name!!path\database_name\note_id-database_title
                     for local and remote databases, respectively.

        Description: Lotus Notes database view title, which, when selected in
                     the Lotus Notes window, lists the document.

 Browsing found documents
 ------------------------
   The browser displays the Lotus Notes field names followed by their values
   converted to ASCII text.
   SearchManager/2 indexes the values of the fields, but not the field names.

(*) Lotus Notes is a trademark of Lotus Development Corporation


Supplement to 'IBM SearchManager/2: Programming Interfaces', SH12-5987
======================================================================
 Chapter 8. Implementing hypermedia links
 ----------------------------------------
   The usability of defining hypermedia links and invoking
   hypermedia services has been enhanced.

  Hypermedia references in ASCII files
  ------------------------------------
   SearchManager/2 now supports hypermedia references in ASCII files.
   A hypermedia reference has the following syntax:

      <*<type>: <objectname>*>

   where

   <* *>        are the begin/end controls of the hypermedia
                reference.

   <type>       is the type of the referenced object.
                The type is an alphanumeric identifier of up to eight
                characters that is looked up in the hypermedia
                reference table EHSHMLNK.DAT.

   <objectname> is the identifier of the referenced object.

   <type> and <objectname> are separated by a ':' followed by a blank.

   Example:

   <*METAFILE: c:\metafiles\tree.met*>

  Programming a hypermedia service for OS/2:
  ------------------------------------------
   Executables (.EXE) and command files (.CMD) are supported.

   It is no longer necessary (but still possible) to program
   a hypermedia service DLL (dynamic link library) to use
   hypermedia references.

   In addition, any program (.EXE) or command file that accepts
   the name of an object to be displayed, presented, or played
   as an input parameter can be dynamically invoked.

   Just add an entry to the hypermedia reference table
   EHSHMLNK.DAT that associates a specific hypermedia
   reference type with the program or command file to be invoked.

   The syntax in EHSHMLNK.DAT
   --------------------------
   To call a DLL, use:

     type=<type>;PROGRAM=<name1>;comment1
   or
     type=<type>;DLL=<name1>;comment1

   To call an EXE, use:

     type=<type>;EXE=<name2> <parms>;comment1

   To call a CMD file, use:

     type=<type>;CMD=<name2> <parms>;comment1

   where

     <type>  is the type of the hypermedia
             object (such as Metafile or Bitmap)

     <name1> is the name of a customer-provided
             DLL with an entry point EHS_HMX
             (see the 'SearchManager/2: Programming Interfaces'
             manual).
             Specify the name without an extension.
             The DLL must be in the LIBPATH.

     <name2> is the name of a customer-provided
             .EXE or .CMD to be started.
             The program must either be located in
             one of the PATH directories, or be
             fully qualified including the correct
             file extension.

     <parms> is the parameter string passed to the
             .EXE or .CMD program. This parameter
             string can contain the following
             substitution characters:

             %d  for the fully qualified document ID
                 of the document that contains the
                 hypermedia reference.

             %o  for the objectname of the
                 hypermedia reference.

     Examples

     type=image;program=ehshihyp;
     type=image;dll=ehshihyp;
     type=metafile;exe=picview %o;
     type=audio;cmd=c:\tools\multimedia.cmd /d%d play %o;

