Collection Reference V5.0.1
Total Page:16
File Type:pdf, Size:1020Kb
Verity® Collection Reference Guide Version 5.0.1 August 28, 2003 Part Number DM0626 Verity, Incorporated 894 Ross Drive Sunnyvale, California 94089 (408) 541-1500 Verity Benelux BV Coltbaan 31 3439 NG Nieuwegein The Netherlands Copyright Information Copyright 2003 Verity, Inc. All rights reserved. No part of this publication may be reproduced, transmitted, stored in a retrieval system, nor translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual or otherwise, without the prior written permission of the copyright owner, Verity, Inc., 894 Ross Drive, Sunnyvale, California 94089. The copyrighted software that accompanies this manual is licensed to the End User for use only in strict accordance with the End User License Agreement, which the Licensee should read carefully before commencing use of the software. Verity®, Ultraseek®, TOPIC®, KeyView®, and Knowledge Organizer® are registered trademarks of Verity, Inc. in the United States and other countries. The Verity logo, Verity Portal One™, and Verity® Profiler™ are trademarks of Verity, Inc. Sun, Sun Microsystems, the Sun logo, Sun Workstation, Sun Operating Environment, and Java are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. Xerces XML Parser Copyright 1999-2000 The Apache Software Foundation. All rights reserved. Microsoft is a registered trademark, and MS-DOS, Windows, Windows 95, Windows NT, and other Microsoft products referenced herein are trademarks of Microsoft Corporation. IBM is a registered trademark of International Business Machines Corporation. The American Heritage® Concise Dictionary, Third Edition Copyright 1994 by Houghton Mifflin Company. Electronic version licensed from Lernout & Hauspie Speech Products N.V. All rights reserved. WordNet 1.7 Copyright © 2001 by Princeton University. All rights reserved Includes Adobe® PDF. Adobe is a trademark of Adobe Systems Incorporated. LinguistX from Inxight Software, Inc., a Xerox New Enterprise Company, 1996-1997. Xerox , Inxight and LinguistX are trademarks of Xerox Corporation and Inxight Software, Inc. LinguistX contains patented technology of Xerox Corporation. All rights reserved. All other trademarks are the property of their respective owners. Notice to Government End Users If this product is acquired under the terms of a DoD contract: Use, duplication, or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227-7013. Civilian agency contract: Use, reproduction or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished-rights reserved under the copyright laws of the United States. Verity, Inc., 894 Ross Drive Sunnyvale, California 94089. 8/11/03 Contents Preface .................................................................................................................................... 17 Using This Book ........................................................................................................................... 17 Version ................................................................................................................................... 18 Organization of This Book .................................................................................................. 18 Stylistic Conventions............................................................................................................ 19 Related Documentation .............................................................................................................. 21 Release Notes and Document Updates .................................................................................... 21 Verity Technical Support............................................................................................................ 21 PART IOVERVIEW 1Overview................................................................................................................................. 25 Collection Features ...................................................................................................................... 25 What Is a Collection?............................................................................................................ 26 Features of the Collection Architecture...................................................................... 26 Contents of Collection Indexes.................................................................................... 27 Dynamic Access to Documents ................................................................................... 27 Universal Document Support............................................................................................. 28 Optional Indexes................................................................................................................... 29 Collection Configuration ............................................................................................................ 29 The Collection Directory...................................................................................................... 29 Collection Style Files ............................................................................................................ 29 Collection Optimizations..................................................................................................... 30 Altering Indexing Behavior................................................................................................. 30 Inside a product Collection ........................................................................................................ 31 Types of Indexes ................................................................................................................... 31 Documents Table .................................................................................................................. 31 3 Contents Persistent Fields ............................................................................................................. 31 Transitory Fields ............................................................................................................ 32 What Are Partitions? ............................................................................................................ 32 Index Tuning................................................................................................................................. 33 Defining and Populating Fields ................................................................................................. 34 Document Filters and Formatting ............................................................................................. 34 Universal Filter and the Helper Filters .............................................................................. 35 Using Your Own Filter......................................................................................................... 35 Indexing Modes............................................................................................................................ 35 Topic Sets....................................................................................................................................... 36 Troubleshooting and Maintenance Tools ................................................................................. 36 2 Using Gateways.................................................................................................................. 37 Gateway Configuration Overview ............................................................................................ 37 Primary Document Key Format.......................................................................................... 38 Simple Keys .................................................................................................................... 38 Gateway Field Types ............................................................................................................ 39 Security Method .................................................................................................................... 39 Using Separate Gateways for Indexing and Viewing...................................................... 39 Gateway-Related Style Files ....................................................................................................... 40 Gateway-Related Style Files ................................................................................................ 40 Using Different Gateways for Indexing and Viewing..................................................... 41 Using the HTTP Gateway ........................................................................................................... 42 Features .................................................................................................................................. 42 Security................................................................................................................................... 42 Style Directory....................................................................................................................... 42 Configuration File Syntax.................................................................................................... 43 Configuration File Sample..................................................................................................