OmniFind documentation, articles, useful tips

This document seeks to provide the general users of the OmniFind product with all the information they would need to properly utilize it's capabilities. The below is to be understood as a list of separate information sources that can be used to further strengthen/improve one's knowledge of the OmniFind Text Search Server for the IBM i operating system.

The documents and articles listed below are not directly related to each other but are rather gathered in one place in order to provide the clients with easy access to all available documentation at one place. The information is provided as is and any specific questions or concerns that clients may have are to be addressed via the regular support initiation process for further assistance.

1. OmniFind Articles:

• "Build a searchable web-service using OmniFind Text Search Server for DB2 for i" - https://www.mcpressonline.com/analytics-cognitive/db2/build-a-searchable-web-service-using-omnifind-text-search-server-for-db2-for-i
• "Utilizing OmniFind extensions to search for spool files and IFS stream files" - https://www.ibm.com/developerworks/ibmi/library/i-omnifind/omnifind.html
• "Introduction to the IBM i OmniFind Health Checker" - https://www.ibm.com/developerworks/ibmi/library/i-healthchecker/index.html
• "Searching source physical file members using IBM OmniFind Text Search server for DB2 for i 7.1" - https://www.ibm.com/developerworks/ibmi/library/i-searching_source/index.html
• "Omnifind can help improve your search technique" - http://ibmsystemsmag.com/ibmi/administrator/db2/omnifind-can-help-improve-your-search-technique/
• "Rev up XML searches with IBM OmniFind" - http://iprodeveloper.com/database/rev-xml-searches-ibm-omnifind
• "I Can … Find a needle in a haystack using OmniFind Text Search Server for DB2 for i" - http://ibmsystemsmag.com/blogs/i-can/archive/i-can-find-a-needle-in-a-haystack-using-omnifind-t/
• "I can ... Search XML in OmniFind V1R2" - http://ibmsystemsmag.com/blogs/i-can/archive/i-can-search-xml-in-omnifind-v1r2/

 

2. OmniFind manuals:

• V1R1 Manual - https://www.ibm.com/developerworks/ibmi/library/i-searching_source/index.html
• V1R2 Manual - https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_71/rzash/rzash.pdf
• V1R3 Manual - https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_72/rzash/rzashpdf.pdf?view=kc
• V1R4 Manual - https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_73/rzash/rzashpdf.pdf?view=kc
• "DB2 Universal Database Extenders for iSeries Text Extender Administration and Programming" - https://www.ibm.com/support/knowledgecenter/ssw_ibm_i_61/rzahf/sh126720.pdf
• What Omnifind is supported on which IBM i release - https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/IBM%20i%20Technology%20Updates/page/Introduction%20to%20IBM%20i%20OmniFind%20%28ECM%20Text%20Search%20component%29%20upgrade

 

3. OmniFind White Papers

• "Exploring the IBM OmniFind Text Search Server" - http://public.dhe.ibm.com/partnerworld/pub/whitepaper/1fe46.pdf
• "OmniFind Text Search Server for DB2 for IBM i" - https://www.gateway400.org/documents/Gateway400/Handouts/omnifind_overview_expanded.pdf

 

4. Additional documents and resources:

• "Navigator - How to easily add objects to OmniFind search collection" - https://www.ibm.com/developerworks/community/wikis/home?lang=en#!/wiki/IBM%20i%20Technology%20Updates/page/Navigator%20%E2%80%93%20OmniFind%20Collection%20management

 

5. How to completely clean up an environment before doing a fresh install of the OmniFind product:

If we want a totally clean system to install OmniFind, as if the system has never been installed with OmniFind before, the following should be done:

A) Stop and shut down OmniFind server

 

For V6R1/V7R1 systems, issue the following instructions.

• • Issue STRSQL from 5250 command line
  • CALL SYSPROC.SYSTS_STOP()
  • Open QShell from 5250 command line - QSH
  • Type /QOpenSys/QIBM/ProdData/TextSearch/server1/bin/shutdown.sh


• For V7R2/V7R3 systems, issue the following instructions.
  • Issue STRSQL from 5250 command line
  • CALL SYSPROC.SYSTS_SHUTDOWN()

B) Clean up Catalog files

•  
  • RUNSQLSTM SRCSTMF('/QOpenSys/QIBM/ProdData/TextSearch/resetOMF.sql') COMMIT(*NONE) NAMING(*SQL)

C) Uninstall OmniFind

•  
  • DLTLICPGM LICPGM(5733OMF)


• You should receive messages similar to the ones below: 
  
  
  • *LNG objects for NLV 2924 for product 5733OMF option *BASE release V1R2M0 deleted.

    *PGM objects for product 5733OMF option *BASE release V1R2M0 deleted.

    Objects for product 5733OMF option *ALL release *ONLY deleted.

  • Verify that library QDBTSLIB does not exist, delete it if exists via DLTLIB QDBTSLIB

D) Manually remove IFS directories (some directories will be preserved during the uninstall)

• • Start QShell from a 5250 command line - QSH
  • Run the following: rm -r /QOpenSys/QIBM/ProdData/TextSearch

6.OmniFind indexing of partitioned tables
When a text search index is built over a range partitioned table, the text index is created over the entire table. The index cannot be isolated to a particular partition.

It is not possible for keys in another member to cause duplicate keys in the text search index.
http://publib.boulder.ibm.com/infocenter/iseries/v7r1m0/index.jsp?topic=/dbmult/partrestrict.htm

Important considerations:
- A primary key cannot be built over a single partition.
- A unique index must contain all keys that make up the partition. (Else SQLSTATE 42997)
- Records are not allowed to be moved from one partition to another (must be dropped and inserted)
- OmniFind Triggers fire for all members of the partition.