Verity SP3 Modular Reference Guide

Verity 3.
7

2003 Hyland Software, Inc.
All rights reserved.
Information in this document is subject to change without notice and does not represent a com-
mitment on the part of Hyland Software, Inc. The software described in this document is fur-
nished under a license agreement or nondisclosure agreement and may be used or copied only
according to the terms of this agreement. It is against the law to copy the software except as
specifically allowed in the license or nondisclosure agreement, or without the expressed written
consent of Hyland Software, Inc. Any unauthorized duplication or use of the OnBase Informa-
tion Management System, or its corresponding documentation is forbidden. All data, names,
and formats used in this documents examples are fictitious unless noted otherwise. Should
you have any questions pertaining to discrepancies in this document, please contact Hyland
Software, Inc.
Depending on the modules licensed, the OnBase Information Management System may con-
tain portions of: Imaging technology, Copyright Snowbound Software Corporation; CD-R
technology, Copyright Sonic Solutions; CD-R technology, Copyright Rimage Corporation;
OCR technology ScanSoft, Inc; Mail interface technology Intuitive Data Solutions; Elec-
tronic signature technology, Copyright Silanis Technology, Inc.; Full text search technology,
Copyright Microsoft Corporation; Full text search technology, Copyright Verity, Inc.;
SYBASE Adaptive Server Anywhere Desktop Runtime, Copyright SYBASE, Inc., Portions,
Copyright Rational Systems, Inc.; ISIS technology, Copyright Pixel Translations, a division
of ActionPoint, Inc.
OnBase is a registered trademark of Hyland Software, Inc.
All other products are registered trademarks or trademarks of their respective companies.

2003 Hyland Software, Inc. Verity Full-Text Indexing 3.7
Level 1:Exposure
OVERVIEW ....................................................................................................... 1
APPLICATIONS ................................................................................................. 2
REQUIREMENTS ................................................................................................ 3
Databases..................................................................................................... 3
Databases Supported By OnBase .................................................................... 3
Verity Server ................................................................................................. 4
Supported File Formats .................................................................................. 4
LICENSING ...................................................................................................... 5
HASP ............................................................................................................ 5
Level 2:Configuration
CONFIGURATION............................................................................................... 7
Verity Data Sizing Requirements ..................................................................... 7
Disk Group Requirements ........................................................................ 7
Verity Collections Requirements ............................................................... 7
Create A Verity Full-Text Disk Group ............................................................... 8
Configure Verity Administration Server ............................................................ 9
Configure Verity Servers and Collections........................................................ 10
Assign Access to Collections ......................................................................... 14
Removing Collections from OnBase ............................................................... 18
USAGE .......................................................................................................... 18
Conducting a Full-text Search ....................................................................... 19
Specifying Date Range Criteria .............................................................. 21
Specifying Verity Search Criteria ............................................................ 21
Specifying Keyword Search Criteria ........................................................ 25
Search Features .......................................................................................... 26
Exact Text Searches ............................................................................. 26
Function Keys ....................................................................................... 26
Verity Search Results Window ...................................................................... 26
Viewing Documents ..................................................................................... 27
Text Viewer .......................................................................................... 28
Application-Specific Viewer .................................................................... 29
Acrobat Reader ................................................................................ 30
ADMINISTRATION ........................................................................................... 31
Migrating Documents to Verity...................................................................... 31
Migrating Catalogs, CatalogDocTypes, DocNumRange ............................ 32
Migrating Non FT Indexed Docs .......................................................................35
K2 Dashboard ............................................................................................. 36
Logging on to the K2 Dashboard ............................................................ 36
Dashboard Functionality ........................................................................ 37
iii

2003 Hyland Software, Inc. Verity 3.7
System Administration .......................................................................... 39

System Administration - Service View ..................................................... 40
........................................................................................................... 42
System Administration - Host view ......................................................... 42
Administrators ...................................................................................... 43
MAINTENANCE................................................................................................ 44
SYSTEM INTERACTION ..................................................................................... 44
Security Keywords ....................................................................................... 44
Level 3:Installation
HOW VERITY WORKS ...................................................................................... 45
PRE-INSTALLATION ......................................................................................... 46
Verity Server .............................................................................................. 46
OnBase Client.............................................................................................. 47
License File ................................................................................................. 47
STEP 1 - K2 SERVER SOFTWARE INSTALLATION .................................................. 47
STEP 2 - ONBASE-VERITY INTEGRATION FILES INSTALLATION ............................. 63
Installation of Server Files ............................................................................ 64
Installation of Client Files ............................................................................. 65
COMMAND LINE SWITCHES AND .INI SETTINGS ................................................... 69
BACKUP/RECOVERY ........................................................................................ 69
Restoring Data for the Verity Server.............................................................. 70
TROUBLESHOOTING ......................................................................................... 71
Common Error Messages.............................................................................. 71
Admin Host Connect ............................................................................. 71
Index Service Stopped .......................................................................... 72
........................................................................................................... 72
Admin Host Failure ............................................................................... 72
kvsdk.ini File Error ................................................................................ 73
Common Issues & Answers .......................................................................... 73
Collections not Available at Verity Retrieval Dialog Box ............................ 73
No Results Returned Collection Offline ................................................... 73
Document Type Assignment .................................................................. 74
OnBase Error Checking ................................................................................ 75
CONTACTING SUPPORT .................................................................................... 76
Appendix A:Appendix A: Verity for the Web Client

OVERVIEW ..................................................................................................... 77
REQUIREMENTS .............................................................................................. 77
Web Server ................................................................................................. 77
Installation Files .......................................................................................... 77
INSTALLATION ................................................................................................ 78
iv

CONDUCTING A FULL TEXT SEARCH ................................................................... 80

Verity Search Results Window ...................................................................... 82
Viewing Documents ..................................................................................... 82
Text and non-PPT/PDF Documents ........................................................ 82
Microsoft PowerPoint Documents ........................................................ 84
Acrobat Reader ................................................................................. 84
v

vi

Level 1: Exposure
OVERVIEW
The Verity Full Text module uses Verity K2 Server and Microsoft Internet Information
Server to perform advanced searches, seamlessly integrating with the OnBase Client
module. Some of the searches that can be performed include: fuzzy, inflectional,
thesaurus, proximity, wildcard, and SOUNDEX searches on documents that have been
full-text indexed.
Text searches can be combined with OnBase keyword searches or date range
searches to further define and limit the documents returned. Refer to Conducting a
Full Text Search in the Usage on page 18. For every occurrence that meets the
search criteria, a hit list of documents containing the information is produced and
displayed in a Verity Search Results dialog box.
Search and retrieval is significantly faster than an external text search. Documents
that can be full-text searched include COLD documents, text renditions of image
documents (OCRed images), HTML, XML, as well as many third-party application
documents such as MS Word, WordPerfect, MS Excel or PDF. Refer to Supported File
Formats on page 4.
The Verify Full Text module integrates with basic document management functions
such as check-in, check-out, and revision control.
1

APPLICATIONS
Verity Full-Text indexing is useful on sets of documents that will be searched for words
or phrases, or variations of words or phrases.
For example, during an employee recruiting process, a company may receive
hundreds of resumes. The resumes may be in a variety of formats: MSWord, PDF,
text, WordPerfect, etc.
If the company is looking for a specific skill set, it needs the ability to search across all
resumes for words associated with the skill set. The company can store resumes
received via e-mail that are still in their native format (e.g., MSWord) in the
collections.
Once in the full-text repository, a user can search for words and phrases related to the
desired skill set. If the Development department needs a developer, a user might
search for develop* or program* over the full-text collection and retrieve a list of
resumes containing those strings, within seconds. Included in the hit list would be
resumes with the words developer, development, develop, programmer,
programming, etc. If the department needs a developer with UNIX experience, a user
can perform a search for develop* and UNIX to get a list of resumes matching that
search. If the documents were indexed with a keyword of Date Available, the search
could be narrowed down to those candidates who are available for immediate hire.
A law firm has several court cases, each over 10,000 pages in length that must be
reviewed by the end of the week. In each of the cases, the lawyers must search for
the name of each witness who testified, all evidence entered into discovery, and each
instance where a witness for the prosecution identified the defendant. Because the
desired information is scattered randomly throughout the 10,000 pages, configuring
keywords would be an inefficient approach. The court records are COLD processed
into the OnBase system and every word in the files is indexed using Verity Full-Text
Indexing. Now all the records can be searched for the necessary information, quickly
and efficiently.
A variety of search methods are available, including fuzzy searches, proximity
searches, and thesaurus (synonym) searches. Searches can be further narrowed
down by date range or keywords, as well.
2

REQUIREMENTS
Databases
Verity Full-text Indexing requires one of the following OnBase-supported databases:
Databases Supported By OnBase

SQL Server 7 or greater (SQL Server SQL Server 7 and 2000 must be running in
2000 SP3a is advised) * compatibility mode 7 or greater. Running in
compatibility mode 6.5 or lower will result in errors
during the upgrade process
*Recently, Microsoft made an announcement that
users may experience performance degradation
and/or memory leaks with ALL versions of SQL
Server 2000 Service Pack 3 (SP3). For more
information, including symptoms, causes and
resolution, please navigate to the following page.
http://support.microsoft.com/
default.aspx?scid=kb;en-us;814410
Oracle 8.0.5 or greater (third- party Oracle 8.0.5 can be used, but it is not
ODBC driver is recommended for recommended due to potential memory leaks. If
processing stations) Oracle 8.0.5 is used, a third-party ODBC driver is
recommended.
Oracle 8i: 8.1.7.2 or greater
Oracle 9I: Release 1 and Release 2 **It is strongly recommended that you have a
(9.2)** certified Oracle Database Administrator on staff if
you are using an Oracle Database.
Sybase SQL Server v11.5
Sybase Adaptive Server 12.5
Sybase SQL Anywhere 5.5.04 and 7.0.1 No 6.0.X releases
DB2 Universal Database
3

Verity Server
Memory:Min 256 MB RAM
Operating System:MS 2000 Server (preferred)or Windows NT 4
IIS:Version 4.0 or 5.0
Web Browser:MS IE 6.0 or 5.5 with WindowsScript 5.6
Processor 1.5 - 2.0 GHz
Adequate space should be permitted on the system for any collections that will
be configured Client Workstation. Refer to the sizing requirements presented
in Level 2 Configuration, on page 7
All clients accessing the full-text capabilities of Index Server must have:
One of the following OnBase-supported operating systems: Windows 2000
Professional, Windows XP.
Microsoft Internet Explorer (IE) version 6.0 (recommended) or 5.5.
Access to the location on the server storing the full-text documents, and other
operating system-specific requirements are in the Pre-Installation section
on page 46.
Supported File Formats

Verity provides full-text search capabilities for over 200 file formats. Documents that
can be full-text searched include COLD documents, text renditions of image
documents (OCRed images), Microsoft RTF, as well as certain third-party application
documents such as Microsoft Word, WordPerfect, Microsoft Excel or Adobe
PDF. Verity also provides full-text search capabilities for HTML and XML documents.
4

LICENSING
Verity Full-text Indexing requires licensing at both the Client (any of three types of
client licenses can be selected) and the Verity Server. Additionally, a Verity Migration
Tool license is available for converting Microsoft full-text indexed document to Verity.
Note: If using Verity Full-text Indexing for documents imported into OnBase with
COLD, DIP or Document Imaging, appropriate licenses are required for each module.
The available licenses include:

Verity Full-Text Indexing Server is a standard, workstation license. A single
instance of Verity Full-Text Indexing may be executed (used).
This license provides integration with Verity to provide advanced Full Text
searches for words or phrases that exist within documents stored in OnBase.
These words or phrases can exist in COLD documents, text renditions of image
documents (OCR images), and third-party application documents. Fuzzy,
wildcard, stemming, and thesaurus searches are available, as well as searches
combining full-text and keywords on all document types are available.
Verity Full-Text Indexing Concurrent Client is a standard, concurrent license. A
single instance of the Verity Full-Text Indexing module may be executed (used)
on any workstation or server. An end user may install Verity Full-Text Indexing
on as many computers as necessary, but only the licensed number of
concurrent users may execute (use) Verity Full-Text simultaneously.
Concurrent-User Clients have a minimum connection (lease) time of five (5)
minutes. This license may be used for the thick or thin (OnBase Web) Client.
This also requires purchase of Verity Full-text Indexing Server license.
Verity Full-Text Indexing Workstation Client is a standard, workstation license.
A single instance of the Verity Full-Text Indexing module may be executed
(used) on a designated computer or cluster. A workstation license includes
permission to install Verity Full-text Indexing on up to two additional
computers or clusters, solely for the purpose of disaster recovery, integration,
or testing, by the Institution to which the OnBase system is licensed. This also
requires purchase of Verity Full-Text Indexing Server license.
Verity Full-Text Indexing Named User is a standard, perpetual license. A single
instance of Verity Full-text Indexing may be executed (used) for a specific user.
Verity Migration Tool provides a tool to convert from Microsoft Full Text
Indexing Server to Verity Full Text Indexing Server. All data that resides in
Microsoft Full Text catalogs will be migrated to Verity collections with this tool.
HASP
Verity Full-text Indexing does not require a module-specific enabled HASP
(Hardware Against Software Piracy).
5

6

Level 2: Configuration
CONFIGURATION
The Configuration of Verity in the OnBase system is performed after Verity Server and
Client components have been successfully installed. In order to successfully configure
Verity Full Text for use in the document management system, the following steps
must be performed:
Create A Verity Full-Text Disk Group.
Configure Verity Administration Server
Configure Servers and Collections.
Assign Access to Collections.
Verity Data Sizing Requirements

Disk Group Requirements
Documents that are full-text indexed have one copy stored in the Disk Group
associated with its Document Type, and another copy in a Verity Disk Group. For this
reason, you must factor in the extra storage requirements for any documents that are
being full text indexed.
Note: Keep in mind that in the case of image documents that are OCRed, only a copy
of the text rendition resides in the Verity Disk Group.
Verity Collections Requirements

Verity collections reside on the Verity server. They contain the indexes for the
documents, keywords, and pointers to where the documents reside in the OnBase
disk groups. Verity collections need to be sized at least the same size of the document
repositories, due to the use of search partitions to optimize the document indexes it
maintains.
Specifically, Verity indexes documents into partitions. When you search, the Verity
server does an incremental search on each partition, and returns the results
immediately.
For every four partitions that are filled up, another partition is created that is a
combination of the previous four. In order to ensure that valid search results are
obtained searching the first four partitions while new partitions are created, the index
information in the first four partitions is maintained for a period of time.
This redundant use of data makes collection sizes equal to, or even greater than, the
associated file repository sizes.
7

Create A Verity Full-Text Disk Group

Separate disk groups must be created to house documents that are full text indexed
with Verity. Multiple Verity collections can be assigned to one disk group or you can
create a separate disk group for each collection. Multiple copies of Verity Full-Text disk
groups are probably not necessary since these disk groups contain copies of
documents that reside in other disk groups.
Thought should be given to backup procedures for the Verity disk group. Disk groups
and collections should be backed up at the same time so they stay synched.
To create a Verity Disk Group:
1. Start OnBase Configuration. Select Disk Mgmt | Disk Groups.
2. Enter the name of the OnBase disk group for the Verity full-text collection in the
Disk Group Name field (HR - Verity, for example). Click Create. Set the Volume
Size, Number of Copies and Exports as desired. Select the Verity Full-Text Disk
Group checkbox. Click Save & Close.
8

3. When OnBase requests for you to place your mass-storage platter, specify the
physical path where the Verity disk group will be located and click the Mass
Storage button. Specify the path(s) for any other copies, specified at the Disk
Group Settings dialog box.
4. Once complete, click Close on the Disk Group Configuration dialog box.
Configure Verity Administration Server

1. In OnBase Configuration, select Configure Administration Server from the Verity
Full-Text menu.
2. Enter the Administration Server Host Name. This name corresponds to the server
on which the Verity K2 Enterprise software was installed. The syntax used for
Administration Server Host Name must match the Admin Host Name exactly as it
exists in the Verity K2 Dashboard. Lower case letters should be used.
Enter the Administration Port Number. Enter the default of 9950, unless a custom
installation was performed on your server.
Select Save & Close when properly configured.
9

Configure Verity Servers and Collections

1. From the Verity Full-Text menu, choose Configure Servers and Collections. This
dialog box allows new servers and collections to be configured.
Select Add on the Verity Server: side of the Configuration of Verity Servers and Col-
lections dialog box to display the Verity Server Configuration dialog box.
2. At the Verity Server Configuration dialog box, enter the parameters (described in
the following table) for the new server. When complete, select Save & Close.
Note: You must select Save & Close before creating a collection via the Create Verity
Collection button.
3. Click Test to verify the configured connection.
10

Server Description
Parameter
Alias The alphanumeric title that identifies the server in the operating
system. This will be the device name of the Server with an underscore
and server1. (This should be My-Machine_server1)
The machine name should not have underscores. If there is no
choice but to have underscores in the machine name, then the IP
address can be used. To enable Verity to recognize IP addresses, you
must go into the defs.inc file under
$VERITYINSTALLDIR\Administration\Server\ssi and change the
following two values
Const VPU_PortalRoot = "http://My_MachineName/
Verity_Administration"
Const VPU_PortalRootServer = " My_MachineName "
Enter the IP addresses in place of the machine names
Host Name The device name or IP address of the server on the network. (Same
as above, without _server1 at the end)
Port Number Unless a custom installation was performed for your system, the
default value, 9920, should be used. This number is appended to the
Alias and used to identify the server in the Configuration dialog
boxes.
Double-click on the server name (Verity Servers: side of the dialog box) to access
the Verity Server Configuration dialog box again.
4. Click Create Verity Collection to create a collection on the newly created server.
This displays the Create Verity Collection dialog box.
11

5. At the Create Verity Collection dialog box, enter the appropriate parameters for
the new collection. Select Create when complete.
Collection Description
Parameter
Collection This is the Verity collection name. This is not the name that appears on the
Name Verity Retrieval dialog box. Any name can be used here.
Collection Alias The alphanumeric title that identifies the collection in the operating system as
well as in the K2 Dashboard. Can be the same as the Collection Name.
Description Descriptive name (can be the same as the Collection Name).
Gateway Type This non-editable field should contain the value Filesys.
Override A checkbox that indicates you want to specify the path for the collection.
Default Path
12

Path The location of Verity collections on the server. (\program

files\verity\data\colls, or $VERITYINSTALLDIR\data\colls)
If the default directory is not desired, type another path in the data entry field,
or use Browse to navigate to the desired path.
In order to maintain a different directory for the collections, rather than the
default collections directory, two actions need to be performed.
1) During Installation, you can specify additional data folders. These
additional data folders could be the desired folders for collections.
2) If the Installation had been completed, you can specify additional data
folders by modifying the Verity configuration. Once this file had been modified,
the Verity Administration Server needs to be stopped and restarted for the
changes to take effect.
Locale The language locale used for searching. Select English in most cases.
Document Note: For typical installations, select Public.

Access Secure. Users will have to provide credentials through the application to
retrieve results. When collection is searched, only the documents accessible
to the authenticated user will be displayed in the results list.
Anonymous. These repositories are secure repositories with the addition of
pre-configured user credentials for an anonymous user. When the collection
is searched, the application will request anonymous access to some or all of
the repositories. The gateway will find anonymous credentials for each
repository in a configured credential file and will connect and perform
document security check for that user's credentials.
Public. The gateway's document security check is ignored for all documents
in public repositories. (OnBase security will apply for document access.)
Threads This non-editable field should contain a value of 4.
13

6. Before the collection can be created, a user name and password recognized by
the Administration Server must be supplied. Enter the user name and password
that were specified during the Verity Server installation at the Admin Host dialog
box and select OK.
The system displays a confirmation message, indicating that the server and col-
lection have been created.
Assign Access to Collections

The collections configured in the previous section must be assigned for use in the
document management system. To do so:
dialog box allows new servers and collections to be configured.
Select Add on the Verity Collections: side of the Configuration of Verity Servers and
Collections dialog box.
14

2. The Verity Collection Configuration dialog box is displayed.

Supply the following parameters at the Verity Collection Configuration dialog box
that identify the collection.
Collection Description
Parameter
Name The label that will appear for the collection when performing full-text searches in
OnBase from the Verity Retrieval dialog box.
Alias Select the Alias for the collection from the dropdown list. This will be the
collection Alias that you entered in Step 2, above.
Disk Group The Verity Full Text disk group that will be used to store documents that belong to
the collection. Select the appropriate disk group from the drop down.
3. Click Document Types. Highlight the document types that are associated with this
collection in the Available Document Types window, then click Add>>. Click Save &
Close when all document types are assigned.
Note: Any documents brought into the system via the indicated document
types will be available for Verity text searching. Any documents that were
stored in the document type prior to its assignment to a collection will not be
15

Verity full text searchable, unless the Verity Migration tool is used to index
these documents. Refer to Migrating Documents to Verity on page 31.
Note: Document types can only be associated with one collection.
16

4. Click File Formats at the Verity Collection Configuration dialog box. Select the file
formats for the document types that will be in the collection. Click Close.
5. Click User Groups at the Verity Collection Configuration dialog box. Highlight the
user group accounts that will be able to access the collection when performing
full-text searches at the Verity Retrieval dialog box.
17

6. You should now be able to import documents into document types that are set up
for collections, and full-text search these documents from the Client module.
Removing Collections from OnBase

In order to remove a collection from use in the document management system:
dialog box display currently configured servers and collections.
2. Highlight the collection to be deleted on the Verity Collections: side of the dialog
box.
3. Select Delete from the right-click menu.
A confirmation message appears, click OK to confirm deletion. (Cancel exits the
delete process without affecting the collection.)
USAGE
Any document types that have been assigned to a Verity collection can be searched at
the Verity Retrieval dialog box.
The Migration Tool can be used to import documents into Verity that existed in the
document management system prior to the installation of Verity. Specifically:
18

Documents that reside in a Microsoft full-text catalog can be migrated into a

Verity collection.
Documents that exist in a disk group that is not full-text indexed can be added
to a Verity collection.
Refer to Migrating Documents to Verity on page 31.
Conducting a Full-text Search

To Initiate a Verity Full-Text Search:
1. Open Verity full-text searching from the File menu in the Client module. Select File
| Open | Retrieve from Verity Full-Text.
Alternatively, click the Retrieve from Verity icon at the Client toolbar.
Note: If the Retrieve from Verity icon does not appear on the toolbar, select User |
Customize Toolbar.Click the Retrieve from Verity button and click Add>> to move
the button to the Current Toolbar Layout box.
19

2. The Verity Retrieval dialog box is displayed. All currently configured collections
that the user has access to appear for selection. Highlight a collection and the
Document Types list populates with document types assigned to the selected
collection.
Multiple collections and/or multiple document types can be highlighted for search-
ing. Any common keyword types among the selected document types appear in
the Keywords section.
3. The criteria used to perform a full-text search can be specified using combinations
of:
Date Range From and To date values can be used to limit the documents
returned from a search.
Verity Search Criteria the documents returned can be limited to specified
text within the documents, as identified by Verity search criteria.
Keyword Values the search can be limited to documents with only
specified keyword values.
20

Specifying Date Range Criteria

To limit a search to the documents within a specific date range, type the desired
dates in the From and To fields in the Dates portion of the Verity Retrieval dialog
box. Only documents within the range of dates specified will be included in the hit
list of documents that meet the search criteria. The dates being searched for are
the document dates, not the date stored.
Specifying Verity Search Criteria
To limit a search by text found within the body of the documents, type the desired
text in the appropriate Verity Search field. The * (asterisk) and ? (question mark)
may be used to search for partial text within a Verity Search field.
The criteria used to find the text is set by specifying values for a VERITY CLAUSE
or CLAUSES. VERITY CLAUSE criteria include:
VERITY Description
CLAUSE
Contains The Contains operator searches for the text entered as a literal string.
When you search for multiple words, each word must be sequential and
contiguous and must be separated by a blank space in the document.
Contains searches do not recognize non-alphanumeric characters.
Stemming is performed on all words within a Contains search.
21

SOUNDEX Returns documents that contain the word being searched for or any words
that sound like, or whose letter pattern is similar to, the word specified.
SOUNDEX searches are very useful for searching for names or proper
nouns when you do not know the exact spelling.
Note: Words must start with the same letter as the word you
specify to be selected.
EXAMPLE: A SOUNDEX search for King will return documents with the
word King as well as words (names) such as Kuang, Kong, and
Kuong.
Stem Returns documents that include one or more variations of the search word
you specify.
EXAMPLE: A search for the word department will return department,
departments, departmentalize and departmental.
Thesaurus Returns documents that contain the word being searched for as well as any
synonyms of the word.
EXAMPLE: A search for the word sell will return documents with the words
market, marketing, sold, deal in, merchandise and retail,
Typo Returns documents that contain the word you specify plus words that are
similar to the query term. It performs approximate pattern matching to
identify similar words and is ideal for searching documents that have been
OCRed.
If a number is not specified (see Typo##), an error distance of 2 is used.
The error distance between two words is based on the number of errors. An
error is defined as a character insertion, deletion, or transposition.
EXAMPLE: For the following sets of words, the second word matches the
first within an error distance of 1:
battle, bottle
ward, war (d is deleted)
word, world (l is inserted)
22

Typo### Returns documents that contain the word you specify, plus words that are
similar to the query term. The ### variable specifies the maximum number
of errors between the query term and a matched term. If a number is not
specified, an error distance of 2 is used.
The error distance between two words is based on the number of errors. An
error is defined as a character insertion, deletion, or transposition.
EXMAPLE: For the following sets of words, the second word matches the
first within an error distance of 2:
coffee, coffin
scho~1, school
clock, clerk
Word Returns documents that include one or more instances of only the word you
specify without locating stemmed variations of the word.
New Creates a duplicate contains field for input. This same action can be
achieved by pressing F6.
Help Access the Verity system help.
23

If a Verity Search field is used in combination with another Verity Search field,
care must be taken to set the correct Logical operator between the fields. The
Logical operator sets how the values input into the individual search fields will be
related to one another when determining if a document meets the search criteria.
To create an additional search field, place your cursor in the first Verity Search
field and press F6, or choose the New option from the comparative operators list.
Verity Logical Description

Operators
And Returns documents that contain all of your search elements. Search for
OnBase and Verity will return documents that have both words.
And Not When used in conjunction with Contains, returns documents that contain the
first word or phrase, but not the second word or phrase. If you wish to search
for a document that does not contain a particular word or phrase, Do a
Contains search for * along with an And Not search for whatever word or
phrase should not be searched.
Or Returns documents that show evidence of at least one of the specified search
fields.
Near Returns documents containing specified search terms within close proximity to
each other. The Near operator calculates relative proximity and assigns
scores based on its calculations.
For example, if the search expression includes two words, and those words
occur next to each other in a document, then the score assigned to that
document is 1.0. Thus, the document with the smallest possible region
containing all search terms always receives the highest score. As search terms
appear further apart, the score drops toward zero.
Near### Returns documents that contain two or more words within <n> words of each
other, where <n> is a number you specify as (###)
For example, if the search expression NEAR/5 is used to find two words
within five words of each other, a document that has the specified words within
three words of each other is scored higher than a document that has the
specified words within five words of each other.
Paragraph Selects documents that contain all of the search values you specify within a
paragraph. You must use the paragraph operator between each word or
phrase. A paragraph is defined as 100 words.
Sentence Selects documents that contain all of the search values you specify within a
sentence. A sentence is defined as 15 words.
Phrase Selects documents that include the phrase you specify. A phrase is a grouping
of two or more words that occur in a specific order.
24

Specifying Keyword Search Criteria

To limit a search by keyword values assigned to the documents, type the desired
keyword value in the appropriate keyword field. The * (asterisk) and ? (question
mark) may be used to search for partial values within a keyword field.
Be sure to set the Comparative Operator that will be used to search for that value.
Comparative operators allow you to retrieve documents based on a range of key-
word values, as well as exact keyword value matches.
Note: = or <> are the only options available when keyword searches are
conducted with full text indexing.
If a Keyword Search field is used in combination with another field, care must be
Comparative Description
Operators
= Searches for an exact keyword match.
<> Searches for keyword values that are not equal to the specified value.
taken to set the correct Logical operator between the fields. The Logical operator
sets how the values input into the individual search fields will be related to one
another when determining if a document meets the search criteria.
To create an additional edit field for the keyword, place your cursor in the first
field and press F6, or choose the New option from the comparative operators list.
25

Logical Operators Description
And Searches for documents containing the keyword values preceding and
following the logical operator.
Or Searches for documents containing either the value preceding the logical
operator or the value following the logical operator.
Search Features
Exact Text Searches
To search for an exact phrase, use quotes () to enclose text strings. All of the words
must be found in a document, in the exact order presented within the quotes, for a hit
to be returned.
Function Keys
When the cursor is positioned in any of full-text search or keyword type fields, you
can select function keys to perform certain tasks:
Function Key Description
F6 Creates a duplicate keyword type field.
Verity Search Results Window
The Verity Search Results window displays if any documents are found when is
selected on the Verity Retrieval dialog box.
The caption of the window displays the number of documents found in parentheses.
26

Each document is listed with a score that represents how closely the document
matched the search criteria. Higher ranked documents more closely match the search
criteria entered. It is based on the number of hits and the quantity of text matched.
Double-clicking any entry in the window displays the corresponding document.
The caption of the window displays the number of documents found in parentheses.
Each document will be listed with a Score.
The Score is a number representing how closely the document matched the search
criteria. Double-clicking any row in the Verity Search Results window displays the
document in its respective viewer.
Viewing Documents
A document opened via a Verity Search Results window, will be viewed in any of three
different viewers. Each viewer has an associated search mechanism that is used to
identify hits. The possible viewers used to display documents are:
Text Viewer used to display text file format documents
Application Specific Viewers used to display all non-text documents, except
for PDF.
Acrobat Reader used to display PDF file format documents
27

Text Viewer
If a text document is returned in a Verity Search Results list, that document is
displayed in a Text Viewer. The hits are indentified on the document by colored
highlights. The entire line in which the word was located will be highlighted. The word
is highlighted within the line, in a second color.
To scroll through pages, in order to view hits, use the <CTRL> button together with
the Up Arrow and Down Arrow keys.
28

Application-Specific Viewer
Application-Specific Viewers are used for all non-text display formats (e.g., MS Word,
MS PowerPoint, etc.). Hits in this viewer appear with the word or phase searched
highlighted. Buttons for moving between hits are provided at the top of the document
in a document control bar. Specifically:
Moves to the next hit in the document.
Moves to the previous hit in the document.
29

Acrobat Reader
If a PDF file format document is opened from a Verity search results list, it will be
displayed in Acrobat Reader. When the document is first displayed, hits will not
appear highlighted.
Use the search functionality provided, using the buttons in the top document control
bar. Specifically:
Initiates the search functionality. The Acrobat Find dialog box is displayed.
Moves to the next hit in the document

Once a search phrase is located with the search functionality, it will appear highlighted
in the document.
30

ADMINISTRATION
Migrating Documents to Verity

If certain document types and disk groups have been configured for Verity Full-text
Indexing, documents brought into that configuration are automatically indexed and
ready for Verity text searching.
However, any documents that existed in the system before Verity was configured will
need to be migrated into an appropriate configuration before they can be made
available for Verity text searching. This is accomplished using the Verity Migration
Tool.
For example, documents may require migration for the following reasons:
Documents were archived into the Document Management System prior to the
installation of Verity.
Documents were archived using the Microsoft Full-Text Indexing, and need to
be used with a Verity full-text engine.
Documents were archived into a newly created document type that was not
previously configured with a Verity collection.
The Verity Migration Tool provides a safe and efficient means for indexing documents
archived outside of the Verity environment to an existing Verity collection.
To Access the Migration Tool:
1. In the Client module, select Admin | Utilities | Migrate to Verity Collection. The
Verity Migration Tool Choices dialog box is displayed.
Documents can be added to a Verity collection, using any of four methods:
31

Catalog -> Collection migrates all of the documents associated with an entire
Microsoft Full-Text catalog to a specific Verity Full-Text collection.
CatalogDocType -> Collection - migrates all of the documents associated with
specific document type that has been assigned to a Microsoft Full-Text catalog
to a specific Verity Full-Text collection.
DocNumRange -> Collection migrates a range of document, identified by
their document number, to a specific Verity Full-Text collection.
Non FT Indexed Docs -> Collection(s) migrates all of the documents that have
not been indexed, but reside in a document type that is currently assigned to a
verity collection.
At the Verity Migration Tool Choices dialog box, select the type of migration to be
performed. Click Select.
Migrating Catalogs, CatalogDocTypes, DocNumRange
1. If either the Catalog -> Collection, CatalogDoc Type -> Collection, or

DocNumRange -> Collection methods of migration were selected, the system
displays a prompt box requesting the Index Server catalog that contains the
document(s) to be migrated. Highlight the desired catalog and select OK.
32

2. (CatalogDocType -> Collection and DocNumRange only) The system displays a

prompt box requesting the document type that contains the document(s) to be
migrated. Highlight the desired document type(s) and select OK.
3. (DocNumRange only) The system displays a prompt box requesting the document
numbers that correspond to the document(s) to be migrated. Type the desired
range and select OK.
Note: The document number that corresponds to a specific document is

obtained by selecting Document Properties from a document hit list or from an
open document.
33

4. After the appropriate objects for migration have been identified (collection,
document type, document number), a prompt box appears, requesting where the
documents will be migrated.
Highlight the collection where the documents will be indexed. Select OK.
A confirmation message is displayed. Select OK to proceed with the migration

(Cancel exits migration without effecting the document indexing.)
During migration, a progress bar will be displayed. When complete, the indicated
documents will be Verity full-search capable at the Verity Retrieval dialog box.
34

Migrating Non FT Indexed Docs

This migration tool option allows for the system-wide indexing of all documents that
have been archived into the document management system before being assigned to
a Verity collection.
1. If Non FT Indexed Docs -> Collection(s) was selected as the migration method, the
system displays the following message:
This message reminds the user to ensure that all documents to be migrated are
associated with a document type that is currently configured for a Verity Collec-
tion. To confirm the document type configuration, and proceed with migration,
select OK. (Cancel exits the migration process without effecting data.)
2. After confirmation of the first migration message, the next message to appear is:
This message requests final confirmation of the migration. To proceed, select OK.
(Cancel exits the migration process without effecting data.)
During migration, a progress bar will be displayed. When complete, the indicated
documents will be Verity full-search capable at the Verity Retrieval dialog box.
35

Note: Unindexed documents can be reindexed manually, by deleting the document at

the Document Retrieval dialog box, then undeleting the document from the Document
Maintenance dialog box.
Caution: Manual reindexing is a time consuming process. It also involves the sensitive
removal of data from the document management system. Inadvertent deletion of
data may result if care is not taken to properly identify documents for reentry into the
system.
K2 Dashboard
The K2 Dashboard is a browser-based user interface that enables you to view and
update configuration settings for the components in your K2 system. If your K2
system consists of multiple K2 Servers in different physical locations, you can use the
K2 Dashboard to configure settings for the entire system from one computer.
The following are examples of common K2 Dashboard configuration tasks you can
apply to a distributed environment:
Start/Stop the Verity Indexing Service
Do sample searches directly from Verity
Add/Remove Administrators
Logging on to the K2 Dashboard
Before you can log on to the K2 Dashboard:
Ensure the K2 Platform and K2 Administration components are installed. This
includes a Master Administration Server, a K2 Ticket Server, and the K2
Dashboard.
Ensure the Master Administration Server is running.
Ensure the K2 Ticket Server used for administration is running.
Run your Web server, which must be installed on the same computer as the K2
Dashboard.
36

To Log On:
1. In Windows, click the Start menu and select Programs | Verity | Administration |
K2 Dashboard. The K2 Dashboard Logon dialog appears:
2. Enter the Username and Password of the Verity Administrator.

3. Click Log on. The K2 Dashboard appears:
Dashboard Functionality
The K2 Dashboard is divided into 3 functional areas, as indicated by the tabs at the
top of the K2 Dashboard:
System Administration
System Monitoring
Administrators
In the context of the OnBase system, limited System Administration, and some
functionality provided in the Administrators area will be performed.
37

The tree structure uses symbols to represent K2 components, such as K2 Brokers, K2

Servers, and indexes. The symbols in the tree give a visual representation of a K2
system. They show how K2 features-such as the brokered architecture, indexing, and
collections-relate. For example, the K2 Dashboard shows K2 services. These are the
executable processes in the K2 system, such as a K2 Broker, a K2 Server, or a K2
Ticket Server.
The symbols include:
Master Administration Server

The Master Administration Server is an Administration Server that serves as the
central hub for configuration information. A K2 system must have a single Master
Administration Server.
Administration Server
An Administration Server is a repository for configuration information. In a K2 system,
there is one Administration Server for every host computer. An Administration Server
services the administration needs on a host.
K2 Broker
A K2 Broker receives client search requests and distributes them to available K2
Servers. A K2 Broker is a service.
K2 Server
A K2 Server receives search, viewing, profiling, and recommendation requests and
performs searches of collections, knowledge trees, and parametric indexes. A K2
Server is a service.
K2 Ticket Server
A K2 Ticket Server is a centralized authentication service that stores information for
users that have been authenticated to LDAP, NT or UNIX, or secure repositories. A K2
Ticket Server is a service.
Collection (=full text Catalog)

A collection represents "metadata," or data about a set of documents with an
optimized collection architecture for searching. Verity collections store pointers to the
location of all indexed documents and a list of all words contained in the text of all of
these documents.
38

System Administration
System Administration allows you to configure all K2 system components. To view it,
click System Administration on the Dashboard main menu bar. A secondary menu
bar, the Tree View menu bar, appears. The Tree View menu bar enables you to view
K2 system administration information three different ways:
Service view - The Service view shows all K2 services in the context of the
entire K2 system. For example, it shows relationships between K2 Brokers and
K2 Servers, even if these services and their attached indexes are located on
machines in different cities or on different continents.
Host view - Like the Service view, the Host view shows all services and indexes
in the K2 system. However, it groups these services according to their physical
location on host computers.
Index view - The Index view does not show all K2 services in the system.
Rather, it lists all the indexes that store portal content, grouping them by
collection, knowledge tree, and parametric index.
39

System Administration - Service View

The Service view shows all K2 services in the context of the entire K2 system. For
example, it shows relationships between K2 Brokers and K2 Servers, even if these
services and their attached indexes are located on machines in different cities or on
different continents.
The Actions drop down list provides for many functions, the most commonly use
actions include:
Start/Stop If there is a modification made to the K2 Server, it requires to
Stop and re start the K2 server through K2 Dashboard (Do not restart the
Verity K2 Administrator Server in Services).
Service Logging It logs every thing that happening on the K2 Server. This
option is important to turn on at all time on the K2 Server. It helps technical
support for troubleshooting when error encounters.
Edit Properties - Allow user to change Description, Number of Threads, Result
Cache and Server Types.
Expert Setting If this is dedicated K2 Server machine, you should not
configure this action. If not, you may want to update the following fields only:
Max Memory (%) and Memory Pages.
40

Starting/Stopping a K2 Server
1. In System Administration, ensure you are in the Service or Host view. In the tree
at the left of the K2 Dashboard, select the K2 Server you want to start or stop.
2. In the Actions list, select Start/Stop. The Start/Stop K2 Server dialog appears:
3. Click the button that corresponds to the action you want to perform on the K2
Server. The Start/Stop K2 Server dialog shows the following fields and buttons:
Field or Button Description
Current State The current state of the K2 Server. Possible values are
Stopped, Starting, Running, Stopping, and Host Unavailable.
Auto Start Indicates whether the K2 Server is enabled for starting automatically. If
auto start is enabled, when the Administration Server starts on the
computer, it starts the K2 Server service automatically. Likewise, if auto
start is enabled and the K2 Server goes down, K2 Administration tries to
restart it. If auto start is not enabled, you must start the K2 Server
manually.
Quick Restart Resets the K2 Server with minimal impact to its service. During a quick
restart, the K2 Server re-reads the settings in the local K2 Administration
and updates its configuration. The K2 Server does not have to stop. Client
connections are locked and clients may experience a brief service delay.
Note: This button only shows if the service is running.
41

Full Restart Shuts down the K2 Server and then starts it back up so that a changed
parameter can take effect. You will experience a brief outage while the K2
Server shuts down and restarts. The status of the K2 Server appears in
the K2 Server Summary. You can refresh this pane to view the current K2
Server status.
NOTE: This button only shows if the service is running.
Stop Stops the K2 Server service and disable auto start.
Start Starts the K2 Server service and enables auto start.
NOTE: This button only shows if the service is stopped.
Cancel Cancels the start/stop configuration and closes the dialog.
Help Displays a brief description of the dialog.
System Administration - Host view

Like the Service view, the Host view shows all services and indexes in the K2 system.
However, it groups these services according to their physical location on host
computers.
42

Administrators
Administrators list the administrative users within a K2 system. An administrative user
is an individual who has the right to use the K2 Dashboard. Administrators allow you
to add or delete these users.
Click Administrators on the Dashboard navigation menu bar. Following is an example
of Administrator(s):
To Add a New Administrative User:
1. At the Admin Users screen, click New. The New Administrator dialog appears:
2. Type the name of the administrative user you want to add in the User Name data
entry field.
43

3. Click Add. The name of the new administrative user appears in Administrators.
Note: If the user name you enter is not valid, you are prompted with a message
asking for a valid user name.
To Delete an Administrative User:

1. At the Admin Users screen, select the administrative user you want to delete.
2. Click Delete. A message appears, asking whether you want to delete the selected
user.
3. Click Yes to delete the user.
MAINTENANCE
SYSTEM INTERACTION
Security Keywords
Verity documents are not protected by security keywords; they are protected at the
collection level. In other words, your user groups will be able to retrieve any
documents even if you have precluded them from viewing documents with certain
keyword values. To prevent this from occurring, you must revoke access to entire
collections.
44

Level 3: Installation
HOW VERITY WORKS

The Verity integration uses Verity K2 Server software in conjunction with Microsoft
Internet Information Server (IIS). The diagrams and descriptions below illustrate how
documents are indexed and retrieved from Verity.
During the configuration process, OnBase document types are associated with Verity
collections. Document types can only belong to one collection.
45

If a document type has been properly configured for a Verity collection, when
documents are processed into OnBase, a copy of the document goes into the Verity
Full-Text disk group and indexing is performed. Documents are pushed through pages
in IIS and then the data is passed along to the OB Indexing Service. The OB Indexing
Service acts as a broker and passes the data to the K2 Server, where the indexes,
keywords and pointers to the documents are all stored in the Verity collections.
The full-text indexes of documents are stored in the Verity collections on the Server,
but users search for words or phrases from the OnBase Client.
Text documents enter the Verity collections during archival or commit. Image
documents enter Verity after they have been OCRed and committed.
The services that perform the indexing are described below:
OBIndexService The OnBase indexing service acts like a broker and
communicates between the OnBase Client and the Verity Engine.
Verity Administration Server This service runs the following three processes:
K2 Admin this process monitors the K2 ticket and K2 server
K2 Ticket manages user authentication
K2 Server manages indexing and the collection process
PRE-INSTALLATION
The installation of the Verity Full Text module involves installation of Verity K2 Server
software, as well as files for the OnBase Client workstation and the OnBase Index
Service. Specifically, installation consists of the following parts:
Step 1 - Verity K2 Server Software
Step 2 OnBase-Verity Integration Files Installation
Before beginning installation, ensure that the proper operating environment exists as
follows:
Verity Server
The following components are required at the Verity Server:
1. Internet Information Services 5.0

2. Minimum 256 MB RAM.
3. Windows 2000 Server (recommended) or Windows NT4
4. If you are running IE 5.5 or earlier, install Windows Script 5.6
Note: If you are running IE 6.0, Windows Script 5.6 does not need to be downloaded.
46

Windows Script 5.6 can be downloaded from http://www.msdn.microsoft.com/

downloads.
When downloading from microsoft.com, use the search parameters:
Product/Technology Windows Script
Keywords VBScript 5.6
Follow the instructions presented on either download page.
OnBase Client
The following components are required at the OnBase Client Workstation:
OnBase-Compatible Operating System and Database
OnBase System Software - Version 37
License File
During installation, certain license numbers/codes will be requested at certain dialog
boxes. In order to avoid typographical errors, a lic.txt file has been provided. This file
contains the alphanumeric strings that must be entered for license numbers/codes.
When requested, use this file to copy-and-paste the strings into the indicated fields.
The lic.txt file is provided along with the installation files. Copy lic.txt to your local
machine before starting the installation process.
STEP 1 - K2 SERVER SOFTWARE INSTALLATION

Install K2 Server software from the Verity Installation CD or from the Verity installation
files provided by Hyland Software. Specifically, the following two components of the
K2 Server software will be installed:
K2 Platform
The K2 Platform component offers you the foundation of the K2 Enterprise
portal system, K2 Ticket Server, and K2 Server. The K2 platform also provides
the foundation for all search features, including advanced search features.
Administration
The Administration component contains the K2 Dashboard and the K2
Administration Server. The K2 Dashboard provides a convenient interface to
perform simple administrative tasks for a K2 portal application.
Note: If error messages are produced during K2 Platform installation, ensure that
VBScript 5.6 is installed. Refer to Pre-Installation on page 46.
47

Tip: The installation presented in these instructions assumes that there are no
underscores (_) in the server name. If the server name incorporates underscores, an
additional file (defs.inc) will have to be editing during Configuration.
1. Before beginning the installation, make a note of the machine name that will be
used in the installation.
2. Insert the Verity Installation CD at the computer that will serve as a K2 Server. (Or
run setup from the Windows directory of the Verity Installation files.)
3. The Verity K2 Setup screen is displayed. Enter the following license key for Verity
K2:
Note: To avoid typographical errors, this information can be copy-and-pasted from the
lic.txt notepad file provided.
11-1SUTI-1018MHM-2H36
Do not enter any value in the bottom field (VSpider license key).
Click Next.
4. Read the license agreement and click Yes.

5. The Destination Folders dialog is displayed. Accept the default values and click
Next.
48

6. The Verity Master Installation Page is displayed. Select K2 Platform
7. A welcome dialog appears, with instructions to close all Windows programs that
are currently open. When all programs have been closed, click Next.
8. A Select Components dialog is displayed. Enable all check boxes, except for K2
Spider
49

9. When the Select Administration Server Type dialog is displayed, select the kind of
server you are installing. Only one Master Administration Server will be used per
Company.
If this is an initial installation, click Yes to install a Master Administration Server,

which governs administration functions for the entire K2 system. If you have
already installed a Master Administration Server, click No to install a local K2
Server. Click Next to continue.
Note: For purposes of installing on a single PC or laptop (i.e., for demo purposes), you
will always be installing the Master Administration Server.
50

10. The K2 Administration Server dialog is displayed next. Maintain the default values
at this dialog. Click Next to continue.
Files are copied to the destination folders and a progress bar is displayed during
the process. This will take a few minutes.
11. When an information dialog is presented, enter the following information, paying
strict attention to EXACT spelling and case sensitivity. These values must
be entered exactly as follows:
Name: The administrator name will be displayed.
Leave this at the default.
Organization: OnBase Information Mgmt System
Signature: SGAH-4KWB-AL53-EE64-DKCW
License: PTKZ-CKJV-QBGJ-WJN7-9JJW
51

Note: To avoid typographical errors, this information can be copy-and-pasted from the
lic.txt notepad file provided.
Click Next.
12. When the K2 Platform Components dialog is displayed, ensure that the K2 Server
and K2 Ticket services are enabled. K2 Broker and K2 Spider must be disabled.
52

13. At the Configure K2 Platform Components dialog, retain the default settings and
port assignments. Click Next.
14. At the Select Authentication Server Type dialog box, select the appropriate choice
for your organization dependent on whether you use NT logins or LDAP directory
services.
53

Note: If you need to install an LDAP server for authentication, please contact Hyland
Software Technical Support.
15. The Attach K2 Ticket Servers dialog box is displayed. Select Ticket 1. Click Next.
54

16. The Select K2 Platform Components dialog box is displayed. This dialog box would
be used if multiple K2 Servers were installed. Click Next.
Note: Since this installation procedure provides for the installation of a single K2
Server, ensure that no check boxes enabled and click Next.
17. At the Attach K2 Ticket Server dialog box, make sure the K2 ticket you installed
(Ticket 1) is checked.
55

18. The Set Initial Administrator dialog is displayed. Enter the user name and
password for the Verity administrator. This must be an existing user name and
password on the network. This user must also be a member of the administrator
group, or have partial administration privileges.
Leave the Domain field blank. Click Next when complete.
19. At the Hostname and Port Number dialog box, accept the default values when the
Hostname and Port Number dialog is displayed, then click Next.
56

20. When prompted to complete the setup, select Yes, restart my computer (Verity K2
Platform Setup Complete dialog), then click Finish.
21. The system will restart and perform an auto-login. If the auto-login does not
work, eject the Verity Installation CD and reinsert the CD.
22. When prompted, enter the license key for Verity K2 as follows:
11-1SUTI-1018MHM-2H36
Do not enter any value in the bottom field (VSpider license key).
Click Next.
23. Read the license agreement that appears, then click Yes.
57

24. The Verity Master Installation Page is displayed. Select Administration.
25. Ensure that all Windows programs are closed and click Next at the welcome
dialog box.
26. The Verity Administration Installation wizard is displayed. Click Next.
27. The Select Features dialog box is displayed. Before proceeding with the
installation, check the available disk space by selecting Disk Cost. If the disk space
is adequate, proceed with the installation and click Next.
58

Note: If you receive an error about needing VBScript 5.5 at this point (see screen,
below), you need to download VBScript 5.6 from the Microsoft Website. See Pre-
Installation on page 46.
28. At the Verity Administration Setup Page Type dialog box, select Active Server
Pages (ASP), then click Next.
59

29. Accept the default settings at the Verity Administration Setup Server Name dialog
box, and click Next.
30. Accept the default settings at the Verity Administration Setup Website dialog
box, and click Next.
60

31. Accept the default settings at the Verity Administration Setup Destination Folder
dialog box, and click Next.
32. A Verity Master Administration Server dialog appears. This dialog summarizes the
values set for the K2 Server/Broker field (the K2 Broker) and the K2 Ticket Server.
Click Next.
61

33. The Database Setup dialog box is displayed. Ensure that the default value reflects
the administration server name and click Next.
34. The Start Installation dialog box is displayed. Click Next.

The Updating System dialog box appears, with a progress bar indicating that
setup is taking place. When the setup is complete, the Verity Administration Setup
dialog reappears. Click Finish to finish the installation process.
35. A pop-up dialog with information about the Notes styleset is displayed. Click OK.
36. A final Installer Information dialog box is displayed. Click Yes to restart the
computer.
62

STEP 2 - ONBASE-VERITY INTEGRATION FILES INSTALLATION

This procedure assumes the following:
Successful installation of Verity software
Successful installation of IIS and NT 4.0 (SP6) or 2000 Server (SP3) on the
server that will be performing the text searching
The Verity installation files are used for specific purposes in the archival and
subsequent retrieval of documents. Their placement in the correct directory structure
on both the Client and Server is crucial.
The diagram on (page 45), How Verity Works, demonstrates the use of installation
files on both the Client and Verity Server, in regards to the archival/retrieval process.
The Verity installation files for this part of the installation are located with the
installation files labeled OnBase-Verity Integration Files. The files are in a
preconfigured directory structure that is easily copied to both the Server and Client.
63

To Install Client and Server Installation Files:
1. Right-click on My Computer and select Manage to open Explorer. Locate the

OBVerityIntegrationFiles directory. Open the directory and note the structure. The
files should be located in the structure indicated in the diagram below.
Installation of Server Files

2. Copy the Server-side installation files to the server by dragging the Hyland folder
(located under the ServerComponents folder) to the appropriate drive. These files
include the OnBase archival ASP Pages as well as the OnBase Indexing Service.
3. Copy the following two files (located in ServerComponents | Style) into the Verity
Style directory on the Verity Server, located at C:\Program
Files\Verity\K2\Common\Style.
64

Note: These files will already exist in the file directory, but you must replace them with
the files provided by Hyland.
Style.UFL (OnBase uses this file to display highlights on the document)

Style.prm (required for SOUNDEX search functionality)
Installation of Client Files

4. Copy the Client-side installation files to the client system by dragging the
KeyViewDlls folder (located under the ClientComponents | Hyland | Verity folder)
to C:\Hyland\Verity folder.
Note: The KeyviewDlls are required for viewing documents from a Verity hit list in the
thick client. These dlls can reside on the Client machine, on a shared network location
or on the Verity Server itself.
5. The MzVerity.dll file must be copied to the location of your OnBase executables
and registered using regsvr32. Ensure that the indexing service is stopped, then
go to Start | Run and type the following string to perform registration:
regsvr32 MzVerity.dll
6. Copy the kvsdk.ini file (from the INI folder on the CD) to the default Windows
directory (e.g., C:\WINNT for Windows 2000, or C:\WINDOWS for Windows XP).
Note: To confirm the path of the default Windows directory, Click Start | Run, then
type cmd to obtain a command prompt window. Type set windir and the system
displays windir=<Windows default directory>
Make sure it is not read only, then edit the following line, found at the end of the
kvsdk.ini file, with the location of the DLLs from the previous step:
[General]
; The following line must contain the HOME value (directory where the Key
View components installed)
HOME=C:\Hyland\Verity\KeyViewDLLs
This entry should contain the path to where the Keyviewdlls reside.
65

Edit the path in your Environment Variables to include the same path.
(C:\Hyland\Verity\KeyViewDLLs, for example) To do this, right click on My Com-
puter, go to Properties | Advanced | Environment Variables, and edit by adding
the appropriate path (ie: C:\Hyland\Verity\KeyViewDLLs, making sure to put a
semicolon before the entry.
7. On the Verity Server, access Internet Information Services (IIS) and create a
virtual directory that points to OBArchivalASPPages. To do so:
a. Right-click on My Computer and select Manage.
66

b. The Computer Management Console is displayed. Expand the Services and

Applications tree, then expand the Internet Information Services tree.
c. Right-click on the Default Web Site item under the Internet Information
Services tree, and select New | Virtual Directory.
d. The Virtual Directory Creation Wizard is started. Click Next to proceed.
67

e. The wizard prompts for a name (Alias) for the new directory. Enter:
OBArchivalASPPages. Click Next.
f. The next screen prompts for the path to the directory that contains the
content ASP pages. Browse to the OBArchivalASPPages folder, or enter:
C: \Hyland\Verity\OBArchivalASPPages
Click Next.
g. The Access Permissions screen is displayed. Leave the defaults for access
privileges and click OK.
68

h. The system displays a message indicating that the virtual directory has been
successfully created.
i. Locate the startservice.bat file in the Hyland\Verity\OBIndexService folder. Run
the file by double clicking on it. This registers the service.
8. Start the OBIndexService. Go to the Management Console |Services and
Applications and highlight Services. Right-click on the OBIndexService and
change it to automatic from manual.
9. Before text searching can be performed, disk groups, servers, and collections
must be created in the Configuration module. Refer to the instructions presented
in Level 2: Configuration on page 7.
COMMAND LINE SWITCHES AND .INI SETTINGS

Verity Full Text Indexing does not utilize command line switches or INI settings.
BACKUP/RECOVERY
This backup procedure is designed to recover full-text indexed data from a Verity
server. The following assumptions are made:
The Verity software has been installed on a dedicated server.
69

All files created by the installation are located by default on the C drive of the
server (C:\Program Files\Verity).
Only the Verity server needs to be replaced (the database server and file
server are intact).
Restoring Data for the Verity Server

1. Configure the replacement Verity server with the same network ID (host name) as
the working server.
Note: Ensure that the same Username and Password that was defined on the
replacement server prior to the restore still exist on the server.
2. Install the Verity software on the replacement Verity server, following the
instructions in Level 3: Installation on page 45.
3. Install all OnBase-related Verity files required for the Verity server.
4. Stop the Verity K2 Administration Server service (Control Panel | Administrative
Tools | Services).
5. Replace the newly installed Verity files (at C:\Program Files\Verity) with the
backup files from C:\Program Files\Verity.
6. Reboot the replacement Verity server, in order to properly restart all services.
At the replacement server, log onto OnBase. Check the configuration of the Verity
servers and collections. In the Configuration module, select Verity Full-Text at the
main menu bar, then select Configure Servers and Collections.
Particularly, all alias names should be correct at the Verity Collection Configuration
dialog boxes.
7. In the Client module, access the Verity Retrieval dialog box. Perform sample full-
text searches of documents configured for Verity full-text.
8. Import (File | Import) a new document into a document type configured for use
with a Verity full-text collection.
70

TROUBLESHOOTING
Common Error Messages

Admin Host Connect
The following error may appear during configuration of Verity collections.
Probable Causes Remedy
A local user name and Add the network user as an administrator in the K2 Dashboard.
password was entered
when K2 Server was
installed, instead of a
network/administrator user
name and password.
Network user name and Log back in to the K2 Server, making sure to correctly type the
password was typed user name and password.
incorrectly.
The Virtual Directory name Check that the Virtual Directory is named OBArchivalASPPages,
is incorrectly named or and correct any spelling error through Explorer.
incorporates typos.
An incorrect Path to the Reconfigure the collection in OnBase configuration, specifying a

collections was specified at correct path.
the Create Verity
Collection dialog box
during configuration.
The K2 Administration Reconfigure the Administration Server in OnBase configuration.

Server is improperly
configured.
71

Index Service Stopped
The Indexing Service has Restart the service.

been stopped.
Admin Host Failure
The K2 Administration Check the configuration of the K2 Administration Server in the

Server is improperly OnBase configuration.
configured (e.g., incorrect
Alias, Host Name or Port
Number).
The configuration of the K2 Restart the server and the OnBase Client.
Administration Server has
been modified via the K2
dashboard, but the server
has not been restarted.
72

kvsdk.ini File Error
The kvsdk.ini was copied to Make sure that the kvsdk.ini file is copied to the default windows
the wrong directory on the directory (typically, c:\windows for Windows XP and C:\winnt for
Client. Windows 2k).
The kvsdk.ini was not edited to reflect the Make sure that the kvsdk.ini file is edited to include the line: HOME=
correct path to the KeyView DLLs.
Common Issues & Answers

Collections not Available at Verity Retrieval Dialog Box
If a collection has been properly configured (Configuration module), but is not
available for selection at the Verity Retrieval dialog box (Client module), check the
following:
K2Server Status The K2 Server must be online.
Server Port Configuration In the Configuration module, check that the proper
port assignment has been made at the Verity Administration Server
Configuration dialog box and the Verity Server Configuration dialog box.
MzVerity.dll Ensure that the mzVerity.dll file has been successfully registered,
and is correctly versioned for your installation of OnBase.
No Results Returned Collection Offline
73

If a document has been properly indexed into Verity, but does not return results in the
Verity Retrieval dialog box, the collection should be tested in the K2 Dashboard.
To Test a Collection in the K2 Dashboard:
1. Access Start | Programs | Verity | K2 | K2 Sample Templates and Applications.

2. Ensure that the check box associated with the collection is checked.
3. Attempt any search to troubleshoot whether the collection is suspect.
Document Type Assignment

Ensure that the document types assigned to the collection are not currently assigned
to another collection in the OnBase configuration.
74

OnBase Error Checking

Error checking is provided via the V SQL switch. To enable this feature:
1. Highlight the OnBase Client shortcut on the desktop. At the right-click menu,
select Properties. Click the Shortcut tab. Position the cursor in the Target data
entry field, at the end of the current entry, and type -V SQL.
When an error conditions arises, a related message box will be presented, indicat-
ing that the error log should be checked. The log file Verbose.txt will be created
and placed in the OnBase\temp directory.
75

CONTACTING SUPPORT
Before calling technical support, obtain the following information:
Operating system version and service packs of the Verity Full-text Server
Operating system and version of the document retrieval workstation(s)
Version and build on the OnBase Client and OnBase Configuration executables
76

Appendix A: Verity for the Web Client
OVERVIEW
Verity Full-text search capabilities can be accessed through the OnBase Web Server.
Verity for the Web Client provides immediate access to Verity Servers and collections,
using any standard Internet Explorer web browser.
Verity Searches utilize the same functionality as the Thick Client.
REQUIREMENTS
Web Server
Verity for the Web Client requires an OnBase Web Server Version 4.3.7.44 or higher.
The Web Server requires Microsoft Internet Information Server 4.0 or later.
The Web Server must also have one of the following recommended OnBase-supported
Operating Systems.
Windows NT 4 Workstation/Server
Windows 2000
The Web Server must have access to one of the following OnBase-supported
databases:
SQL Server 7 or 2000
Oracle 8+.
Sybase SQL Server v11.5
Sybase SQL Anywhere 5.5.04 and 7.0.1 (No 6.0.X releases)
DB2 Universal Database
Installation Files
The following files are required for Verity Full-text search capabilities on the Web
Client:
k2onbase.ini
k2onbaseText.ini
Other modifications to the Verity Server installation setup, as well as the Web Server
configuration are noted in the installation instructions that follow.
77

INSTALLATION
Verity for the Web Server follows the same installation as the Web Server, with the
following modifications:
1. Ensure that the OnBase Web Client has been successfully installed at Version
4.3.7.44 or higher.
2. Ensure that Verity for the Thick Client has been successfully installed. Refer to the
Level 3: Installation on page 45 of this manual.
Note: The instructions for installing KeyViewDlls only needs to be performed for Verity
Full-text search capabilities for the Thick Client. They are not necessary for the Web
Client.
3. Copy the following files to the Verity Installation Directory, specifically to the
\k2\common\templates path:
k2onbasetext.ini
k2onbase.ini
These files can be found with the Verity installation files in:
\OBVerityIntegrationFiles\ServerComponents\Hyland\Verity\Templates
78

4. Navigate to the Web Client installation directory (\Inetpub\wwwroot\aspweb)

and open nav_menu.xml. Perform a search for Verity, in order to locate the line
<property Name="MenuName">VerityFullText</property>.
Scroll up a few lines and change menuitem=true. This section of nav_menu.xml
should now appear as follows:
Close nav_menu.xml, saving changes.

Open nav_vertical.asp, and perform a search for Verity, in order to locate the
line bDisplayMenuItem =1 for verityfulltext.
Ensure that bDisplayMenuItem =1, then close the file, saving any changes. This
section of nav_menu.xml should now appear as follows:
5. Close all windows and log onto the Web Client using an authenticated username
and password, in order to access Verity functionality.
79

CONDUCTING A FULL TEXT SEARCH

1. The Web Login window appears in the browser window after you enter the
address of your Web Server.
Enter your user name and password in the User Name and Password fields. To
maintain security, asterisks (***) appear as you type your password.
Select the ActiveX version or html only version. The html only version
provides limited functionality.
Select the language you wish to use. This may be determined by clicking on Tools
| Internet Options | Languages in Internet Explorer.
Click Login to start the Web Server.
80

2. Upon successful log on to the Web Server, the Document Retrieval dialog box is
displayed.
Select Document at the main menu bar, and then select Verity Full-Text. The
viewer is refreshed with the Verity Retrieval window.
3. Using the Verity Server drop-down menu at the top of the window, select the
Verity server that contains the documents to be searched.
4. As soon as a server is selected, all collections currently configured for the server
appear in the Verity Collections window. Each collection has been preconfigured
for use with certain document types and file formats. Highlight the collection to be
included in the text search.
5. To search documents within a specific document type(s) within a collection,
highlight the desired document type(s) in the Document Types select list. If no
document type is selected, the search will be performed for all documents types
in the collection.
Multiple collections and/or multiple document types can be highlighted for search-
ing. Any common keyword types among the selected document types appear in
the Keywords section.
6. Specify the date, OnBase keywords, and/or Verity search criteria that will be used
to perform the search. Refer to Section 2- Usage on page 18 for a description of
the criteria that can be used to perform a full-text search.
7. When all search criteria has been specified, click to initiate the Verity full-
text search. The results are presented in a document list at the bottom of the
window.
81

Verity Search Results Window

The Verity Search Results window displays if any documents are found from the full-
text search criteria specified at the Verity Retrieval dialog box.
Each document is listed with a score that represents how closely the document
matched the search criteria. Higher ranked documents more closely match the search
criteria entered. It is based on the number of hits and the quantity of text matched.
Double-clicking any entry in the window displays the corresponding document.
Viewing Documents
All documents opened via a Verity Search Results list in the Web Client are viewed in
an HTML Viewer. The method used to move among hits in the document varies in the
viewer, depending on the original file format of the document, as follows:
Text Documents (and native applications other than PPT and PDF)
Microsoft PowerPoint Documents
PDF Documents
Text and non-PPT/PDF Documents
If documents other than PowerPoint and PDF are opened from a Verity Search Results
window in the Web Client, it is displayed in an HTML viewer that supports the hit-
highlights view of the document. This viewer makes moving between occurrences of
the search text easier.
Each hit appears highlighted in color, and is bordered by the << and >> tags, allowing
you to go to the previous and next hit, respectively. (These tags are added as part of
the HTML representation of the document, and do not actually appear in the
document.)
Two links are also displayed at the top of the page:
View Original Document
82

Please click here to move to the first hit
The Please click here to move to the first hit link is provided so that you can navigate to
the first hit in the document. This is useful if the first hit is not on the first page of the
document.
To exit the hit highlight mode of viewing and view the document in its original format,
click View Original Document. The document is displayed in its original format. All of
the document functionality provided in the document control bar is available.
83

Note: Once the original document view is requested, you cannot return to hit-
highlights mode. The document must be opened again from the Verity Search Results
window to view hits.
Microsoft PowerPoint Documents

The PowerPoint Viewer is used to display documents whose original file format is
Microsoft PowerPoint. Hits do not appear highlighted in the PowerPoint Viewer.
Navigation functionality is not available since hits are not highlighted.
Acrobat Reader
If a PDF file format document is opened from a Verity search results list, it will be
displayed in Acrobat Reader. When the document is first displayed, hits will not
appear highlighted.
Use the search functionality provided by the buttons in the top document control bar.
Specifically:
Initiates the search functionality. The Acrobat Find dialog box is displayed.
Moves to the next hit in the document
84

Once a search phrase is located with the search functionality, it will appear highlighted
in the document.
85

86

Verity SP3 Modular Reference Guide

Hochgeladen von

Dokumentinformationen

Copyright

Verfügbare Formate

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

Verfügbare Formate

Verity SP3 Modular Reference Guide

Hochgeladen von

Copyright:

Verfügbare Formate

Verity 3.

System Administration .......................................................................... 39

Appendix A:Appendix A: Verity for the Web Client

CONDUCTING A FULL TEXT SEARCH ................................................................... 80

Databases Supported By OnBase

Oracle 8i: 8.1.7.2 or greater

Sybase SQL Server v11.5

Sybase Adaptive Server 12.5

Sybase SQL Anywhere 5.5.04 and 7.0.1 No 6.0.X releases

DB2 Universal Database

Supported File Formats

The available licenses include:

Verity Data Sizing Requirements

Verity Collections Requirements

Create A Verity Full-Text Disk Group

Configure Verity Administration Server

Configure Verity Servers and Collections

3. Click Test to verify the configured connection.

Description Descriptive name (can be the same as the Collection Name).

Path The location of Verity collections on the server. (\program

Document Note: For typical installations, select Public.

Threads This non-editable field should contain a value of 4.

Assign Access to Collections

2. The Verity Collection Configuration dialog box is displayed.

Note: Document types can only be associated with one collection.

Removing Collections from OnBase

Documents that reside in a Microsoft full-text catalog can be migrated into a

Conducting a Full-text Search

Specifying Date Range Criteria

Help Access the Verity system help.

Verity Logical Description

Specifying Keyword Search Criteria

= Searches for an exact keyword match.

Logical Operators Description

Function Key Description

F6 Creates a duplicate keyword type field.

Verity Search Results Window

Moves to the next hit in the document.

Moves to the previous hit in the document.

Moves to the next hit in the document

Migrating Documents to Verity

Documents can be added to a Verity collection, using any of four methods:

1. If either the Catalog -> Collection, CatalogDoc Type -> Collection, or

2. (CatalogDocType -> Collection and DocNumRange only) The system displays a

Note: The document number that corresponds to a specific document is

A confirmation message is displayed. Select OK to proceed with the migration

Migrating Non FT Indexed Docs

Note: Unindexed documents can be reindexed manually, by deleting the document at

2. Enter the Username and Password of the Verity Administrator.

The tree structure uses symbols to represent K2 components, such as K2 Brokers, K2

Master Administration Server

Collection (=full text Catalog)

System Administration - Service View

Field or Button Description

Note: This button only shows if the service is running.

NOTE: This button only shows if the service is running.

Stop Stops the K2 Server service and disable auto start.

Start Starts the K2 Server service and enables auto start.

NOTE: This button only shows if the service is stopped.

Cancel Cancels the start/stop configuration and closes the dialog.

Help Displays a brief description of the dialog.

System Administration - Host view

To Add a New Administrative User:

To Delete an Administrative User: