Feedback


5695-070 IBM SearchManager/370 CICS/MVS or VM V1.3

IBM United States Sales Manual
Revised:  February 02, 2010.

Table of contents  Document options 
TOC Link Product Life Cycle Dates TOC Link Description
TOC Link Program Number TOC Link Technical Description
TOC Link Abstract TOC Link Planning Information
TOC Link Product Positioning TOC Link Security, Auditability, and Control
TOC Link Highlights TOC Link Previous Release(s)
 
Printable version Printable version
 

 
Product Life Cycle Dates
Program NumberVRM Announced Available Marketing Withdrawn Service Discontinued
5684-1431.03.01995/04/261995/07/28 - 2011/04/30
5684-1431.02.01993/09/211994/02/25 - 1998/04/24
5684-1431.01.01991/11/121992/12/24 - 1996/01/31
5695-0701.03.01995/04/261995/04/28 - -
5695-0701.02.01993/09/211993/11/26 - 1998/04/24
5695-0701.01.01991/11/121992/03/27 - 1996/01/31

Back to topBack to top
 
Program Number
  • 5695-070 IBM SearchManager/370 CICS/MVS Version 1 Release 3
  • 5684-143 IBM SearchManager/370 VM Version 1 Release 3

Back to topBack to top
 
Abstract

There Is More Than One Description for This Product

In today's competitive business world, where information is becoming the number one asset, IBM's solution for text retrieval provides advanced free-text search technology.

Easy access to textual information increases corporate, workgroup, and personal productivity. With IBM SearchManager/370 Version 1 Release 3, you can gain this direct and simple access in your host environment.

In conjunction with workgroup capabilities, such as calendaring, editing, and printing, IBM SearchManager/370 gives you a complete Document Management solution. This solution helps you to create, store, retrieve, display, process, and distribute documents that contain text, as well as references to graphics, and images.

IBM SearchManager/370 provides a natural evolution for the users of the predecessor product STAIRS.

IBM SearchManager/370 is an ideal product to help improve performance in the following areas of your business:

  • Office System Support
  • Customer Service
  • Research and Development
  • Human Resources
  • Legal
  • Library
  • Planning
  • Documentation Center

The key enhancements included in Version 1 Release 3 of SearchManger/370 include the following:

  • IBM SearchManager/370 Client for Windows: In addition to the currently available OS/2 Client and non-programmable terminal interface, you can now experience the benefits of this product in the Windows environment.
  • New Wildcard Support: You can now mask search words at the front, middle, and end. In the past, you could only mask search words at the end.
  • Enhanced Database Usage:
    • More databases can be accessed per user. This is increased from 99 databases to 254 databases.
    • You can concatenate 63 databases of your choice based on your needs.
  • Additional STAIRS Functionality: Various options known from the STAIRS SET command have been added.
  • Full ESA support: You can now load IBM SearchManager/370 above 16 MB allowing better use of your storage.

Back to topBack to top
 
Product Positioning

IBM SearchManager/370

IBM SearchManager/370 is IBM's solution for full-text retrieval in the host environment. It is well-suited for the following target applications:

 
Number of documents Hundreds, thousands, millions Document structure Full structure (section, attributes) Document format STAIRS input formats, RFT Document languages Language independent Online update of documents Parallel update Change of document (time) Infrequent change Document location SM/370 database Compound documents Yes, via hypermedia Precise searches Yes Linguistic searches No Boolean searches Yes Proximity searches Yes Wildcard support Yes Security Yes APIs Yes Search concurrent to index build Yes Thesaurus support Yes, available via IBM SearchManager/370 Client/2 feature  
IBM SearchManager/370 Client for Windows feature  

IBM SearchManager/370, with the IBM SearchManager/370 Client/2 feature and the new IBM SearchManager/370 Client for Windows feature, complements SearchManager/2, which is IBM's solution for OS/2-based information retrieval.

IBM SearchManager/2

IBM SearchManager/2 is IBM's solution for text retrieval in the OS/2 Version 2 environment. It offers a powerful, full-text search and retrieval solution, including linguistic support in the single-user and client/server environment. OS/2 and DOS/Windows clients are supported.

In today's competitive business world, where information is becoming the number one capital asset, IBM's solution for text retrieval provides advanced full-text search technology. It enhances corporate, workgroup, and personal productivity by giving you direct and flexible access to textual and other related information.

SearchManager/2 provides a business solution for customers who need the following:

  • A highly precise and accurate full-text information retrieval system

  • A sophisticated knowledge-based query expansion

  • A rapid, single entry-point for searching and retrieving information coming from different sources

IBM SearchManager/2 supports a variety of document formats, types, and languages. The documents may be located in either the OS/2 file system or LOTUS Notes document database. They can also reside in a customer- chosen library for which IBM SearchManager/2 provides the enabling support. Also, SearchManager/2 includes a sample program for searching and retrieving documents in a relational database. The IBM SearchManager/2 end-user interface complies with CUA* 91 architecture (object-oriented workplace model), and is fully integrated into the OS/2 workplace shell. All IBM SearchManager/2 objects are represented as icons and allow for drag-and-drop access. IBM SearchManager/2 offers thesaurus navigation capabilities when used with the IBM Thesaurus End-User System Toolkit/2. It is well-suited for the following target applications:

 
Number of documents Hundreds, thousands Document structure No structure Document format Various formats Document languages Various languages Online update of documents Yes Change of document (time) Frequent change Document location Filesystem, other via API Compound documents Yes, via hyperlink Precise searches Yes Linguistic searches Yes Boolean searches Yes Proximity searches Yes Wildcard support Yes Security Use library security APIs Yes Search concurrent to index build Yes Thesaurus support Via IBM Thesaurus End User System/2  

BookManager

IBM BookManager* provides a tool for customers to develop and deliver softcopy documentation. It is well-suited to handle books that are created by one of the IBM publishing programs. The solution is based on converting machine-readable source files into a form that then can be searched and viewed at display terminals.
Back to topBack to top
 

Highlights

  • Provides a graphical retrieval interface for Windows workstations acting as a client to the MVS or VM server

  • Increases ease-of-use through extended wildcard search capability (front, end and middle masking)

  • Improves usability through expanding the allowed database size

  • Full ESA support

  • Enhanced usability in the MVS environment

  • Offers a business solution for customers who need text retrieval integrated into their business applications

  • Protects the customer investments in office/print/formatter products by using the office/print/formatter of their choice through their own user-written programs.

Back to topBack to top
 
Description

IBM SearchManager/370 Client for Windows

A major enhancement in SM/370 Release 2 was the introduction of a Graphical User Interface (GUI) for the OS/2 workstation, acting as client to an MVS or VM server. This opened the door to client/server processing.

All IBM SearchManager/370 Client/2 objects are represented as graphical symbols (icons). An expert query panel for users who wish to enter their queries in "expert" mode is provided. The IBM SearchManager/370 Client/2 also offers thesaurus navigation capabilities for concept searching when used with the IBM Thesaurus End User System Toolkit.

Knowing that the OS/2 environment provides very rich functionality and therefore is the preferable environment, it is our main objective to provide our customers with support in the environment of their choice. With the size of the Windows community it is therefore a logical step to also provide a GUI offering in support of the Windows environment. Therefore IBM SearchManager/370 Release 3 now introduces a Client for Windows in addition to the already available OS/2 Client. The IBM SearchManager/370 Client for Windows will provide the same functionality as the OS/2 Client in a way natural to the Windows community. The IBM SearchManager/370 Client for Windows is available for the CICS/MVS as well as the VM environment.

Wildcard Support (Front, Middle, and End Masking)

Up until today, IBM SearchManager/370 allows you to mask search words at the end of the search term. With Release 3, this function is expanded to allow front, middle, and end masking. Three different masking characters are defined, and multiple masks can be used in the same search word. This gives the user full Wildcard support with all the benefits of generic searching.

This new Wildcard support requires changes to the IBM SearchManager/370 database structure. A migration aid is provided.

Additional SET Command Options

Various options known from the STAIRS SET command have now also been implemented into IBM SearchManager/370.

  • Occurrence Details

    With IBM SearchManager/370 Release 3, the user can request to see detailed information on the number of occurrences and documents found for every separate search term in the query. This information will be available through the Client/2 only.

  • Highlighting

    This option allows users to specify whether or not search term matches should be highlighted in the document text.

  • Hit Paragraph Display

    With this enhancement the user can now request that paragraphs, containing search term matches, should be displayed in browsed documents even if these paragraphs are not within sections selected for the Browse Profile.

  • Print Settings

    This enhancement allows the user to define the maximum number of lines per document he wants printed. He can also request to have a new page started with every document printed, or to print documents continuously.

More Databases Can Be Accessed Per User

IBM SearchManager/370 Release 2 allows users to access a maximum of 99 databases. With Release 3, this number is increased to allow each user to have access to 254 databases.

Dynamic Concatenation of Databases

Today the system administrator can define a logical database that consists of up to 63 individual concatenated databases. This logical database is available to all users.

In addition to this statically concatenated logical database, IBM SearchManager/370 Release 3 will enable every user to concatenate up to 63 databases of his choice, according to his specific needs. This will be done dynamically, for the present session only. The system administrator defined logical database can be one of the 63 databases the user specifies in the dynamic concatenation.

Full ESA Support

IBM SearchManager/370 Release 3 now provides full ESA support, meaning it can be loaded above the 16M line. This will be available both in the MVS as well as the VM environment.

Enhanced Usability (MVS only)

  • Replace action by "*"

    At the completion of an action, such as print, the action code is replaced by an "*" to indicate "end of action" (successful or not). This will be done for MVS as it is already done for VM today.

  • F11 shows results on saved query

    When displaying the Saved Query pop-up panel, the user can press PF11, requesting to see the results of running the saved query (identified by the cursor location). As a result, the Document List panel will be displayed showing a list of documents containing a match.

  • Online administration for document titles

    IBM SearchManager/370 Release 2 requires the document title to always be taken from the first section. With Release 3, the administrator may choose to have the document title being taken from any section in the document.

  • Automatic adjustment to 32/43 lines for administration panels

    Two Online Administration panels, the Database panel and the User panel, now support 32/43 line display. Depending on the type of terminal session running, IBM SearchManager/370 Release 3 will now make full use of the terminal and therefore give the user the maximum amount of information possible.

Increase Maximum Number of Occurrences

Today SM/370 stops a search whenever the number of occurrences of the search terms is larger than 33 million. In certain cases, this number is reached before all ADJ, NEAR, WITH, SAME, and NOT impacts are evaluated and applied. The end result can very well be very meaningful, even though the initial number of hits seems very large. Therefore IBM SearchManager/370 Release 3 will extend this internally used limit to 64 million.

Database > 2GB

With SM/370 Release 2, the amount of text and data a database may contain is restricted to a maximum of 2 GB. With Release 3, this limit no longer applies. This allows the user greater flexibility.

Save Browse and Print Profile

IBM SearchManager/370 Release 2 allowed users to temporarily change the default setting of the Browse and Print options. These changes were not saved. With Release 3, user changes to Browse/Print profiles can be saved across sessions by simply pressing ENTER after making the changes.

Fast Path Command

IBM SearchManager/370 Release 2 offers various OPTIONS via pull-down panels. One of these is called "Select a different Database". With Release 3, this information can also be entered via a fast-path command, allowing the "DB dbname" to be defined directly on the command line.

Auditing and Logging

With the IBM SearchManager/370 Release 3 for MVS, user exits will be provided to allow the SM/370 installation administrator to capture the query text of each submitted query.

Same as STAIRS Exit 1 and 3 (MVS only).
Back to topBack to top
 

Technical Description
TOC Link Operating Environment TOC Link Hardware Requirements TOC Link Software Requirements


Applications of full-text retrieval can be found in every organization that has a need for direct access to specific items in a large number of documents, such as articles, reports, contracts, laws, general directives, or abstracts of any type of publications. Some examples for full-text retrieval are:

  • Government agencies, police, land registry, legislative and judiciary systems

  • Technical reports in the area of research, development, and manufacturing

  • Media for news gathering, dissemination services, and archiving

  • Libraries and information centers.

Most of the full-text retrieval applications can be implemented with IBM SearchManager/370 entirely without or with only programming effort.

Wherever you need direct access to and retrieval of data, IBM SearchManager/370 is a solution which provides an automated means for such operations.

IBM SearchManager/370 applications provide:

  • Efficient and economical access to large numbers of documents.
  • Full text retrieval based on document content.
  • Client feature with a graphical user interface complying with CUA 91.
  • Expert mode of the End-user interface on workstation clients.
  • Administration session for user registration and database definition or online database creation.
  • Administration session for parallel update of databases.
  • Automatic indexing of words within documents, as part of the database creation process.
  • Acceptance of documents created by DisplayWrite/370
  • Invocation of most functions from user-written programs through an application program interface. (For a description see "IBM SearchManager/370 Application Programming Interfaces" (SH12-5826).)
  • Creation and storage of databases (from individual documents).
  • Expansion of existing database(s).
  • Retrieval of data from databases according to specified criteria and by various methods through an on-line CUA dialog with the system.
  • Retrieved of data for display at a terminal and/or for printing on a high-speed printer.

The computer is used for searching one or many databases. The databases, that is, the total body of information that needs to be searched, are kept available on-line on direct access storage devices.

For the retrieval of data, a structured question must be provided to the system. This question is referred to as a "query". The questions can be very flexible, with no requirement to know predefined index terms. Searches can be made to find any word (except for 'stopwords') or phrase in a document. The answer to the question ('search result') is a list of the documents that satisfy the conditions set by the query.

IBM SearchManager/370 enables the examination of individual documents at a display terminal or printed on paper. Data security is provided at many levels to ensure the integrity of both the system and the data to which it has access.

Full-text retrieval allows users to search on any word, part of a word, phrase or combination of words regardless of location in the document, instead of being able to search only on predefined keywords. The number of keywords is limited and keywords have to be entered manually while in full-text, search terms on the other hand are generated automatically at database creation.

IBM SearchManager/370 offers full-text search capabilities and more. It allows for quick, full-text retrieval in large text databases. The special structure of the IBM SearchManager/370 database is especially suitable for full-text retrieval and ensures good response times. Response times for large databases, with tens of thousands of documents, are fast and about the same as for smaller databases with hundreds of documents.

IBM SearchManager/370 offers a more flexible technique than searching on predefined keywords such as author, subject, publication date, and so on. IBM SearchManager/370 allows the use of operators such as AND, OR, ADJacent to help with locating relevant documents. In addition, IBM SearchManager/370 allows for adding attributes to the document and offers the capability to search on full-text as well as attributes.

Compared to IBM STorage And Information Retrieval System (STAIRS), IBM SearchManager/370 provides the following enhancements:

  • IBM SearchManager/370 provides an easy-to-learn user interface, which complies to the Common User Access (CUA 89 for non-programmable terminals and CUA 91 for workstations) rules specifying a consistent user interface. The IBM SearchManager/370 interface guides casual or new users and simplifies user training and support. It allows experienced users to issue fast-path commands and go directly to specific panels. The user interface supports several different languages, which can be selected at signon time.

    Database search may be based on single words, parts of a word, phrases or combinations of words and can, for example, be specified to be in the same sentence or same section. Queries may be saved or rerun with modifications to help secure relevant information quickly.

  • IBM SearchManager/370 documents can have references or connections to documents or objects (images, graphics, videos, etc.) stored in other sources. IBM SearchManager/370 provides solutions to access text stored on OfficeVision/MVS Document Cabinet, documents containing graphics, and images stored in GDDM controlled files. Connection is achieved through the use of "tags" and programs. Extensions to other libraries, such as DISOSS/370 and ImagePlus, can be achieved through the use of these tags and user programming.

  • IBM SearchManager/370 offers capabilities to integrate with business applications as well as OfficeVision Business applications can issue search requests to IBM SearchManager/370 and obtain the necessary information. For example, integration with OfficeVision/MVS may include retrieving a document from IBM SearchManager/370, including this document in an office document, and mailing it to OfficeVision/MVS users.

  • IBM SearchManager/370 uses its own input format, but provides also conversion programs for RFT documents and flat files. This means that any editor capable of producing RFT documents or flat files may be used to create input for IBM SearchManager/370. For hardcopy documents, the option of scanning documents may be used to create input for IBM SearchManager/370. Through the use of Optical Charakter Recognition (OCR), the noncoded information is converted coded information. Using an IBM supplied conversion program, the coded information is converted to an acceptable input format for storing in IBM SearchManager/370 databases.

  • Security is provided for signon to IBM SearchManager/370 and for accessing information from the text databases. Privacy levels are used to establish security at the database level, document level, attribute level and/or at the section level.

  • IBM SearchManager/370 is the follow-on product to IBM STorage And Information Retrieval System (STAIRS) The migration component of IBM SearchManager/370 for example offers the capability to use the STAIRS/VS user interface in the newest CICS/ESA without any changes to the original STAIRS/VS databases, control files, and Application Programming Interface (API). This allows for a flexible migration schedule yet provides the opportunity to run under CICS/ESA. In addition IBM SearchManager/370 can be run in parallel for STAIRS sharing the same databases.

IBM SearchManager/370 Migration Component under CICS on MVS in addition to IBM STorage And Information Retrieval System (STAIRS) provides the following functions:

  • Support of CICS command level.

  • Support for IBM 3390 DASD.

IBM SearchManager/370 provides coexistence and migration for the users of the predecessor products STAIRS/VS (5740-XR1) Version 1.5.0, and migration for the users of STAIRS/CMS (5664-189) Version 1.2.0 .

CICS on MVS environment

The coexistence of STAIRS/VS (5740-XR1) Version 1.5.0 and IBM SearchManager/370 under CICS on MVS, and the migration of STAIRS/VS (5740-XR1) Version 1.5.0 to IBM SearchManager/370 under VM can be summarized as follows:

  1. Coexistence:
    • IBM SearchManager/370 under CICS on MVS and STAIRS/VS (5740-XR1) are able to coexist on the same CICS system (with a CICS level supported by both products) accessing the same and/or different databases.
    • IBM SearchManager/370 under CICS on MVS and IBM SearchManager/370 Migration Component under CICS on MVS are able to coexist on the same CICS system accessing the same and/or different databases.

  2. Migration

    The migration from STAIRS/VS (5740-XR1) Version 1.5.0 to IBM SearchManager/370 under CICS on MVS can be done in two ways:

    1. STAIRS/VS (5740-XR1) --- > IBM SearchManager/370 under CICS on MVS

      All necessary tools for migrating from STAIRS/VS (5740-XR1) or IBM SearchManager/370 Migration Component under CICS on MVS to IBM SearchManager/370 under CICS on MVS are delivered within the IBM SearchManager/370 Migration Component under CICS on MVS. For migration from the STAIRS/VS (5740-XR1) API to the new IBM SearchManager/370 API, guidance is provided in the "IBM SearchManager/370 Migration Guide for MVS" (SH12-5823), which describes the entire migration in detail.

    2. IBM STorage And Information Retrieval System (STAIRS) --- > IBM SearchManager/370 Migration Component under CICS on MVS - - > IBM SearchManager/370

      The step from IBM STorage And Information Retrieval System (STAIRS) to IBM SearchManager/370 Migration Component under CICS on MVS is the same as the change from one Release to another - since IBM SearchManager/370 Migration Component under CICS on MVS not only works on the original databases but also on the original control files of IBM STorage And Information Retrieval System (STAIRS), and supports the IBM STorage And Information Retrieval System (STAIRS)

      One reason for doing this before migrating to IBM SearchManager/370 may be the support of CICS command level by IBM SearchManager/370 (and IBM SearchManager/370 Migration Component under CICS on MVS) whereas IBM STorage And Information Retrieval System (STAIRS) is bound to CICS macro level. This two-step migration provides application by application migrating at any suitable time (allowing e.g. user training for the new End-user interface) and immediate use of the newest CICS level.

VM Environment

The migration of STAIRS/CMS (5664-189) Version 1.2.0 to IBM SearchManager/370 under VM can be summarized as follows:

  • IBM SearchManager/370 under VM and IBM SearchManager/370 Migration Component under VM are able to coexist on the same VM system accessing the same and/or different databases.

Migration

The migration from STAIRS/CMS (5664-189) Version 1.2.0 to IBM SearchManager/370 under VM is as follows:

STAIRS/CMS (5664-189) --- > IBM SearchManager/370 under VM

All necessary tools for migrating from STAIRS/CMS (5664-189) to IBM SearchManager/370 Migration Component under VM or IBM SearchManager/370 under VM are delivered within the IBM SearchManager/370 Migration Component under VM. For migration from the STAIRS/CMS (5664-189) API to the new IBM SearchManager/370 under VM API, guidance is provided in Appendix F of the "IBM SearchManager/370 Administration Guide for VM" (SH12-5903), which describes the entire migration in detail.

The step from STAIRS/CMS (5664-189) to IBM SearchManager/370 Migration Component under VM is the same as the change from one Release to another - since IBM SearchManager/370 Migration Component under VM works on the renamed original databases but also on the renamed original control files of STAIRS/CMS (5664-189), and supports the STAIRS/CMS (5664-189) API.

One reason to use the IBM SearchManager/370 Migration Component under VM before migrating to IBM SearchManager/370 under VM may be the transition period needed to train the users for the new End-user interface. This migration provides application by application migrating at any suitable time.

Operating Environment

This product uses only existing attachment interfaces.

Hardware Requirements

MVS Requirements

IBM SearchManager/370 under CICS on MVS is designed to run on processors that meet the minimum requirements for the prerequisite operating system, MVS (XA or ESA) with CICS/MVS* or CICS/ESA*, as stated under programming requirements.

VM Environment

IBM SearchManager/370 under VM is designed to run on processors that meet the minimum requirements for the prerequisite operating system VM/SP6, VM/XA*, or VM/ESA* with ISPF and ISPF/PDF as stated in the Programming Requirements section.

OS/2 Environment

The following hardware is required to run the IBM SearchManager/370 Client/2 feature of IBM SearchManager/370 Version 1 Release 3:

  • Any processor supporting OS/2 Warp Version 3 or OS/2 Version 2.11
  • A minimum of 8MB of main storage
  • A minimum of 4MB available disk space
  • Any display station supported by OS/2 Warp Version 3 or OS/2 Version 2.11
  • A mouse supported by OS/2 Warp Version 3 or OS/2 Version 2.11

Windows Environment

The following hardware is required to run the IBM SearchManager/370 Client for Windows feature of IBM SearchManager/370 Version 1 Release 3:

  • IBM Personal System/2 or equivalent with Intel processor 386 (or equivalent) or higher
  • A minimum of 4 MB main storage
  • Disk space of 2.6 MB required by IBM APPC Networking Services for Windows
  • A minimum of 3 MB available disk space to install IBM SearchManager/370 Client for Windows
  • A mouse (recommended)

DASD Devices

IBM SearchManager/370 supports the following DASD:

  • IBM 3330
  • IBM 3340
  • IBM 3350
  • IBM 3375
  • IBM 3380
  • IBM 3390

Display Stations

To perform text functions, IBM SearchManager/370 supports the following display stations:

  • IBM 3278 Model 2, 3, 4, and 5
  • IBM 3279 Model 2 and 3
  • IBM 3178, IBM 3179, IBM 3180
  • IBM 3192, IBM 3193, IBM 3194
  • IBM 3290
  • IBM 3270-PC workstations with Control Program Release 1.22
  • IBM PC and IBM Personal System/2 (PS/2) with 3278/3279 Emulation Adapter
  • IBM PC and IBM PS/2 with OS/2 Communication Manager
  • IBM 3471 InfoWindow
  • IBM 3472 InfoWindow

To perform graphics functions, IBM SearchManager/370 supports the following display stations:

  • IBM 3179-G
  • IBM 3192-G
  • IBM 3193 (Image only)
  • IBM 3278 Model 2, 3, 4, and 5 with PSS
  • IBM 3279 Model 2 and 3 with PSS
  • IBM 3270-PC with PSS
  • IBM 3270-PC/G and PC/GX
  • IBM 3270-PC AT/G and AT/GX
  • IBM 3290
  • IBM PC and IBM PS/2 with 3278/3279 Emulation Adapter and PCLK (PC Program) together with the GDDM-Personal Computer Link Feature (PCLK)
  • IBM PC and IBM PS/2 with OS2 communication Manager and PCLK (PC Program) together with the GDDM-PCLK Feature

Client/Server Environment

To run IBM SearchManager/370 Version 1 Release 3 in a client/server environment, the following equipment is required.

On the Host side

  1. For coaxial connection

    • 3174 with the proper level of micro code

  2. For Token-Ring connection

    • 3174 with Token-Ring adaptor that supports 16/4 Mbps T/R speed OR

    • 3745 with Token-Ring adaptor that supports 16/4 Mbps T/R speed and with the proper level of NCP on 3745 (minimum 5.2)

  3. SDLC connection

    • High speed modem (9600 bps or higher)

  4. For X.25 connection

    • 3745 with NPSI and with the proper level of NCP on the 3745 (minimum 5.2)

    • High speed modem (9600 bps or higher)

OS/2 Side

  1. All PS/2 80386 processors with 8MB memory (minimum)

  2. All PS/2s have to be equipped with one of the following facilities:

    • 3270 connection adaptor

    • IBM Token-Ring adaptor

    • Multiprotocol Adaptor/A (SDLC) with high speed modem (9600 bps or higher)

    • For X.25 interface Co-Processor/2 with high speed modem (9600 bps or higher)

Windows Side

  1. IBM Personal System/2 or equivalent with Intel processor 386 (or equivalent) or higher with 4 MB main memory (minimum)

  2. Disk space of 2.6 MB required by IBM APPC Networking Services for Windows

  3. Disk space of 3 MB to install IBM SearchManager/370 Client for Windows, additional disk space for the local storage of profiles, queries, and documents

  4. All workstations have to be equipped with one of the following facilities:

    • 3270 connection adaptor

    • IBM Token-Ring adaptor

    • Multiprotocol Adaptor/A (SDLC) with high speed modem (9600 bps or higher)

    • For X.25 interface Co-Processor/2 with high speed modem (9600 bps or higher)

Printers

IBM SearchManager/370 supports the following printers:

  • Page Printers: As DisplayWrite/370 is used as a printer driver, all printers supported by DisplayWrite/370 Version 2 can be used when this optional product is installed.

  • Line Printers: IBM printers supporting the 1403 data stream.

Software Requirements

IBM SearchManager/370 CICS/MVS Version 1 Release 3 is designed to operate with the following programs:

  • MVS/SP JES2 Version 2 Release 2.0 (5740-XC6) with MVS/XA Data Facility Product (MVS/XA DFP) Version 2 (5665-XA2)
  • MVS/SP JES3 Version 2 Release 2.1 (5665-291) with MVS/XA DFP Version 2 (5665-XA2)
  • MVS/SP JES2 Version 3 Release 1.3 (5685-001) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/SP JES3 Version 3 Release 1.2 (5685-002) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/ESA SP JES2 Version 4 (5695-047)
  • MVS/ESA SP JES3 Version 4 (5695-048)
  • MVS/ESA SP JES2 Version 5 (5655-068)
  • MVS/ESA SP JES3 Version 5 (5655-069)

And one of the following:

  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS/SP Version 2 and MVS/SP Version 3)
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 2 or Release 3 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • CICS for MVS/ESA Version 4 Release 1 (5655-018) or later (for MVS/SP Version 3, MVS/ESA SP Version 4, and MVS/ESA SP (Version 5)

Note: CICS for MVS/ESA Version 4 Release 1 is also known as Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 4

And all of the following:

  • OS PL/I Library Version 2 Release 3 (5668-911)
  • SMP/E Version 1 Release 5 (5668-949) and above
  • MVS Sort/Merge (5740-SM1) (required for Database Creation)

If the IBM SearchManager/370 Client/2 feature is used with IBM SearchManager/370, the following software is required:

  • OS/2 Warp Version 3 or OS/2 Version 2.11
  • Communications Manager/2 Version 1.0 and above
  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS/SP Version 2 and MVS/SP Version 3) OR
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 2 or Release 3 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 4 Release 1 or Release 2 (5655-018) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • ACF/VTAM Version 3 Release 3 (5665-289) (for MVS/XA)
  • ACF/VTAM Version 3 Release 3 (5685-085) (for MVS/ESA)

If the IBM SearchManager/370 Client for Windows feature is used with IBM SearchManager/370, the following software is required:

  • IBM DOS 5.0 or later, or equivalent
  • Microsoft Windows Version 3.1, or Version 3.11, or later
  • For standalone workstations, IBM APPC Networking Services for Windows
  • For LAN connection, a copy of the current IBM Local Area Network Support Program or its equivalent (the IBM Local Area Network Support Program is supplied with the IBM APPC Networking Services for Windows package)
  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS/SP Version 2 and MVS/SP Version 3) OR
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 2 or Release 3 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 4 Release 1 (5655-018) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • ACF/VTAM Version 3 Release 3 (5665-289) (for MVS/XA)
  • ACF/VTAM Version 3 Release 3 (5685-085) (for MVS/ESA)

If PL/I modules are to be compiled for the IBM SearchManager/370 migration component source feature, the following software is needed:

  • OS PL/I Compiler and Library Version 2 (5668-910)
  • OS PL/I Compiler, Library and Interactive Test Facility Version 2 (5668-909)

Optional Software:

  • IBM Thesaurus End User System Toolkit/2 used
  • Communications Manager/2 Version 1.0, when the optional IBM SearchManager/370 Client/2 feature is used
  • GDDM/MVS Version 2 Release 2 (5665-356), required for image and graphics functions and for various printers if driven by GDDM, and
  • GDDM-PCLK Release 1.1 (PC Program) with the GDDM-PCLK host feature or GDDM-OS/2 Link Version 1.0
  • GDDM/MVS Version 3 Release 1 (5695-167), required for image and graphics functions and for various printers if driven by GDDM, and
  • GDDM-PCLK Release 1.1 (PC Program) with the GDDM-PCLK host feature or GDDM-OS/2 Link Version 1.0
  • OfficeVision/MVS* (OV/MVS) Version 1 Release 3 (5685-106) with Document Writing Feature
  • DisplayWrite/370 MVS/CICS Version 2 Release 2 (5685-101)

IBM SearchManager/370 VM Version 1 Release 3 is designed to operate with one of the following programs:

  • VM/System Product Release 6 (5664-167)
  • VM/XA System Product Release 2.1 (5664-308)
  • VM/ESA Release 1 (5684-112) and subsequent releases
  • VM/ESA Version 2 Release 1 (5654-030) and subsequent releases

Note: The IBM SearchManager/370 Client/2 feature is not supported under VM/XA.

And one of the following:

  • ISPF Version 3 Release 1 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)
  • ISPF Version 3 Release 1 (5684-043) and ISPF/PDF Version 3 Release 2 (5684-123)
  • ISPF Version 3 Release 2 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)
  • ISPF Version 3 Release 2 (5684-043) and ISPF/PDF Version 3 Release 2 (5684-123)

If the IBM SearchManager/370 Client/2 feature is used with IBM SearchManager/370, the following software is required:

  • OS/2 Warp Version 3 or OS/2 Version 2.11
  • Communications Manager/2 Version 1.0 and above
  • ACF/VTAM Version 3 Release 4.1 (5664-280) (for VM/SP)
  • ACF/VTAM Version 3 Release 3 or Release 4 (5684-095) (for VM/ESA)
  • ACF/VTAM Version 4 Release 1 or Release 2 (5654-010) (for VM/ESA)

If the IBM SearchManager/370 Client for Windows feature is used with IBM SearchManager/370, the following software is required:

  • IBM DOS 5.0 or later, or equivalent
  • Microsoft Windows Version 3.1, or Version 3.11, or later
  • For standalone workstations, IBM APPC Networking Services for Windows
  • For LAN connection, a copy of the current IBM Local Area Network Support Program or its equivalent (the IBM Local Area Network Support Program is supplied with the IBM APPC Networking Services for Windows package)
  • ACF/VTAM Version 3 Release 3 (5664-280) (for VM/SP)
  • ACF/VTAM Version 3 Release 3 (5684-095) (for VM/ESA)

Optional Software:

  • IBM Thesaurus End User System Toolkit/2
  • Communications Manager/2 Version 1.0 or above, when the optional IBM SearchManager/370 Client/2 feature is used.
  • GDDM/VM Version 2 Release 2 (5664-200)
  • GDDM/VM Version 3 Release 1.1 (5684-168)
  • GDDM-PCLK Release 1.1 (PC-Program) with the GDDM-PCLK host feature or GDDM-OS/2 Link Version 1.0 (5688-113)
  • OfficeVision/VM (OV/VM) Version 1 Release 2 (5684-084)
  • DisplayWrite/370 VM/CMS Version 2 Release 2 (5684-091)
  • VM Batch Facility Version 2 (5684-137)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 2 Release 3 (5664-188)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 3 (5684-096)
  • Document Composition Facility (DCF) Release 3 (5748-XX9)

Compatibility

IBM SearchManager/370 provides full migration support for existing IBM Storage and Information Retrieval System (STAIRS) installations.

  • STAIRS databases can be searched and maintained by IBM SearchManager/370.

  • IBM administrative datasets, such as user-registration files, can be migrated with IBM-provided utilities.

  • MVS: STAIRS/VS (5740-XR1) and IBM SearchManager/370 under CICS on MVS system can run in parallel using the same STAIRS database within one CICS system (up to and including CICS/ESA Version 3 Release 1 only).

  • VM: IBM SearchManager/370 under VM system uses the same STAIRS/CMS (5664-189) database within one VM system after migration with IBM-provided utilities.

IBM SearchManager/370 Version 1 Release 3 provides full migration for existing IBM SearchManager/370 Version 1 Release 2 installations.

Migration for databases: The new Wildcard Support provided with IBM SearchManager/370 Release 3 requires changes to the SearchManager/370 database structure. Installations wanting to take advantage of the Wildcard feature must migrate their database(s) to the new format. IBM SearchManager/370 Release 3 provides a migration utility which will automatically migrate specified databases if run. No further action on behalf of the user is required.

Limitations

Not applicable.

Performance Considerations

Performance of IBM SearchManager/370 has to be distinguished between IBM SearchManager/370 and IBM SearchManager/370 Migration Component.

  1. IBM SearchManager/370 Migration Component: From a performance view, this component is identical to the STAIRS product, with a well-accepted performance for all kinds of environments and databases reaching multiple gigabyte sizes.

  2. IBM SearchManager/370: The differences to STAIRS concerning performance are in the CUA 89 end-user interface and the new IBM SearchManager/370 Application Programming Interface.

    Since the CUA 89 interface is only a small layer related to the search engine, the performance impact is minimal. The same is true of the new IBM SearchManager/370 API, which works as a small layer on the well-known STAIRS.

    The overall performance of the CICS system, however, should be improved because of the pseudo-conversational implementation of the end- user interface.

    Note: The performance of those functions calling DisplayWrite/370 or OfficeVision, such as export documents with editing or import documents, depend on the performance of the called products.


Back to topBack to top
 
Planning Information

Customer Responsibilities

Installation of a licensed program is the customer's responsibility. Installation of IBM SearchManager/370 is different for the MVS/VM operating environments. The customer should read the applicable sections of the appropriate IBM SearchManager/370 Program Directory.

The IBM SearchManager/370 installation consists of the following major steps:

  • Unloading the distribution tape

  • Tailoring the installation

  • Verifying the installation

Conversion

Installing in MVS:

The IBM SearchManager/370 under CICS on MVS installation uses System Modification Program/Extended (SMP/E).

Installing in VM:

The IBM SearchManager/370 under VM installation uses Virtual Machine Serviceability Enhancements Staged (VMSES) or VMSES/E.
Back to topBack to top
 

Security, Auditability, and Control

These programs use the security and auditability features of the Host software.

IBM SearchManager/370 under CICS on MVS (5695-070)

IBM SearchManager/370 under CICS on MVS provides a means to avoid unauthorized access to its databases. The databases are protected at the database, document, section, and attribute levels.

In addition to the IBM SearchManager/370 security features under CICS on MVS, the security and auditability features depend on the prerequisite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

IBM SearchManager/370 under VM (5684-143)

The security and auditability features of this program depends on the prerequisite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.
Back to topBack to top
 

Previous Release(s)

5695-070 IBM SEARCHMANAGER/370 UNDER CICS ON MVS OR UNDER VM VERSION 1 RELEASE 2

Abstract

  • 5695-070 - SearchManager/370 under CICS on MVS Version 1 Release 2
  • 5684-143 - SearchManager/370 under VM Version 1 Release 2

IBM SearchManager/370 Version 1 Release 2 is a key solution for free- text retrieval of documents consisting of text and related information, such as graphics and images. It provides Boolean and proximity operators and comparison options for full text search and offers them in a Common User Access* (CUA*) 91 graphical-user interface for OS/2* workstations, and in a CUA 89 user-friendly dialog for non-programmable terminals. It also enables customers to use full-text retrieval in their application via an application programming interface (API).

All IBM SearchManager/370 Client/2 objects are represented as graphical symbols (ICONS) and allow for drag-and-drop access. IBM SearchManager/370 Client/2 offers thesaurus navigation capabilities for concept searching when used with the IBM Thesaurus End User System Toolkit. It also offers an expert query panel for users who wish to enter their queries in "expert" mode.

IBM SearchManager/370 provides a natural evolution for the users of the predecessor product STAIRS. When IBM SearchManager/370 is used with OfficeVision*, DisplayWrite*/370, and GDDM, it offers a solution for the creating, storing, retrieving, displaying, processing, and distributing of documents containing text and references to graphics and images.

It also provides the users with the possibility of using the office/print/formatter of their choice through their own user-written programs.

IBM SearchManager/370 Version 1 Release 2 provides an administration session which gives the administrator access to the files containing the parameters of the users, as well as those of the databases, and the facility for creating databases online. This interface is offered using CUA 89 standard and runs on non-programmable terminals or workstations. Using the above functions (administration session), parallel update for SearchManager/370 databases can be achieved.

IBM SearchManager/370 Migration Component, as part of SearchManager/370, provides the STAIRS end-user interface. It can run in parallel to SearchManager/370, both accessing the same indexes and containing all utilities necessary to migrate from an existing STAIRS application to SearchManager/370 at any suitable time.

Product Positioning

IBM SearchManager/370 is IBM's solution for full-text retrieval in the host environment. It is especially well suited for the following target applications:

 
Number of documents hundreds, thousands, millions Document structure full structure (section,attributes) Document format STAIRS input formats, RFT Document languages language independent Online update of documents parallel update Change of document (time) infrequent change Document location SM/370 database Compound documents yes, via hypermedia Precise searches yes Linguistic searches no Boolean searches yes Proximity searches yes Wildcard support yes, endmasking Security yes APIs yes Search concurrent to index build yes Thesaurus support yes, available via IBM SearchManager/370 Client/2 feature  

IBM SearchManager/370 with the new IBM SearchManager/370 Client/2 feature are complementing SearchManager/2, which is IBM's solution for OS/2-based information retrieval.

IBM SearchManager/370 Client/2 and IBM SearchManager/2 have the same look and feel and a common subset of their functions but are not interchangeable.

IBM SearchManager/2 is IBM's solution for text retrieval in the OS/2 Version 2 environment. It offers a powerful full-text search and retrieval solution, including linguistic support in the single-user and client/server environment. OS/2 Version 2 and DOS/Windows clients are supported.

In today's competitive business world, where information is becoming the number one capital asset, IBM's solution for text retrieval provides advanced full-text search technology. It enhances corporate, workgroup, and personal productivity by giving you direct and flexible access to textual and other related information.

SearchManager/2 provides a business solution for customers that need the following:

  • A highly precise and accurate full-text information retrieval system
  • A sophisticated knowledge-based query expansion
  • A rapid, single entry-point for searching and retrieving information coming from different sources.

IBM SearchManager/2 supports a variety of document formats, types, and languages. The documents may be located in either the OS/2 file system or LOTUS Notes document database. They can also reside in a customer- chosen library for which IBM SearchManager/2 provides the enabling support. Also, SearchManager/2 includes a sample program for searching and retrieving documents in a relational database. The IBM SearchManager/2 end-user interface complies with CUA 91 architecture (object-oriented workplace model), and is fully integrated into the OS/2 workplace shell. All IBM SearchManager/2 objects are represented as ICONs and allow for drag-and-drop access. IBM SearchManager/2 offers thesaurus navigation capabilities when used with the IBM Thesaurus End-User System Toolkit/2.

IBM BookManager*: BookManager provides a tool for customers to develop and deliver softcopy documentation. It is well suited to handle books that are created by one of the IBM publishing programs. The solution is based on converting machine-readable source files into a form that then can be searched and viewed at display terminals.

Highlights

  • Provides a graphical retrieval interface for OS/2 workstations acting as a client to an MVS or VM server

  • Offers an expert query panel for users who wish to enter their queries in "expert" mode

  • Provides a CUA 89 dialog for online administration in MVS

  • Offers a business solution for customers who need text retrieval integrated into their business applications

  • Protects the customer investments in office/print/formatter products by using the office/print/formatter of their choice through their own user-written programs.

Description

IBM SearchManager/370 Client/2

IBM SearchManager/370 Version 1 Release 2 offers a graphical-user interface (GUI), complying with CUA 91 (object oriented workplace model) for OS/2 workstations acting as clients to an MVS or VM server.

End-User Productivity - Interoperability Improvements

IBM SearchManager/370 Version 1 Release 2 combines the ease-of-use of an OS/2 client with the power retrieval capabilities of IBM SearchManager/370 that run on an MVS or VM platform (server). It exploits the capabilities of OS/2 Version 2 which is the preferred workstation, by providing a GUI complying with CUA 91, which communicates with the IBM SearchManager/370 search engine on the host (MVS or VM server).

End-User Productivity - Improved Worker Productivity

All IBM SearchManager/370 Client/2 objects are represented as ICONs and allow for drag-and-drop access.

General and Expert Search

IBM SearchManager/370 Client/2 offers an expert query panel for users to formulate a query in "expert" mode.

End-User Productivity - Improved Worker Productivity

In the past, the information retrieval specialist was an expert, not an occasional user. Formulating a query to get the most effective results requires knowledge about the query syntax. To simplify queries and to help increase user productivity and acceptance, IBM SearchManager/370 Client/2 provides a CUA 91 dialog to facilitate searching for information, which is easy to learn and easy to use for novice or occasional users and provides an expert mode for the experienced user. The use of Boolean operators to achieve high recall or precision is possible. The dialog supports National Language Support (NLS).

Investment Protection - Strategic Architectures - Industry Standards

IBM SearchManager/370 expert search adopts ISO/DIS 8777 standard as an architecture in defining the text search syntax. The ISO standard document explains all the possible commands that could be used for interactive text searching.

According to the same document, the architecture could be expanded to include any menu interface, natural language interface, or non-standard ("native") syntax on top of the architecture.

Online Administration

IBM SearchManager/370 Version 1 Release 2 provides an administration session which gives the administrators access to the files containing the parameters of the users, as well as those of the database, and the facility for creating databases online. Using the above functions, parallel update for IBM SearchManager/370 databases can be achieved.

Systems Management - Improved Systems Availability

Administration activities, such as the modification of user registration records and the parameters of the databases, can now be performed online as well as in batch. Administration modifications in the databases will be reflected for any user working on line with IBM SearchManager/370 Version 1 Release 2 without interrupting his work session.

Investment Protection - Strategic Architectures

The online administration interface is complying with CUA 89 standards and uses the same panel layout used for the IBM SearchManager/370 Version 1 Release 1 search dialog.

Office/Print/Formatter of Choice

IBM SearchManager/370 Version 1 Release 2 provides a user exit that allows the user to select the office/print/formatter of the choice.

Investment Protection - Asset protection

By providing user exits, IBM SearchManager/370 Version 1 Release 2 offers a more flexible way for customers to use their preferred office system, printer, or formatter when working with IBM SearchManager/370 documents.

Business Solution - Integration of Business Solutions

IBM SearchManager/370 Version 1 Release 2 enables customers to use and exploit the functionality of OfficeVision/MVS* mail functions, as well as DisplayWrite*/370 (CICS on MVS or VM).

Using OfficeVision, or any other office system, documents (or parts thereof) can be sent directly to another user (MVS environment).

The IBM SearchManager/370 input conversion program allows for creation of structured IBM SearchManager/370 documents using DisplayWrite/370, DisplayWrite/4, and other IBM editors (1403 print output or flat files). The IBM SearchManager/370 output conversion program converts automatically the IBM SearchManager/370 document into a simple RFT DisplayWrite/370 document.

The following is a sample scenario (MVS example):

  • Create documents using DisplayWrite/370

  • Store DisplayWrite/370 documents in IBM SearchManager/370 format in the text database (batch process) for text retrieval.

  • Images and graphics have to be stored outside the IBM SearchManager/370 database by user-written applications. An image product is needed to store and administer the images and graphics. A solution is provided by Graphical Data Display Manager (GDDM), if this optional product is installed.

  • Search for documents

  • Export document's text for use with DisplayWrite/370 (conversion runs in the background)

  • Process these documents:

    • Display and manipulate using DisplayWrite/370

    • Print on any printer supported by DisplayWrite/370, including all point addressable printers.

    • Imbed them in office documents

    • Combine the information to make a report

    • Distribute the information using OfficeVision/MVS.

In an VM environment, IBM SearchManager/370 interfaces to the OfficeVision/VM mail function to send documents stored in IBM SearchManager/370 databases.

Technical Description

Applications of full-text retrieval can be found in every organization that has a need for direct access to specific items in a large number of documents, such as articles, reports, contracts, laws, general directives, or abstracts of any type of publications. Some examples for full-text retrieval are:

  • Government agencies, police, land registry, legislative and judiciary systems

  • Technical reports in the area of research, development, and manufacturing

  • Media for news gathering, dissemination services, and archiving

  • Libraries and information centers.

Most of the full-text retrieval applications can be implemented with IBM SearchManager/370 entirely without or with only programming effort.

Wherever you need direct access to and retrieval of data, IBM SearchManager/370 is a solution which provides an automated means for such operations.

IBM SearchManager/370 applications provide:

  • Efficient and economical access to large numbers of documents.
  • Full text retrieval based on document content.
  • Client feature with a graphical user interface complying with CUA 91.
  • Expert mode of the End-user interface on workstation clients.
  • Administration session for user registration and database definition or online database creation.
  • Administration session for parallel update of databases.
  • Automatic indexing of words within documents, as part of the database creation process.
  • Acceptance of documents created by DisplayWrite/370
  • Invocation of most functions from user-written programs through an application program interface. (For a description see "IBM SearchManager/370 Application Programming Interfaces" (SH12-5826).)
  • Creation and storage of databases (from individual documents).
  • Expansion of existing database(s).
  • Retrieval of data from databases according to specified criteria and by various methods through an on-line CUA dialog with the system.
  • Retrieved of data for display at a terminal and/or for printing on a high-speed printer.

The computer is used for searching one or many databases. The databases, that is, the total body of information that needs to be searched, are kept available on-line on direct access storage devices.

For the retrieval of data, a structured question must be provided to the system. This question is referred to as a "query". The questions can be very flexible, with no requirement to know predefined index terms. Searches can be made to find any word (except for 'stopwords') or phrase in a document. The answer to the question ('search result') is a list of the documents that satisfy the conditions set by the query.

IBM SearchManager/370 enables the examination of individual documents at a display terminal or printed on paper. Data security is provided at many levels to ensure the integrity of both the system and the data to which it has access.

Full-text retrieval allows users to search on any word, part of a word, phrase or combination of words regardless of location in the document, instead of being able to search only on predefined keywords. The number of keywords is limited and keywords have to be entered manually while in full-text, search terms on the other hand are generated automatically at database creation.

IBM SearchManager/370 offers full-text search capabilities and more. It allows for quick, full-text retrieval in large text databases. The special structure of the IBM SearchManager/370 database is especially suitable for full-text retrieval and ensures good response times. Response times for large databases, with tens of thousands of documents, are fast and about the same as for smaller databases with hundreds of documents.

IBM SearchManager/370 offers a more flexible technique than searching on predefined keywords such as author, subject, publication date, and so on. IBM SearchManager/370 allows the use of operators such as AND, OR, ADJacent to help with locating relevant documents. In addition, IBM SearchManager/370 allows for adding attributes to the document and offers the capability to search on full-text as well as attributes.

Compared to IBM STorage and Information Retrieval System (STAIRS), IBM SearchManager/370 provides the following enhancements:

  • IBM SearchManager/370 provides an easy-to-learn user interface, which complies to the Common User Access (CUA 89 for non-programmable terminals and CUA 91 for workstations) rules specifying a consistent user interface. The IBM SearchManager/370 interface guides casual or new users and simplifies user training and support. It allows experienced users to issue fast-path commands and go directly to specific panels. The user interface supports several different languages, which can be selected at signon time.

    Database search may be based on single words, parts of a word, phrases or combinations of words and can, for example, be specified to be in the same sentence or same section. Queries may be saved or rerun with modifications to help secure relevant information quickly.

  • IBM SearchManager/370 documents can have references or connections to documents or objects (images, graphics, videos, .etc.) stored in other sources. IBM SearchManager/370 provides solutions to access text stored on OfficeVision/MVS Document Cabinet, documents containing graphics, and images stored in GDDM controlled files. Connection is achieved through the use of "tags" and programs. Extensions to other libraries, such as DISOSS/370 and ImagePlus, can be achieved through the use of these tags and user programming.

  • IBM SearchManager/370 offers capabilities to integrate with business applications as well as OfficeVision Business applications can issue search requests to IBM SearchManager/370 and obtain the necessary information. For example, integration with OfficeVision/MVS may include retrieving a document from IBM SearchManager/370, including this document in an office document, and mailing it to OfficeVision/MVS users.

  • IBM SearchManager/370 uses its own input format, but provides also conversion programs for RFT documents and flat files. This means that any editor capable of producing RFT documents or flat files may be used to create input for IBM SearchManager/370. For hardcopy documents, the option of scanning documents may be used to create input for IBM SearchManager/370. Through the use of Optical Charakter Recognition (OCR), the noncoded information is converted coded information. Using an IBM supplied conversion program, the coded information is converted to an acceptable input format for storing in IBM SearchManager/370 databases.

  • Security is provided for signon to IBM SearchManager/370 and for accessing information from the text databases. Privacy levels are used to establish security at the database level, document level, attribute level and/or at the section level.

  • IBM SearchManager/370 is the follow-on product to IBM STorage and Information Retrieval System (STAIRS) The migration component of IBM SearchManager/370 for example offers the capability to use the STAIRS/VS user interface in the newest CICS/ESA without any changes to the original STAIRS/VS databases, control files, and Application Programming Interface (API). This allows for a flexible migration schedule yet provides the opportunity to run under CICS/ESA. In addition IBM SearchManager/370 can be run in parallel for STAIRS sharing the same databases.

IBM SearchManager/370 Migration Component under CICS on MVS in addition to IBM STorage and Information Retrieval System (STAIRS) provides the following functions:

  • Support of CICS command level.
  • Support for IBM 3390 DASD.

IBM SearchManager/370 provides coexistence and migration for the users of the predecessor products STAIRS/VS (5740-XR1) Version 1.5.0, and migration for the users of STAIRS/CMS (5664-189) Version 1.2.0.

CICS on MVS environment

The coexistence of STAIRS/VS (5740-XR1) Version 1.5.0 and SearchManager/370 under CICS on MVS, and the migration of STAIRS/VS (5740-XR1) Version 1.5.0 to SearchManager/370 under VM can be summarized as follows:

  1. Coexistence:
    • SearchManager/370 under CICS on MVS and STAIRS/VS (5740-XR1) are able to coexist on the same CICS system (with a CICS level supported by both products) accessing the same and/or different databases.
    • SearchManager/370 under CICS on MVS and IBM SearchManager/370 Migration Component under CICS on MVS are able to coexist on the same CICS system accessing the same and/or different databases.

  2. Migration:

    The migration from STAIRS/VS (5740-XR1) Version 1.5.0 to SearchManager/370 under CICS on MVS can be done in two ways:

    1. STAIRS/VS (5740-XR1) --- > SearchManager/370 under CICS on MVS

      All necessary tools for migrating from STAIRS/VS (5740-XR1) or IBM SearchManager/370 Migration Component under CICS on MVS to SearchManager/370 under CICS on MVS are delivered within the IBM SearchManager/370 Migration Component under CICS on MVS. For migration from the STAIRS/VS (5740-XR1) API to the new IBM SearchManager/370 API, guidance is provided in the "IBM SearchManager/370 Migration Guide for MVS (SH12-5823) which describes the entire migration in detail.

    2. IBM STorage and Information Retrieval System (STAIRS) --- > IBM SearchManager/370 Migration Component under CICS on MVS -- > IBM SearchManager/370

      The step from IBM STorage and Information Retrieval System (STAIRS) to IBM SearchManager/370 Migration Component under CICS on MVS is the same as the change from one Release to another - since IBM SearchManager/370 Migration Component under CICS on MVS not only works on the original databases but also on the original control files of IBM STorage and Information Retrieval System (STAIRS), and supports the IBM STorage and Information Retrieval System (STAIRS)

      One reason for doing this before migrating to IBM SearchManager/370 may be the support of CICS command level by IBM SearchManager/370 (and IBM SearchManager/370 Migration Component under CICS on MVS) whereas IBM STorage and Information Retrieval System (STAIRS) is bound to CICS macro level. This two-step migration provides application by application migrating at any suitable time (allowing e.g. user training for the new End-user interface) and immediate use of the newest CICS level.

VM Environment

The migration of STAIRS/CMS (5664-189) Version 1.2.0 to SearchManager/370 under VM can be summarized as follows:

  • SearchManager/370 under VM and IBM SearchManager/370 Migration Component under VM are able to coexist on the same VM system accessing the same and/or different databases.

Migration

The migration from STAIRS/CMS (5664-189) Version 1.2.0 to SearchManager/370 under VM is as follows:

STAIRS/CMS (5664-189) --- > SearchManager/370 under VM

All necessary tools for migrating from STAIRS/CMS (5664-189) to IBM SearchManager/370 Migration Component under VM or SearchManager/370 under VM are delivered within the IBM SearchManager/370 Migration Component under VM. For migration from the STAIRS/CMS (5664-189) API to the new SearchManager/370 under VM API, guidance is provided in "IBM SearchManager/370 Migration Guide for VM" (SH12-5827) which describes the entire migration in detail.

The step from STAIRS/CMS (5664-189) to IBM SearchManager/370 Migration Component under VM is the same as the change from one Release to another - since IBM SearchManager/370 Migration Component under VM works on the renamed original databases but also on the renamed original control files of STAIRS/CMS (5664-189), and supports the STAIRS/CMS (5664-189) API.

One reason to use the IBM SearchManager/370 Migration Component under VM before migrating to SearchManager/370 under VM may be the transition period needed to train the users for the new End-user interface. This migration provides application by application migrating at any suitable time.

Operating Environment

This product uses only existing attachment interfaces.

Machine Requirements

MVS Environment

SearchManager/370 under CICS on MVS is designed to run on processors that meet the minimum requirements for the prerequisite operating system, MVS (XA or ESA) with CICS/MVS* or CICS/ESA*, as stated under programming requirements.

VM Environment

SearchManager/370 under VM is designed to run on processors that meet the minimum requirements for the prerequisite operating system VM/SP6, VM/XA*, or VM/ESA* with ISPF and ISPF/PDF as stated in the Programming Requirements section.

OS/2 Environment

The following hardware is required to run the IBM SearchManager/370 Client/2 feature of IBM SearchManager/370 Version 1 Release 2:

  • Any processor supporting OS/2 Version 2 and Extended Services Version 1
  • A minimum of 8MB of main storage
  • A minimum of 4MB available disk space
  • Any display station supported by OS/2 Version 2
  • A mouse supported by OS/2 Version 2.

DASD devices

IBM SearchManager/370 supports the following DASD:

  • IBM 3330
  • IBM 3340
  • IBM 3350
  • IBM 3375
  • IBM 3380
  • IBM 3390

Display Stations

To perform text functions, IBM SearchManager/370 supports the following display stations:

  • IBM 3278 Model 2, 3, 4, and 5
  • IBM 3279 Model 2 and 3
  • IBM 3178, IBM 3179, IBM 3180
  • IBM 3192, IBM 3193, IBM 3194
  • IBM 3290
  • IBM 3270-PC workstations with Control Program Release 1.22
  • IBM PC and IBM Personal System/2 (PS/2) with 3278/3279 Emulation Adapter
  • IBM PC and IBM PS/2 with OS/2 Communication Manager
  • IBM 3471 InfoWindow*
  • IBM 3472 InfoWindow

To perform graphics functions, IBM SearchManager/370 supports the following display stations:

  • IBM 3179-G
  • IBM 3192-G
  • IBM 3193 (Image only)
  • IBM 3278 Model 2, 3, 4, and 5 with PSS
  • IBM 3279 Model 2 and 3 with PSS
  • IBM 3270-PC with PSS
  • IBM 3270-PC/G and PC/GX
  • IBM 3270-PC AT/G and AT/GX
  • IBM 3290
  • IBM PC and IBM PS/2 with 3278/3279 Emulation Adapter and PCLK (PC Program) together with the GDDM-Personal Computer Link Feature (PCLK)
  • IBM PC and IBM PS/2 with OS2 communication Manager and PCLK (PC Program) together with the GDDM-PCLK Feature.

Client Server Environment

To run IBM SearchManager/370 Version 1 Release 2 in a client-server environment, the following equipment is required:

On Host side:

  1. For coaxial connection

    • 3174 with the proper level of micro code.

  2. For Token-Ring connection

    • 3174 with Token-Ring adaptor that supports 16/4 Mbps T/R speed OR

    • 3745 with Token-Ring adaptor that supports 16/4 Mbps T/R speed and with the proper level of NCP on 3745 (minimum 5.2).

  3. SDLC connection

    • High speed modem (9600 bps or higher).

  4. For X.25 connection

    • 3745 with NPSI and with the proper level of NCP on the 3745 (minimum 5.2)

    • High speed modem (9600 bps or higher).

OS/2 side:

  1. All PS/2 80386 processors with 8 MB memory (minimum).

  2. All PS/2s have to be equipped with one of the following facilities:

    • 3270 connection adaptor

    • IBM Token-Ring adaptor

    • Multiprotocol Adaptor/A (SDLC) with high speed modem (9600 bps or higher)

    • For X.25 interface Co-Processor/2 with high speed modem (9600 bps or higher).

Printers

IBM SearchManager/370 supports the following printers:

  • Page Printers: As DisplayWrite/370 is used as a printer driver, all printers supported by DisplayWrite/370 Version 2 can be used when this optional product is installed.

  • Line Printers: IBM printers supporting the 1403 data stream.

Programming Requirements

IBM SearchManager/370 CICS/MVS Version 1 Release 2 is designed to operate with these programs.

  • MVS/SP JES2 Version 2 Release 1.2 (5740-XC6) with MVS/XA Data Facility Product (MVS/XA DFP) Version 2 (5665-XA2)
  • MVS/SP JES3 Version 2 Release 1.2 (5665-291) with MVS/XA DFP Version 2 (5665-XA2)
  • MVS/SP JES2 Version 3 Release 1 (5685-001) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/SP JES3 Version 3 Release 1 (5685-002) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/ESA SP JES2 Version 4 (5695-047)
  • MVS/ESA SP JES3 Version 4 (5695-048).

And one of the following:

  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS/SP Version 2 and MVS/SP Version 3)
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 2 or Release 3 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4).

And all of the following:

  • OS PL/I Library Version 2 Release 3 (5668-911)
  • SMP/E Version1 Release 5 (5668-949)
  • MVS Sort/Merge (5740-SM1) (required for Database Creation).

If the IBM SearchManager/370 Client/2 feature is used with IBM SearchManager/370, the following software is required:

  • OS/2 Version 2 Base
  • OS/2 Version 2 Extended Services
  • Communications Manager/2 Version 1.0
  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS/SP Version 2 and MVS/SP Version 3) or
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 2 or Release 3 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4)
  • VTAM Version 3 Release 3 (5665-289) for MVS/XA
  • VTAM Version 3 Release 3 (5685-085) for MVS/ESA.

If PL/I modules are to be compiled for the IBM SearchManager/370 migration component source feature, the following software is needed:

  • OS PL/I Compiler and Library Version 2 (5668-910)
  • OS PL/I Compiler, Library and Interactive Test Facility Version 2 (5668-909).

Optional Software

  • IBM Thesaurus End User System Toolkit/2
  • OS/2 Version 2 Base, when the optional IBM SearchManager/370 Client/2 feature is used.
  • OS/2 Version 2 Extended Services, when the optional IBM SearchManager/370 Client/2 feature is used.
  • Communications Manager/2 Version 1.0, when the optional IBM SearchManager/370 Client/2 feature is used.
  • GDDM/MVS Version 2 Release 2 (5665-356), required for image and graphics functions and for various printers if driven by GDDM, and
  • GDDM-PCLK Release 1.1 (PC Program) with the GDDM-PCLK host feature or GDDM-OS/2 Link Version 1.0
  • OfficeVision/MVS(TM) (OV/MVS) Version 1 Release 2 (5685-106) with Document Writing Feature
  • DisplayWrite/370 MVS/CICS Version 2 Release 1 (5685-101).

IBM SearchManager/370 VM Version 1 Release 2 is designed to operate with the following programs:

One of the following:

  • VM/System Product Release 6 (5664-167)
  • VM/XA System Product Release 2.1 (5664-308)
  • VM/ESA Release 1 (5684-112) and subsequent releases.

Note: The IBM SearchManager/370 Client/2 feature is not supported under VM/XA.

And one of the following:

  • ISPF Version 3 Release 1 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)
  • ISPF Version 3 Release 1 (5684-043) and ISPF/PDF Version 3 Release 2 (5684-123)
  • ISPF Version 3 Release 2 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)
  • ISPF Version 3 Release 2 (5684-043) and ISPF/PDF Version 3 Release 2 (5684-123).

If the IBM SearchManager/370 Client/2 feature is used with IBM SearchManager/370, the following software is required:

  • OS/2 Version 2 Base
  • OS/2 Version 2 Extended Services
  • Communications Manager/2 Version 1.0
  • VTAM Version 3 Release 3 (5664-280) for VM/SP
  • VTAM Version 3 Release 3 (5684-095) for VM/ESA.

Optional Software:

  • IBM Thesaurus End User System Toolkit/2
  • OS/2 Version 2 Base, when the optional IBM SearchManager/370 Client/2 feature is used
  • OS/2 Version 2 Extended Services, when the optional IBM SearchManager/370 Client/2 feature is used
  • Communications Manager/2 Version 1.0, when the optional IBM SearchManager/370 Client/2 feature is used.
  • GDDM/VM Version 2 Release 2 (5664-200) Release 2
  • GDDM-PCLK Release 1.1 (PC-Program) with the GDDM-PCLK host feature or GDDM-OS/2 Link Version 1.0 (5688-113)
  • OfficeVision/VM (OV/VM) Version 1 Release 1 (5684-084)
  • OfficeVision/VM (OV/VM) Version 1 Release 2 (5684-084)
  • DisplayWrite/370 VM/CMS Version 2 Release 1 (5684-091)
  • VM Batch Facility Version 2 (5684-137)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 2 Release 3 (5664-188)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 3 (5684-096)
  • Document Composition Facility (DCF) Release 3 (5748-XX9)

Compatibility

IBM SearchManager/370 provides full migration support for existing IBM Storage and Information Retrieval System (STAIRS) installations.

  • IBM Storage and Information Retrieval System (STAIRS) databases can be searched and maintained by IBM SearchManager/370.

  • IBM Storage and Information Retrieval System (STAIRS) administrative datasets, such as user registration files, can be migrated with IBM-provided utilities.

  • MVS: STAIRS/VS (5740-XR1) and SearchManager/370 under CICS on MVS system can run in parallel using the same IBM Storage and Information Retrieval System (STAIRS) database within one CICS system (up to and including CICS/ESA Version 3 Release 1 only).

  • VM: SearchManager/370 under VM system uses the same STAIRS/CMS (5664-189) database within one VM system after migration with IBM-provided utilities.

IBM SearchManager/370 Version 1 Release 2 provides full migration for existing IBM SearchManager/370 Version 1 Release 1 installations.

  • Current query files can be migrated with IBM-provided utilities.

  • IBM SearchManager/370 Version 1 Release 1 database control block (DBCB) dataset can be migrated with IBM-provided utilities.

  • MVS: IBM SearchManager/370 Version 1 Release 1 transactions can be migrated with IBM-provided utilities.

  • VM: IBM SearchManager/370 Version 1 Release 1 user profiles can be migrated with IBM-provided utilities.

Limitations

Not applicable.

Performance Considerations

Performance of IBM SearchManager/370 Version 1 Release 2 has been optimized. In the areas of displaying and browsing documents or result lists the performance has been significantly improved compared to that of IBM SearchManager/370 Version 1 Release 1.

Performance of IBM SearchManager/370 has to be distinguished between IBM SearchManager/370 and IBM SearchManager/370 Migration Component.

  1. IBM SearchManager/370 Migration Component: From a performance view, this component is identical to the IBM Storage and Information Retrieval System (STAIRS) product, with a well-accepted performance for all kinds of environments and databases reaching multiple gigabyte sizes.

  2. IBM SearchManager/370: The differences to IBM Storage and Information Retrieval System (STAIRS) concerning performance are in the CUA 89 end-user interface and the new IBM SearchManager/370 Application Programming Interface.

    Since the CUA 89 interface is only a small layer related to the search engine, the performance impact is minimal. The same is true of the new IBM SearchManager/370 API, which works as a small layer on the well-known IBM Storage and Information Retrieval System (STAIRS).

    The overall performance of the CICS system, however, should be improved because of the pseudo-conversational implementation of the end- user interface.

    Note: The performance of those functions calling DisplayWrite/370 or OfficeVision, such as export documents with editing or import documents, depend on the performance of the called products.

Planning Information

Customer Responsibilities

Installation of a licensed program is the customer's responsibility. Installation of IBM SearchManager/370 is different for the MVS/VM operating environments. The customer should read the applicable sections of the appropriate IBM SearchManager/370 Program Directory.

The IBM SearchManager/370 installation consists of the following major steps:

  • Unloading the distribution tape
  • Tailoring the installation
  • Verifying the installation.

Installing in MVS:

The SearchManager/370 under CICS on MVS installation uses System Modification Program/Extended (SMP/E).

Installing in VM:

The SearchManager/370 under VM installation uses Virtual Machine Serviceability Enhancements Staged (VMSES) or VMSES/E.

Conversion

Not applicable.

Security, Auditability and Control

IBM SearchManager/370 under CICS o MVS (5695-070)

SearchManager/370 under CICS on MVS provides a means to avoid unauthorized access to its databases. The databases are protected at the database, document, section, and attribute levels.

In addition to the IBM SearchManager/370 security features under CICS on MVS, the security and auditability features depend on the prerequisite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

IBM SearchManager/370 under VM (5684-143)

The security and auditability features of the announced program depend on the prerequisite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

Publications

For a current list of publications, contact your local IBM representative.

5695-070 - IBM SEARCHMANAGER/370 UNDER CICS ON MVS OR UNDER VM VERSION1 RELEASE 1

Abstract

(For IBM US, Program Services Discontinued as of January 31, 1996)

IBM SearchManager/370 is a key IBM solution for full-text retrieval of documents consisting of text, graphics and/or images. It provides Boolean and context operators for full-text search, offers them in a CUA* 89 user-friendly dialog, and enables customers to use full-text retrieval also in their applications via an application programming interface (API).

The IBM SearchManager/370 Migration Component provides migration and coexistence for users of the predecessor products STorage And Information Retrieval System (STAIRS) in both the MVS and VM environments. When IBM SearchManager/370 is used in conjunction with OfficeVision*/MVS and its Document Writing Feature (DisplayWrite/370* MVS environment) or with OfficeVision/VM and DisplayWrite/370 (VM environment), and the Graphical Data Display Manager (GDDM*), it offers a solution for creating, storing, retrieving, displaying, processing, and distributing of documents consisting of text, graphics and/or images.

In a VM environment, IBM SearchManager/370 interfaces to the OfficeVision/VM mail function to send documents stored in IBM SearchManager/370 databases.

Product Positioning

IBM SearchManager/370 is a key IBM solution for full text retrieval of documents. Documents can consist of text, graphics and/or images. It provides Boolean and context operators for full text search and presents them in a CUA 89 user-friendly dialog. IBM SearchManager/370 enables customers to use full text retrieval also in their applications by offering an application programming interface (API).

It provides a solution wherever the need for efficient and economical access is needed for large number of documents and/or a large number of users. An IBM SearchManager/370 search for information takes a fraction of the time usually required for a manual search. In addition, the mechanized search can find more relevant documents for the user than a manual search.

IBM SearchManager/370 provides a natural evolution for the users of the predecessor products STorage And Information Retrieval System (STAIRS) in both the MVS and VM environments. When IBM SearchManager/370 is used with OfficeVision/MVS and its Document Writing Feature (DisplayWrite/370 - MVS environment) or with OfficeVision/VM and DisplayWrite/370 (VM environment), and the Graphical Data Display Manager (GDDM), it provides a solution for creating, storing, retrieving, displaying, processing and further distribution of compound documents consisting of text, graphics and/or images.

In an VM environment, IBM SearchManager/370 interfaces to the OfficeVision/VM mail function to send documents stored in IBM SearchManager/370 databases.

User written applications can be called within the 'browsing' function using tagged parameters within the document or other text information.

IBM SearchManager/370 Migration Component as part of IBM SearchManager/370 provides the IBM STorage and Information Retrieval System (STAIRS) End-user Interface. It can be run in parallel to IBM SearchManager/370 and contains all utilities necessary to migrate from an existing IBM STorage and Information Retrieval System (STAIRS) application to IBM SearchManager/370.

Licensed Programs with Similar Functions

IBM Storage and Retrieval System (STAIRS)

STAIRS is a general purpose information storage and search and retrieval program that handles online storage and retrieval of text documents. STAIRS/VS and STAIRS/CMS are the predecessor products for IBM SearchManager/370.

IBM BookManager*

BookManager provides a tool for customers to develop and deliver softcopy documentation. It is well suited to handle books that are created by one of the IBM publishing programs. The solution is based on converting machine-readable source files into a form that then can be searched and viewed at display terminals.

BookManager BUILD is a licensed program that creates an online book and provides the tool for customers to develop and deliver their own softcopy documentation. BookManager BUILD accepts many existing source text files (for example, Bookmaster, Document Composition Facility (DCF), standard general mark-up langugae (SGML)) as input for online books and provides formatting and data compression on the resulting file. Graphics and Images may be component parts of a book built for online use. BookManager READ is a licensed program that provides users the ability to search, view, make notes and print online information as is traditionally done in hardcopy documents.

IBM Licensed Programs with Complementary Functions

ImagePLUS*

ImagePlus facilitates the conversion of a paper-based storage and retrieval system to a computer-based image storage and retrieval system.

ImagePlus consists of a set of components, including application and storage management software, online optical storage, and image workstations which provide a comprehensive hardware and software solution. The functions allow users to:

  • Scan large volumes of hard-copy documents
  • Store the electronic images of the documents in electronic folders (optical and magnetic storage)
  • Retrieve/display/print the document image
  • Fast access to documents is achieved through the use of multiple folder indexes
  • Route and distribute documents for processing (workflow management).

Highlights

  • Provides a business solution for customers who need a high precision information retrieval system either stand alone or integrated in Office applications, by supporting and exploiting OfficeVision/MVS and OfficeVision/VM for integration with office functions and for networking purposes; IBM SearchManager/370 uses DisplayWrite/370 as an editor and printer driver. In a VM environment, I BM SearchManager/370 interfaces to the OfficeVision/VM mail function to send documents stored in IBM SearchManager/370 databases.

  • Helps increase user productivity and acceptance in the customer environment by providing a CUA 89 retrieval dialog to facilitate searching for information, which may consist of text and associated information like images/graphics (implemented via hypermedia references).

  • By pursuing the technology of the predecessor products STAIRS/VS CICS and STAIRS/CMS, IBM SearchManager/370 protects the customer investment; IBM SearchManager/370 accepts documents stored in STAIRS text data bases.

  • By utilizing current hardware and system software and offering an application program interface (API) IBM SearchManager/370 allows for future growth in the customers organizations.

  • Improved systems management with simplified user training and support of compound documents containing images/graphics.

Description

Investment Protection

As IBM SearchManager/370 is based on the STAIRS technology, information can still be stored and recalled from STAIRS data bases, thus protecting the customer's investment in collecting and storing this information.

IBM SearchManager/370 will be delivered as object code only (OCO). Yet, customer-written programs that were coded to make use of STAIRS API can be adapted/changed to work with the IBM SearchManager/370 API.

IBM SearchManager/370 Migration Component as part of IBM SearchManager/370 provides the IBM STorage and Information Retrieval System (STAIRS) End-user interface. It can be run in parallel to IBM SearchManager/370 both accessing the same index, and contains all utilities necessary to migrate from an existing IBM STorage and Information Retrieval System (STAIRS) application to IBM SearchManager/370 at any suitable time.

The source code of IBM SearchManager/370 Migration Component will be available to ease migration and allow for the transition from source code to object code for those customers who have changed STAIRS/VS (5740-XR1) or STAIRS/CMS (5664-289) source code.

User Productivity

In the past, the information retrieval specialist was rather an expert than an occasional user. How to formulate a query to get the most effective result required knowledge about the query syntax. To simplify queries and to help increase user productivity and acceptance, IBM SearchManager/370 provides a CUA 89 dialog to facilitate searching for information, which is easy to learn and easy to use for novice or occasional users and provides fast-path commands for the experienced user. The use of Boolean operators to achieve high recall or precision is possible. The dialog supports National Language Support (NLS).

Business Solution

Wherever there is a need for direct access to specific items in a large number of documents, such as articles, reports, contracts, laws, general directives, or abstracts of any type of publications, IBM SearchManager/370 helps the user to find and extract the relevant documents. Some important application areas for this program system are:

  • Government agencies, i.e., information centers, police, land registry, personnel skills, legislative and judiciary systems

  • Research, development and manufacturing function technical reports, test reports, skills/expertise inventories

  • Media for news gathering, dissemination services and archives

  • All types of libraries and information centers.

IBM SearchManager/370 provides a broad spectrum of search capabilities as well as flexible and varied output options for retrieved documents.

Many business documents contain not only text but also images or graphics. These images or graphics can be critical information that is needed in a process. IBM SearchManager/370 allows for display of images/graphics contained in documents, with help of the hypermedia references.

In addition, IBM SearchManager/370 enables customers to use and exploit the functionality of IBM OfficeVision/MVS mail functions, as well as DisplayWrite/370 (CICS on MVS, VM).

Using IBM OfficeVision, documents (or parts thereof) can be sent to the owner's In-basket for further processing or can be sent directly to another user (MVS environment).

The IBM SearchManager/370 input conversion program allows for creation of structured IBM SearchManager/370 documents using DisplayWrite/370, DisplayWrite/4 and other IBM editors (1403 print output or flat files). The IBM SearchManager/370 output conversion program converts automatically the IBM SearchManager/370 document into a simple RFT DisplayWrite/370 document.

The following is a sample scenario (MVS example):

  • Create documents using DisplayWrite/370

  • Store DisplayWrite/370 documents in IBM SearchManager/370 format in the text database (batch process) for text retrieval.

  • Images and graphics have to be stored outside the IBM SearchManager/370 database by user-written applications. An image product is needed to store and administer the images and graphics, a solution is provided by Graphical Data Display Manager (GDDM), if this optional product is installed.

  • Search for documents

  • Export document's text for use with DisplayWrite/370 (conversion runs in the background)

  • Process these documents:
    • Display and manipulate using DisplayWrite/370
    • Print on any printer supported by DisplayWrite/370, including all point addressable printers.
    • Imbed them in office documents
    • Combine the information to make a report
    • Distribute the information using OfficeVision/MVS.

In a VM environment, IBM SearchManager/370 interfaces to the OfficeVision/VM mail function to send documents stored in IBM SearchManager/370 databases.

Growth Enablement

By utilizing MVS CICS/ESA, CICS/MVS and VM/ESA in toleration mode, IBM SearchManager/370 allows for future growth of the customer environment.

By supporting both small and/or large user groups concurrently with many databases, IBM SearchManager/370 allows for future growth of the customers environment.

Systems Management

The CUA 89 dialog and on-line help simplifies user training and support.

Batch utilities allow for creation of data bases from previously created documents.

An enhanced API for search requests and search result handling, compared to IBM STorage and Information Retrieval System (STAIRS), allows for integration into the customer applications.

By providing access control for the data bases, IBM SearchManager/370 under CICS on MVS allows for individual security management with privacy- protection at the database, document sections and attribute levels.

Technical Description

Increasing volumes of data are being handled each year, making it more expensive and time consuming to file and retrieve documents manually. Wherever you need direct access to and retrieval of data, IBM SearchManager/370 is a solution which provides an automated means for such operations.

IBM SearchManager/370 applications provide:

  • Efficient and economical access to large numbers of documents.
  • Full text retrieval based on document content.
  • Automatic indexing of words within documents, as part of the database creation process.
  • Acceptance of documents created by IBM DisplayWrite/370.
  • Invocation of most functions from user-written programs through an application program interface. (For a description, see "IBM SearchManager/370 under CICS on MVS Application Programming Interfaces" (SH12-5826).)
  • Creation and storage of databases (from individual documents).
  • Expansion of existing database(s).
  • Retrieval of data from databases according to specified criteria and by various methods through an on-line CUA dialog with the system.
  • Retrieved of data for display at a terminal and/or for printing on a high-speed printer.

The computer is used for searching one or many databases. The databases, that is, the total body of information that needs to be searched, are kept available on-line on direct access storage devices.

For the retrieval of data, a structured question must be provided to the system. This question is referred to as a "query". The questions can be very flexible, with no requirement to know predefined index terms. Searches can be made to find any word (except for 'stopwords') or phrase in a document. The answer to the question ('search result') is a list of the documents that satisfy the conditions set by the query.

IBM SearchManager/370 enables the examination of individual documents at a display terminal or printed on paper. Data security is provided at many levels to ensure the integrity of both the system and the data to which it has access.

IBM SearchManager/370 is based on the indexing techniques and the search engine of IBM STorage and Information Retrieval System (STAIRS) and, for the most part, provides the same or similar basic functions as IBM STorage and Information Retrieval System (STAIRS). Like IBM STorage and Information Retrieval System (STAIRS), IBM SearchManager/370 can be used as a stand-alone information-retrieval application, with an interactive retrieval dialog and batch document indexing and database maintenance functions. Or, it can be used, through its application programming interface (API), as a retrieval service by other information- handling applications.

Compared to IBM STorage and Information Retrieval System (STAIRS), IBM SearchManager/370 provides the following enhancements:

  • Retrieval Dialog, conforming to CUA 89 User guidelines for non- programmable terminals. This dialog is easy to learn and easy to use for novice or infrequent users and provides fast-path commands for the experienced user.

  • Enhanced API for search requests and search result. For IBM SearchManager/370 under CICS on MVS, it handles and supports the programming languages Assembler H Version 2, OS PL/I Version 2 and VS COBOL II.

  • Support for Compound Documents (documents containing text, images, and/or graphics).

  • Enabling support for general Hypermedia Reference Processors, IBM SearchManager/370 documents can contain tags that define links to related information (or processes); the IBM SearchManager/370 retrieval dialog can invoke processors that handle these links.

  • OfficeVision Connectivity support, including document transfer between IBM SearchManager/370 and OfficeVision.

  • Support of CICS command level and pseudo-conversational mode (MVS environment).

  • Support for IBM 3390 DASD.

  • National Language Support for retrieval dialog.

IBM SearchManager/370 Migration Component, in addition to IBM STorage and Information Retrieval System (STAIRS) provides the following functions:

  • Support of CICS command level.
  • Support for IBM 3390 DASD.

The following IBM STorage and Information Retrieval System (STAIRS) functions are not supported by IBM SearchManager/370:

  • IMS-DC support
  • Online Database Creation

The following IBM STorage and Information Retrieval System (STAIRS) functions are provided through the IBM SearchManager/370 Migration Component, but not in IBM SearchManager/370. The IBM SearchManager/370 Migration Component, with the above restrictions, offers the same function as IBM STorage and Information Retrieval System (STAIRS). Its availability is limited to Version 1 of IBM SearchManager/370, its intention is to smooth the migration to IBM SearchManager/370 for existing IBM STorage and Information Retrieval System (STAIRS) applications:

  • Accounting
  • Batch retrieval (the implementation in IBM SearchManager/370 Migration Component is different to the one in IBM STorage and Information Retrieval System (STAIRS) and will be described in the "IBM SearchManager/370 under CICS on MVS Migration Guide" (SH12-5823)
  • Expert mode of the End-user interface
  • Setting of session variables

Restrictions in functions of IBM SearchManager/370 in comparison to IBM STorage and Information Retrieval System (STAIRS) are:

  • Rarely used operators like XOR, NOTWITH, NOTSAME for text queries, and outside-limits for attribute queries are dropped. The functionality of all these operators however is provided by combinations of other operators.
  • No possibility to change the password by the user
  • No possibility to interrupt a query, and to continue or cancel it
  • The number of 255 queries per saved query list is restricted to 99. Also only 99 queries per user are allowed.

IBM SearchManager/370 provides coexistence and migration for the users of the predecessor products STAIRS/VS (5740-XR1) Version 1.5.0, and migration for the users of STAIRS/CMS (5664-189) Version 1.2.0.

CICS on MVS environment:

The coexistence of STAIRS/VS (5740-XR1) Version 1.5.0 and IBM SearchManager/370 under CICS on MVS, and the migration of STAIRS/VS (5740-XR1) Version 1.5.0 to IBM SearchManager/370 under CICS on MVS can be summarized as follows:

  1. Coexistence:
    • IBM SearchManager/370 under CICS on MVS and STAIRS/VS (5740-XR1) are able to coexist on the same CICS system (with a CICS level supported by both products) accessing the same and/or different databases.
    • IBM SearchManager/370 under CICS on MVS and IBM SearchManager/370 Migration Component under CICS on MVS are able to coexist on the same CICS system accessing the same and/or different databases.

  2. Migration:

    The migration from STAIRS/VS (5740-XR1) Version 1.5.0 to IBM SearchManager/370 under CICS on MVS can be done in two ways:

    1. STAIRS/VS (5740-XR1) --- > IBM SearchManager/370 under CICS on MVS

      All necessary tools for migrating from STAIRS/VS (5740-XR1) or IBM SearchManager/370 Migration Component under CICS on MVS to IBM SearchManager/370 under CICS on MVS are delivered within the IBM SearchManager/370 Migration Component under CICS on MVS. For migration from the STAIRS/VS (5740-XR1) API to the new IBM SearchManager/370 API, guidance is provided in the "IBM SearchManager/370 under CICS on MVS Migration Guide" (SH12-5823) which describes the entire migration in detail.

    2. IBM STorage and Information Retrieval System (STAIRS) --- > IBM SearchManager/370 Migration Component -- > IBM SearchManager/370

      The step from IBM STorage and Information Retrieval System (STAIRS) to IBM SearchManager/370 Migration Component is the same as the change from one Release to another, since IBM SearchManager/370 Migration Component not only works on the original databases but also on the original control files of IBM STorage and Information Retrieval System (STAIRS), and supports the IBM STorage and Information Retrieval System (STAIRS) API.

      One reason for doing this before migrating to IBM SearchManager/370 may be the support of CICS command level by IBM SearchManager/370 (and IBM SearchManager/370 Migration Component) whereas IBM STorage and Information Retrieval System (STAIRS) is bound to CICS macro level. This two-step migration provides application by application migrating at any suitable time (allowing e.g. user training for the new End-user interface) and immediate use of the newest CICS level.

VM Environment:

The migration of STAIRS/CMS (5664-189) Version 1.2.0 to IBM IBM SearchManager/370 under VM can be summarized as follows:

  • IBM SearchManager/370 under VM and IBM SearchManager/370 Migration Component under VM are able to coexist on the same VM system accessing the same and/or different databases.

Migration:

The migration from STAIRS/CMS (5664-189) Version 1.2.0 to IBM SearchManager/370 under VM is as follows:

STAIRS/CMS (5664-189) --- > IBM SearchManager/370 under VM

All necessary tools for migrating from STAIRS/CMS (5664-189) to IBM SearchManager/370 Migration Component under VM or IBM SearchManager/370 under VM are delivered within the IBM SearchManager/370 Migration Component under VM. For migration from the STAIRS/CMS (5664-189) API to the new IBM SearchManager/370 under VM API, guidance is provided in "IBM SearchManager/370 under VM Migration Guide" (SH12-5827), which describes the entire migration in detail.

The step from STAIRSCMS (5664-189) to IBM SearchManager/370 Migration Component under VM is the same as the change from one release to another, since IBM SearchManager/370 Migration Component under VM works on the renamed original databases but also on the renamed original control files of STAIRS/CMS (5664-189) and supports STAIRS/CMS (5664-189) API.

One reason to use the IBM SearchManager/370 Migration Component under VM before migrating to IBM SearchManager/370 under VM may be the transition period needed to train the users for the new End-user interface. This migration provides application by application migrating at any suitable time.

Operating Environment

Machine Requirements

MVS Environment:

IBM SearchManager/370 under CICS on MVS is designed to run on processors that meet the minimum requirements for the prerequisite operating system MVS (XA or ESA) with CICS/MVS or CICS/ESA* as stated under programming requirements.

VM Environment:

IBM SearchManager/370 under VM is designed to run on processors that meet the minimum requirements for the prerequisite operating system VM/SP6 or VM/XA or VM/ESA with ISPF and ISPF/PDF as stated in the section entitled programming requirements.

DASD Devices

IBM SearchManager/370 supports the following DASD:

  • IBM 3330
  • IBM 3340
  • IBM 3350
  • IBM 3375
  • IBM 3380
  • IBM 3390

Display Stations

IBM SearchManager/370 supports the following display stations:

To perform text functions:

  • IBM 3278 Model 2, 3, 4, and 5
  • IBM 3279 Model 2 and 3
  • IBM 3178, IBM 3179, IBM 3180
  • IBM 3191, IBM 3192, IBM 3193, IBM 3194
  • IBM 3290
  • IBM 3270-PC workstations with Control Program Release 1.22
  • IBM PC and IBM PS/2 with 3278/3279 Emulation Adapter
  • IBM PC and IBM PS/2 with OS/2 Communication Manager
  • IBM 3471 InfoWindow
  • IBM 3472 InfoWindow.

To perform image and graphics functions:

  • IBM 3179-G
  • IBM 3192-G
  • IBM 3193 (Image only)
  • IBM 3278 Model 2, 3, 4 and 5 with PSS
  • IBM 3279 Model 2 and 3 with PSS
  • IBM 3270-PC with PSS
  • IBM 3270-PC/G and PC/GX
  • IBM 3270-PC AT/G and AT/GX
  • IBM 3290
  • IBM PC and IBM PS/2 with 3278/3279 Emulation Adapter and PCLK (PC Program) together with the GDDM-Personal Computer Link Feature (PCLK)
  • IBM PC and IBM PS/2 with OS2 communication Manager and PCLK (PC Program) together with the GDDM-PCLK Feature
  • IBM 3472-G InfoWindow.

Printers

IBM SearchManager/370 supports the following printers:

Page Printers

As DisplayWrite/370 is used as printer driver, all printers supported by DisplayWrite/370 Version 2 can be used, for example 3820, when this optional product is installed.

Line Printers

  • IBM printers supporting the 1403 data stream

Programming Requirements

IBM SearchManager/370 under CICS on MVS is designed to operate with one of the following programs:

  • MVS/System Product JES2 Version 2 Release 1.2 (5740-XC6) with MVS/XA Data Facility Product (MVS/XA DFP) Version 2 (5665-XA2)
  • MVS/System Product JES3 Version 2 Release 1.2 (5665-291) with MVS/XA DFP Version 2 (5665-XA2)
  • MVS/System Product JES2 Version 3 Release 1 (5685-001) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/System Product JES3 Version 3 Release 1 (5685-002) with MVS/XA DFP Version 3 (5665-XA3)
  • MVS/ESA (5695-047) JES2 Version 4
  • MVS/ESA (5695-048) JES3 Version 4

And one of the following:

  • Customer Information Control System/Virtual Storage (CICS/MVS) Version 2 Release 1 (5665-403) (for MVS Version 2 and MVS Version 3)
  • Customer Information Control System/Enterprise Systems Architecture (CICS/ESA) Version 3 Release 1 and Release 2 (5685-083) (for MVS/SP Version 3 and MVS/ESA SP Version 4)

And with the following:

  • OS PL/I Library (5668-911) Version 2 Release 3
  • SMP/E (5668-949) V1R5
  • MVS Sort/Merge (5740-SM1) (required for Database Creation)

If for the IBM SearchManager/370 Migration Component source feature PL/I modules are to be compiled:

  • OS PL/I Compiler and Library (5668-910) Version 2 Release 3

Optional Software:

  • GDDM/MVS Version 2 Release 2 (5665-356) (required for image and graphics functions and for various printers if driven by GDDM)
  • GDDM-PCLK Release 1.1 (PC-Program) and GDDM/MVS Version 2 Release 2 (5665-356) with the PCLK feature
  • OfficeVision/MVS (OV/MVS) Version 1 Release 2 (5685-106) with Document writing feature
  • DisplayWrite/370 MVS/CICS Version 2 Release 1 (5685-101)

IBM SearchManager/370 under VM is designed to operate with the following programs:

One of the following:

  • VM/System Product Release 6 (5664-167)
  • VM/System Product Release 6 (5664-167) with VM/SP High-Performance Option Release 6
  • VM/XA System Product Release 2 (5664-308)
  • VM/ESA System Product Release 1 (5684-112)

And one of the following:

  • ISPF Version 3 Release 1 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)
  • ISPF Version 3 Release 2 (5684-043) and ISPF/PDF Version 3 Release 1 (5684-123)

Optional Software:

  • GDDM-PCLK Release 1.1 (PC-Program) and GDDM/MVS Version 2 Release 2 (5664-200) with the PCLK feature or GDDM-PCLK Release 1.1 (PC-Program)
  • OfficeVision/VM (OV/VM) Version 1 (5684-084),
  • DisplayWrite/370 VM/CMS Version 2 Release 1 (5685-091).
  • VM Batch Facility Version 2 (5684-137)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 2 Release 3 (5664-188)
  • Remote Spooling Communications Subsystem (RSCS) Networking Version 3 (5684-096)
  • Document Composition Facility (DCF) Release 3.2 (5748-XX9).

Compatibility

IBM SearchManager/370 provides full migration support for existing IBM STorage and Information Retrieval System (STAIRS) installations:

  • IBM STorage and Information Retrieval System (STAIRS) databases can be searched and maintained by IBM SearchManager/370.

  • IBM STorage and Information Retrieval System (STAIRS) administrative datasets (such as user registration files) can be migrated with (IBM-provided) utilities.

  • MVS: STAIRS/VS (5740-XR1) and IBM SearchManager/370 under CICS on MVS system can run in parallel using the same IBM STorage and Information Retrieval System (STAIRS) database within one CICS system (up to and including CICS/ESA Version 3 Release 1.1. only).

  • VM: IBM SearchManager/370 under VM system uses the same STAIRS/CMS (5664-189) data base within one VM system after migration with (IBM provided) utilities.

Limitations

Not applicable.

Performance Considerations

Performance of IBM SearchManager/370 has to be distinguished between IBM SearchManager/370 and IBM SearchManager/370 Migration Component:

  1. IBM SearchManager/370 Migration Component is from a performance view identical to the IBM STorage and Information Retrieval System (STAIRS) product with a well accepted performance for all kind of environments and databases reaching multiple Gigabyte sizes.

  2. IBM SearchManager/370: the differences to IBM STorage and Information Retrieval System (STAIRS) concerning performance are in the CUA 89 End-user interface and the new IBM SearchManager/370 Application Programming Interface.

    Since the CUA 89 interface is only a small layer related to the search engine, the performance impact is minimal. The same is true of the new IBM SearchManager/370 API which works as a small layer on the well-known IBM STorage and Information Retrieval System (STAIRS) API.

    The overall performance of the CICS system, however, should be improved because of the pseudo-conversational implementation of the end- user interface.

    Note: The performance of those functions calling DisplayWrite/370 or OfficeVision (for example, Export documents with editing or Import documents) depend on the performance of the called products.

Planning Information

Customer Responsibilities

Installation of a licensed program is the customer's responsibility. Installation of IBM SearchManager/370 is different for the operating environments MVS and VM. The customer should read the applicable sections of the appropriate IBM SearchManager/370 Program Directory.

The IBM SearchManager/370 installation consists of the following major steps:

  • Unloading the distribution tape
  • Tailoring the installation
  • Verifying the installation

Installing in MVS:

The IBM SearchManager/370 under CICS on MVS installation uses System Modification Program/Extended (SMP/E).

Security, Auditability and Control

IBM SearchManager/370 under CICS on MVS (5695-070):

IBM SearchManager/370 under CICS on MVS provides a means to avoid unauthorized access to its data bases. The data bases are protected at the database, document, section and attribute levels.

In addition to the IBM SearchManager/370 security features under CICS on MVS, the security and auditability features depend on the prerequesite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

IBM SearchManager/370 under VM (5684-143):

The security and auditability features of the announced program depends on the prerequesite operating systems or on the invoking application program.

User management is responsible for evaluation, selection, and implementation of security features, administrative procedures, and appropriate controls in application systems and communication facilities.

Trademarks

(R), (TM), * Trademark or registered trademark of International Business Machines Corporation.

** Company, product, or service name may be a trademark or service mark of others.

Windows is a trademark of Microsoft Corporation.
 © IBM Corporation 2010.
Back to topBack to top