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


Using Lotus Notes(*)
====================

 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\000xxxxx          (local database)
        <server_name>!!path\database_name\000xxxxx  (remote database)

         [ ...\000xxxxx ] = internal Lotus Notes identifiers

   Since Notes IDs are not meaningful, e.g. neither ID nor sequence are
   of any use, it is advised to always "Select all.." documents for
   queuing.


 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. This normally the concatenated information
                     of the document as defined (shown) in the mentioned View.
                     (Includes all hierarchy levels provided they fit into
                     the internal buffer).
                     Some Titles show multiple "categories" of Views for the same
                     document within its title; therefore some knowledge of
                     the view layout is required in order to find the document.

        Location:    path\database_name - database_title
                     or
                     server_name!!path\database_name - 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 as shown in the
                     "Title".


 Performance:
 ------------

   Due to Lotus Notes inability to extract document information (attributes)
   via API calls in one shot, this may result in performance degradation.
   When displaying the "Result list" the messages have the following meaning:
   1) "Search in progress":   SearchManager is querying its database
   2) "Preparing documents":  A session with Lotus Notes is established in
                              order to retrieve attributes (e.g. view specific
                              information) from the database associated with
                              the found document(s). Required to compose
                              the document title information.

   It is a know problem that when Lotus Notes databases exceed approx.
   15 MByte in size (or >10.000 documents) it take approx. 10 minutes to
   extract document information from specified views (collections).

   Circumvention: SearchManager/2 Library Services for Lotus Notes contain
                  a DLL (dynamic link library) which bypasses document
                  title processing thus reducing lookup time to approx.
                  3 sec.
                  How to:  1) Backup up EHSLSC16.DLL (e.g. EHSLSC16.BAK)
                           2) Copy EHSLSC16.DLQ to EHSLSC16.DLL

                  Note: If the DLL is still active, close all SM/2 windows,
                        shutdown OS/2 and restart the system. After that
                        the DLLs may be exchanged as descirbed above.


 Browsing found documents
 ------------------------

        Extracted document text from a Lotus Notes database may contain
       Hypermedia-links (see also following Chapter!). This is imbedded
       into the original text whenever "DDE"-links are found in the
       document. E.g. if an AmiPro document "D:\AMIPRO\DOCS\TEST.SAM" is
       linked to a Lotus Notes document the following flag is inserted into
       the text (as a separate line) which allows the Browser to establish
       a Hypermedia-Link with the specified application:

       .........................
       <*SAM: D:\AMIPRO\DOCS\TEST.SAM *>
       .........................

       In this case the "Hypermedia" pushbutton is enabled on the Browser
       window and the referenced application (in EHSHMLNK.DAT) is executed.
       The DDE-reference (here: "SAM") is always the same as the
       file-extension.



(*) 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;


