rcvdk is a command-line command-line tool for searching Verity collections and displaying documents. The rcvdk name is an acronym for Retrieval Client Verity Developer Kit.
verity/prdname
/k2/_platform
/bin/rcvdk
verity/prdname
represents the user-definable portion of the Verity installation directory name, and _
platform
represents the platform name (like _nti40
for Windows NT v4.0).
rcvdk
" to run it. When you start rcvdk with no arguments, you get the message below followed by a RC> prompt.
- Type 'help' for a list of commands.
- RC>
- RC> help
- Available commands:
- search s Search documents.
- results r Display search results.
- clusters c Display clustered search results.
- view v View document.
- summarize z Summarize documents.
- attach a Attach to one or more collections.
- detach d Detach from one or more collections.
- quit q Leave application.
- about Display VDK `About' info.
- help ? Display help text; `help help' for details.
- expert x Toggle expert mode on/off.
- user u Set user.
- RC>
- RC>a /z/doc1/c/public/collref/html
- Attaching to collection: /z/doc1/c/public/collref/html
- Successfully attached to 1 collection.
- RC>
Now that you are attached to the collection,
mycoll1
, do the following to attach to collection mycoll2
.
mycoll1
by using the "d
" command.
- RC>d /z/colls/mycoll1
- Detaching from collection: /z/colls/mycoll1
- Successfully detached from 1 collection.
- RC>
a
" command.
- RC>a /z/colls/mycoll2
- Attaching to collection: /z/colls/mycoll2
- Successfully attached to 1 collection.
- RC>
- RC>s
- Search update: finished (100%). Retrieved: 85(85)/85.
- RC>
- RC>s universal filter
- Search update: finished (100%). Retrieved: 18(18)/85.
- RC>
More elaborate queries using Verity query language can be used, like this:
- RC>s universal filter <OR> filter
RC>s universal filter
, is shown below. For each document, these fields are displayed by default: Number, Score, and VdkVgwKey.
- RC> r
- Retrieved: 15(15)/85
- Number SCORE VdkVgwKey
- 1: 1.00 d:\verity\k2\docs\doc\fundmntl\08_k23.htm
- 2: 0.97 d:\verity\k2\docs\doc\fundmntl\11_k22.htm
- 3: 0.97 d:\verity\k2\docs\doc\fundmntl\08_k27.htm
- 4: 0.97 d:\verity\k2\docs\doc\fundmntl\08_k21.htm
- 5: 0.95 d:\verity\k2\docs\doc\fundmntl\k2toc.htm
- 6: 0.95 d:\verity\k2\docs\doc\fundmntl\08_k24.htm
- 7: 0.93 d:\verity\k2\docs\doc\fundmntl\k2ix.htm
- 8: 0.92 d:\verity\k2\docs\doc\fundmntl\08_k26.htm
- 9: 0.90 d:\verity\k2\docs\doc\fundmntl\08_k2.htm
- 10: 0.90 d:\verity\k2\docs\doc\fundmntl\04_k21.htm
- 11: 0.90 d:\verity\k2\docs\doc\fundmntl\01_k21.htm
- 12: 0.87 d:\verity\k2\docs\doc\fundmntl\f_k2.htm
- 13: 0.87 d:\verity\k2\docs\doc\fundmntl\08_k22.htm
- 14: 0.84 d:\verity\k2\docs\doc\fundmntl\06_k21.htm
- 15: 0.80 d:\verity\k2\docs\doc\fundmntl\part4.htm
- RC>
u
" command allows you to set user credentials for an rcvdk session.The credentials you supply must match the credentials in the repository where documents are stored.
fields
" command, which is available in the expert mode. To go to the expert mode, enter "x" or "expert" at the RC>
prompt, then press Enter.The "fields" command includes the field name and length to be displayed. When used, the "fields" command overrides the default fields for the results list, Score and VdkVgwKey.
Fields for the results list are returned by the search engine, so if you have done a search, then go to expert mode to use the "fields" command, you must run the search again in order to see the results list with the fields you requested.
All fields in a column will be blank if the field is not defined for the collection's schema in the documents table (in
style.ddd
, style.sfl
, or style.ufl
). A field in a document's row will be blank if the field was not populated by a gateway, bulk submit action, or filter.
- RC> expert
- Expert mode enabled
- RC> fields title 40
- RC> s universal filter
- Search update: finished (100%). Retrieved: 15(15)/85.
- RC> r
- Retrieved: 15(15)/85
- Number title
- 1: Verity Portal Fundamentals
- 2: Document Types
- 3: Indexing File Systems
- 4: Indexing Web Servers
- 5: Table of Contents
- 6: Indexing Exchange Servers
- 7: Index
- 8: Verifying Collections
- 9: Maintaining Collections
- 10: Tuning Unstructured Search
- 11: Field and Collection Schema Definition
- 12: Starting Servers from the Command Line
- 13: Using the K2 System Console
- 14: Parametric Search
- 15: Personalization Engine
- RC>
Remember to re-run the search before you display the results list with the fields specified.
- RC> fields score 5 title 40
- RC> s universal filter
- Search update: finished (100%). Retrieved: 15(15)/85.
- RC>