Verity K2 Migration: V5.0.1 to V5.5

Verity K2 Migration:
V5.0.1 to V5.5
Version 5.5
February 20, 2004
Part Number DE0150
Verity, Incorporated
894 Ross Drive
Sunnyvale, California 94089
(408) 541-1500
Verity Benelux BV
Coltbaan 31
3439 NG Nieuwegein
The Netherlands
Copyright Information
Copyright 2004 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.
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.
2/2/04
Contents
Preface ...................................................................................................................................... 5
Using This Book ............................................................................................................................. 6
Version ..................................................................................................................................... 6
Organization of This Book .................................................................................................... 6
Stylistic Conventions.............................................................................................................. 6
Related Documentation ................................................................................................................ 8
Verity Technical Support .............................................................................................................. 8
1
Migrating from K2 V5.0.1 ................................................................................................ 9
Migrating on Windows............................................................................................................... 10
Migrating on UNIX...................................................................................................................... 11
Migrating K2 Configuration Settings with AdminConfigImport ........................................ 12
About AdminConfigImport................................................................................................ 12
Preparing to Run AdminConfigImport............................................................................. 13
Running AdminConfigImport............................................................................................ 13
After running AdminConfigImport .................................................................................. 15
2
Migrating Collections ...................................................................................................... 17
Maintaining V5.0.1 Collections in K2 V5.5............................................................................... 18
Utilizing V5.5 Enhancements with Standard Style Files........................................................ 18
Utilizing V5.5 Enhancements with Edited Style Files ............................................................ 19
3
Migrating Other Data and Settings ......................................................................... 21
Migrating Indexing Jobs ............................................................................................................. 22
Preparing rcadmin Scripts.......................................................................................................... 23
Preparing Locales and Thesaurus Files .................................................................................... 24
Preparing Recommendation Indexes........................................................................................ 25
3
Contents
New Features Since K2 V5.0.1............................................................................................. 25
Enabling Stemming and Profile Decryption ..................................................................... 25
Stemming and Profile Decryption Disabled in K2 V5.0.1........................................ 26
Stemming Disabled, Profile Decryption Enabled in K2 V5.0.1 ............................... 26
Preserving Existing Recommendation Indexes ................................................................ 27
Using K2 Dashboard ..................................................................................................... 27
Recommendation Index Location Changes ...................................................................... 28
Recommendation Indexes for Collections .................................................................
User Indexes Per Host...................................................................................................
Other Recommendation Indexes .................................................................................
map.dat File ....................................................................................................................
Migrating Recommendation Indexes..........................................................................
Modifying mkre Scripts .......................................................................................................
28
28
28
28
29
30
Changes to Transaction Logging................................................................................. 30
Changes to mkre ............................................................................................................ 30
Changes to Recommendation Engine Configuration ...................................................... 31
Administering Recommendation Indexes ................................................................. 31
Preparing Verity Federator......................................................................................................... 32
Customers with JSP Deployment of Federator with K2 V5.0.1...................................... 32
Customers with JSP Deployment of Federator with K2 V5.0.1...................................... 32
4
Verity K2 Migration: V5.0.1 to V5.5
Preface
This guide is for readers responsible for upgrading a K2 V4.5.1 or 5.0.1 system to K2
version 5.5. If you are a new K2 user, you do not need to read this guide.
Every effort has been made to ensure K2 V5.5 is compatible with previous versions of K2.
However, some migration steps may be required for you to take full advantage of the
powerful new features in K2 V5.5, and to ensure your system continues to work
efficiently. This document is intended to help you move your current K2 system to K2
V5.5 with minimal interruption to production and service.
This preface contains the following sections:

Using This Book

Related Documentation

Verity Technical Support
5
Preface
Using This Book
Using This Book
This section briefly describes the organization of this book and the stylistic conventions it
uses.
Version
The information in this book is current as of K2 V5.5. The content was last modified
February 20, 2004. Corrections or updates to this information may be available as Release
Notes or document updates through the Verity Customer Support site; see “Verity
Technical Support” on page 8.
Organization of This Book
This book includes the following chapters and appendixes:

Chapter 1: Migrating from K2 V5.0.1 provides an overview of how to migrate from K2
V5.0.1 to K2 V5.5.

Chapter 2: Migrating Collections describes how to migrate your collections to be
compatible with K2 V5.5.

Chapter 3: Migrating Other Data and Settings describes how to migrate non-collection
indexes and other data/settings.
Stylistic Conventions
The following stylistic conventions are used in this book.
Convention
Usage
Plain
Narrative text.
Bold
User-interface elements in arrative text:

Italics
6
Click Cancel to halt the operation.
Book titles and new terms:

For more information, see the Verity K2 Getting Started Guide.

An index is a Verity collection, parametric index, or knowldege
tree.
Verity K2 Migration: V5.0.1 to V5.5
Preface
Using This Book
Convention
Usage
Monospace
File names, paths, code, and required user input:

The name.ext file is installed in:
C:\Verity\Data\

Monospace italic
In the User Interface text box, type user1.
Replaceable strings in file paths and code:

user username
Data types:
Monospace bold

SrvConnect A connection handle.
The following command-line syntax conventions are used in this book.
Convention
Usage
[ optional ]
Brackets describe optional syntax, as in [ -create ] to specify a
non-required option.
|
Bars indicate “either | or” choices, as in
[ option1 ] | [ option2 ]
In this example, you must choose between option1 and option2.
{ required }
Braces describe required syntax in which you have a choice and
that at least one choice is required, as in
{ [ option1 ] [ option2 ] }
In this example, you must choose option1, option2, or both
options.
required
Absence of braces or brackets indicates required syntax in which
there is no choice; you must enter the required syntax element.
variable
Italics specify variables to be replaced by actual values, as in
-merge filename1
...
Ellipses indicate repetition of the same pattern, as in
-merge filename1, filename2 [, filename3 ... ]
where the ellipses specify , filename4, and so on.
Use of punctuation—such as single and double quotes, commas, periods—indicates
actual syntax; it is not part of the syntax definition.
Verity K2 Migration: V5.0.1 to V5.5
7
Preface
Related Documentation
Related Documentation
The following guides provide more details on the K2 architecture and administering K2:

Verity K2 Getting Started Guide

Verity K2 Dashboard Administrator Guide

Verity K2 rcadmin Guide
The following guide provides more details on installing K2:

Verity K2 Installation and Setup Guide
Verity Technical Support
Verity Technical Support exists to provide you with prompt and accurate resolutions to
difficulties relating to using Verity software products. You can contact Technical Support
using any of the following methods:
Telephone: (403) 294-1107
Fax: (403) 750-4100
Email: [email protected]
Web: www.verity.com
Product documentation, release notes and document updates are available at the Verity
Customer Support Site at:
https://customers.verity.com
It is recommended that you periodically check the Customer Support site for the
existence of updates to this and other Verity product documents.
Access to the contents of the Customer Support site requires a user name and password.
To obtain a user name and password, follow the signup instructions on the Customer
Support site home page. You will need to supply your Verity entity ID and Verity license
key.
8
Verity K2 Migration: V5.0.1 to V5.5
1
Migrating from K2 V5.0.1
This chapter describes what is involved with migrating from K2 V5.0.1. It contains the
following sections:

Migrating on Windows

Migrating on UNIX
9
1 Migrating from K2 V5.0.1
Migrating on Windows
Migrating on Windows
To upgrade K2 on individual hosts:
1. Stop all activities, including indexing and maintenance, being performed on collections
by any of the K2 services. Go to Start |Programs | Administrative Tools | Services
and stop the Verity K2 Administration Server service. Also, ensure that all
command-line tools are stopped.
2. Install K2 V5.5 over K2 V5.0.1. All administration settings are migrated. For
information on installing K2 V5.5, see the Verity K2 Installation and Setup Guide.
3. Re-create your collections as necessary.
Note
This is only necessary if you want to take advantage of new features
and for any collection that was created using the Asian locales japanb,
koreab, simpcb, or tradcb must be re-created.
See the following sections, depending on your current situation:

If you want to continue to use existing collections unchanged, see “Maintaining
V5.0.1 Collections in K2 V5.5” on page 18.

If you want to utilize V5.5 enhancements such as spell suggestion or passage-based
summaries, see either “Utilizing V5.5 Enhancements with Standard Style Files” on
page 18 or “Utilizing V5.5 Enhancements with Edited Style Files” on page 19
depending on whether you edited any of the standard style files.
4. Migrate your indexing jobs. See “Migrating Indexing Jobs” on page 22.
5. Migrate scripts that utilize rcadmin, if necessary. See “Preparing rcadmin Scripts” on
page 23.
6. Migrate locales and thesaurus files, if necessary. See “Preparing Locales and Thesaurus
Files” on page 24.
7. Migrate recommendation indexes, if you use them. See “Preparing Recommendation
Indexes” on page 25.
10
Verity K2 Migration: V5.0.1 to V5.5
1 Migrating from K2 V5.0.1
Migrating on UNIX
Migrating on UNIX
Upgrading is not supported on UNIX. On each K2 V5.0.1 host, you must install K2.
1. Install K2 V5.5. For information on installing K2 V5.5, see the Verity K2 Installation and
Setup Guide.
Note
Ensure that you specify new port numbers and paths so there is no
conflict with your existing K2 V5.0.1 system.
2. Migrate your Administration Server settings using the AdminConfigImport
command-line tool. See “Migrating K2 Configuration Settings with
AdminConfigImport” on page 12. The instructions apply to both Administration
Servers and the Master Administration Server.
3. Manually specify administration settings that are not configurable during installation
using K2 Dashboard after installation.
4. Re-create your collections as necessary.
Note
This is only necessary if you want to take advantage of new features
and for any collection that was created using the Asian locales japanb,
koreab, simpcb, or tradcb must be re-created.
See the following sections, depending on your current situation:

If you want to continue to use existing collections unchanged, see “Maintaining
V5.0.1 Collections in K2 V5.5” on page 18.

AdminConfigImport only copies configuration settings. It does not copy any files.
In particular, it copies settings that configure indexes but it does not copy the index
files themselves. If you need to copy or move the index files, you must do so manually.

You may need to adjust the paths for Verity indexes.

AdminConfigImport does not update the software of the earlier version. It does not
update a V5.0.1 system to a V5.5 system.

AdminConfigImport logs its actions and messages to the file
AdminConfigImport.log located in the same directory as AdminConfigImport.

If AdminConfigImport fails for any reason, Verity strongly recommends you restore
the V5.0.1 K2 system to its original state using the backup your adminN.xml file you
made before running AdminConfigImport.
a. If the V5.5 Master Administration Server is running, shut it down.
b. Start it up again with this command: k2admin -xmlfile path. Where path is
the location of the backup file. You need file system access to path for both making
and restoring these backups.

If the existing V5.0.1 K2 system has K2 Spider configured already, then the K2 Spider
settings will not be imported from V5.0.1. This is because it is usually best to configure
your K2 Spider differently for each host.
If V5.5 does not have K2 Spider configured already, and V5.0.1 does, then the V5.0.1
configuration will be imported.
12
Verity K2 Migration: V5.0.1 to V5.5
1 Migrating from K2 V5.0.1
Migrating K2 Configuration Settings with AdminConfigImport
Preparing to Run AdminConfigImport
Before you run AdminConfigImport, follow these steps.
1. Use the collset reset or paraset commands for rcadmin to fully specify index
paths that both hosts can use. Doing this means you can retain index files at their
current locations without copying them to the K2 V5.5 host.
You must also reply y to the “Transfer path information?” prompt by
AdminConfigImport. This will ensure the specified path to the index is transferred to
the K2 V5.5 Master Administration Server’s configuration file. See Step 4 under
“Running AdminConfigImport.”
2. Use the label command for rcadmin to back up your K2 V5.0.1 adminN.xml file.
3. Ensure that the K2 V5.0.1 (Master) Administration Server is running on the source host.
4. Ensure that the K2 V5.5 (Master) Administration Server is running on the target host.
5. Ensure that you are logged out of K2 Dashboard.
6. Ensure that rcadmin is no longer running.
Running AdminConfigImport
1. At the command line type: AdminConfigImport
Note
You may need to navigate to the directory where
AdminConfigImport is installed (install\_platform\bin) or
add that directory to your path.
2. Specify the (Master) Administration Server of the source host:
Prompt
Description
Connect to K2 5.0.1 Administration Server
Host
The name of the V5.0.1 source host from which to obtain
information.
Port
The port used by the (Master) Administration Server on the host.
Alias
The alias of the (Master) Administration Server on the source host.
User, Password and
Windows NT Domain
The credentials for logging on to Host. The Windows NT Domain
is optional.
Verity K2 Migration: V5.0.1 to V5.5
13
1 Migrating from K2 V5.0.1
Migrating K2 Configuration Settings with AdminConfigImport
3. Specify the V5.5 Administration Server on the target host.
Prompt
Description
Connect to K2 5.5 (Master) Administration Server
Host
The host for the V5.5 (Master) Administration Server.
Port
The port used by the V5.5 (Master) Administration Server.
Alias
The alias of the (Master) Administration Server on the target host.
User, Password and
Windows NT Domain
The credentials for logging on to Host. The Windows NT Domain
is optional.
4. Specify what settings to migrate to the V5.5 system:
Prompt
Description
Configuration Import Options
Transfer Trusted
Client Information?
Specify whether to transfer information about trusted clients.
Transfer Bind IP
Information?
Specify whether to transfer information about IP bindings. (See the
“Bind IP” setting in the Verity K2 Dashboard Administrator Guide.)
Transfer Path
Information?
Specify whether to transfer path settings from the V5.0.1 host to the
V5.5 host. This includes paths for indexes, knowledge bases, query
logs, and so on.
Transfer Query Log
Exclude Information?
Specify whether to transfer information about what hosts to
exclude from query logging (as configured through rcadmin’s
querylogexcludeset command).
5. AdminConfigImport shows what hosts and ports are going to be used and then
prompts you to confirm whether you want to start the migration.

If you answer y, AdminConfigImport proceeds.

If you specify a port number already in use, you are prompted for another port.
AdminConfigImport configures the V5.5 K2 system with the same K2 services (K2
Brokers, K2 Servers, K2 Ticket Servers, and so on) as the V5.0.1 system.
14
Verity K2 Migration: V5.0.1 to V5.5
1 Migrating from K2 V5.0.1
Migrating K2 Configuration Settings with AdminConfigImport
After running AdminConfigImport
Follow these steps after running AdminConfigImport.
1. Restart the V5.5 Administration Server.
2. Use the V5.5 K2 Dashboard or rcadmin to recreate the K2 hierarchy.
AdminConfigImport preserves the K2 hierarchy within any given host, but it cannot
recreate the inter-host hierarchy such as K2 Servers attached to a K2 Broker.
3. If you used CPU bindings, use the V5.5 K2 Dashboard or rcadmin to re-bind them.
4. Use K2 Dashboard to re-set character encoding, filtered hosts and other preferences.
5. If you have set directory access permissions in the verity.cfg file, you must ensure
that those paths are correct in the K2 V5.5 system. For more information, see the
"Editing the K2 Configuration File (verity.cfg)" section in the "Using Advanced
Administrative Procedures" chapter of the Verity K2 Dashboard Administrator Guide.
6. Ensure paths to indexes are maintained. Even if an index does not require re-creating or
re-indexing, you must ensure the index path is maintained and the index can be
accessed by the V5.5 Administration Server.

K2 does not require you to specify a path for indexes. If the path is left blank, K2
uses its default. In K2 V4.5.1 and K2 V5.0.1, the default path is K2Data\colls
where K2Data is the path you specified during installation for your main data
directory. If you specified your own paths, use rcadmin to set the path for K2 V5.5.

If the path is set in V5.0.1, and you reply y (yes) to AdminConfigImport “Transfer
path information?” prompt, the path setting will be copied to the V5.5 system.

If the V5.0.1 and V5.5 systems are not on the same host, the new index path in 5.5
will be wrong unless both hosts can use the same path.
Paths that both hosts can use include fully qualified paths (/net/machinename/
sharename on UNIX or \\machinename\sharename on Windows). On
Windows, paths also include Windows network drives that are mapped to the same
drive letter on both hosts.
7. Ensure paths to documents are maintained. Even if an index does not require
re-indexing or is moved from its existing server to a V5.5 K2 Server, ensure the paths to
the documents in the index are maintained, and the documents can be viewed.

If you copy an index from a V5.0.1 K2 Server to a V5.5 K2 Server, you may not be
able to view the documents that are referenced in the index when that index is
searched. You must also copy the indexed documents to the V5.5 system, and ensure
the original path structure to the documents is replicated in the V5.5 system.
Verity K2 Migration: V5.0.1 to V5.5
15
1 Migrating from K2 V5.0.1
Migrating K2 Configuration Settings with AdminConfigImport

16
If an index and its documents remain on the original V5.0.1 K2 Server, then you
must ensure the V5.5 K2 Server can access the path to the documents.
Verity K2 Migration: V5.0.1 to V5.5
2
Migrating Collections
This chapter describes how to re-create your collections so they are compatible with K2
V5.5. Re-creating a collection involves re-creating the entire style set, using StyleSet
Editor, as well as re-running any indexing jobs for the collection.
Note
Re-creating collections is only necessary if you want to take advantage
of new features and for any collection that was created using the Asian
locales japanb, koreab, simpcb, or tradcb must be re-created.
It contains the following sections:

Maintaining V5.0.1 Collections in K2 V5.5

Utilizing V5.5 Enhancements with Standard Style Files

Utilizing V5.5 Enhancements with Edited Style Files
17
2 Migrating Collections
Maintaining V5.0.1 Collections in K2 V5.5
Maintaining V5.0.1 Collections in K2 V5.5
If you do not need any of the new enhancements in K2 V5.5, follow these steps:
1. Copy the style set from your previous collection to a directory that can be accessed by
the K2 Dashboard.
You can use any directory you like, but the path to the directory must be in the K2
Dashboard configuration file, verity.cfg, with read/write access. For more
information, see the "Editing the K2 Configuration File (verity.cfg)" section in the
"Using Advanced Administrative Procedures" chapter of the Verity K2 Dashboard
Administrator Guide.
2. Import the style set through the K2 Dashboard:
a. In System Administration in the K2 Dashboard, ensure you are in the Host view. In
the tree at the left-hand side, select the Master Administration Server.
b. In the Actions menu, select Manage Stylesets.
c. In the Manage Stylesets dialog, click Import.
d. In the Import Styleset dialog, enter an alias name, description, source host, and path
for the older style set that you copied in step 1. Click Import.
Utilizing V5.5 Enhancements with Standard Style Files
If you want to utilize new enhancements in K2 V5.5 and you have not edited the style
files for your collections, re-create the collections using a new V5.5 style set with StyleSet
Editor. For information on creating collections, see:
18

Part IV, “Creating and Managing Indexes” in the Verity K2 Dashboard Administrator
Guide

The Verity gateway guides, depending on what gateway you are using
Verity K2 Migration: V5.0.1 to V5.5
2 Migrating Collections
Utilizing V5.5 Enhancements with Edited Style Files
Utilizing V5.5 Enhancements with Edited Style Files
If you want to utilize new enhancements in K2 V5.5, and you have edited the style files
for your collections, follow these steps:
1. In K2 Dashboard, create a new V5.5 styleset, without customization. See the “Creating
a New Styleset“ section in the “Creating Collections” chapter of the Verity K2 Dashboard
Administrator Guide.
2. If you have modified any of the following style files in your previous collection, copy
them to the V5.5 styleset directory in K2Data\stylesets\new_styleset, where
K2Data is the data directory specified during the K2 V5.5 installation, and
new_styleset is the alias of the style set you created in step 1:

gateway-specific style files (for example, vgw*.vgw, vgw*.cfg, odbcmon.cfg)

style.fxs

style.go

style.plc

style.stp

style.tde

style.ufl

style.xml

style.zon
3. Create a new collection using the style set you just created. For information on creating
collections, see the following:

Part IV, “Creating and Managing Indexes” in the Verity K2 Dashboard Administrator
Guide

The Verity gateway guides, depending on what gateway you are using
Verity K2 Migration: V5.0.1 to V5.5
19
2 Migrating Collections
Utilizing V5.5 Enhancements with Edited Style Files
20
Verity K2 Migration: V5.0.1 to V5.5
3
Migrating Other Data and Settings
This chapter describes how to modify your non-collection indexes, data, jobs and scripts
so they are compatible with K2 V5.5. It contains the following sections:

Migrating Indexing Jobs

Preparing rcadmin Scripts

Preparing Locales and Thesaurus Files

Preparing Recommendation Indexes

Preparing Verity Federator
21
3 Migrating Other Data and Settings
Migrating Indexing Jobs
Migrating Indexing Jobs
You may wish to recreate your spidering jobs in the V5.5 system. This avoids potential
problems due to changed index paths and different port numbers between the old system
and the new V5.5 system. It also enables you to take advantage of the new job
scheduling, routing, and chaining capabilities of the K2 Dashboard.
If you wish to migrate your existing jobs, after running AdminConfigImport:
1. Copy the following files from your old job directory (K2Data/jobs/jobalias) to the
V5.5 job directory:

job.prx (If applicable. This holds the encrypted credentials for the proxy.)

processbif (If applicable. This is the bulk insert file (BIF) file used by K2 Spider.)

job.auth (If applicable. This applies to HTTP collections only and is the credential
file for secure HTTP collections.)

data.dat ((This file and the ones below are used to maintain incremental updates)

rwkey.dat

rwrc.dat

rwdb.lck

state.txt
2. After migrating your jobs, change the “Number of Jumps” field to a non-zero number
(for example, 255) before running the job. When a job is created in V4.5.1, if the
Number of Jumps field is 0, K2 defaults to a non-zero value. In V5.5, however, this
behavior was changed to use the given Number of Jumps. So if it is left at 0, K2 Spider
will not index deeper than the top level.
22
Verity K2 Migration: V5.0.1 to V5.5
3 Migrating Other Data and Settings
Preparing rcadmin Scripts
Preparing rcadmin Scripts
This section describes how to modify existing rcadmin scripts so they are compatible
with V5.5.
If you have created scripts using earlier versions of rcadmin, there are two ways to make
your rcadmin scripts compatible with V5.5:

If you want to use the new features in V5.5, modify your scripts to reflect those
changes. For a list of changes in V5.5, see the “Revisions in K2 Version 5.5” section in
the Verity K2 rcadmin Guide.

If you do not need the new functionality, you can use the version command to
emulate a previous version of rcadmin.
Verity recommends that you update your scripts to the most current version of rcadmin
whenever possible.
The version command filters the commands and parameters that are made available in
the program. For example, typing version 4.5 will expose V4.5.1 rcadmin commands.
Note
If you use the version command, the only change you must make to
existing scripts is to add the following to the command input file:
version version_number
where version_number can be any of the following options:
Option
Description
4.5
This emulates rcadmin version 4.5.1.
5.0
This emulates rcadmin version 5.0.1..
If a version number is not entered, then the most current version is emulated.
Verity K2 Migration: V5.0.1 to V5.5
23
3 Migrating Other Data and Settings
Preparing Locales and Thesaurus Files
Preparing Locales and Thesaurus Files
This section helps you determine whether you need to modify any locale components.
24

Custom locales created with previous versions of K2 must be recompiled.

Custom thesaurus files (vdk30.syd) created with previous versions of K2 must be
re-built from the source file with the mksyd command-line tool. For information on
creating thesaurus files, see the “Creating a Custom Thesaurus” section in the Verity
Locale Configuration Guide.

The Basis Technology Asian locales will have changed tokenization.
Verity K2 Migration: V5.0.1 to V5.5
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Preparing Recommendation Indexes
To ensure you have a saved state you can recover if necessary, before installing K2 5.5
back up all Recommendation Indexes and data from:
data/collsaux
data/host/re
data/ris
Also back up any transaction files that you need to re-create Recommendation Index
states in case you must re-create your Recommendation Indexes.
New Features Since K2 V5.0.1

In K2 V5.0.1, you administered the Recommendation Engine and Recommendation
Indexes by way of rcadmin and VAdministration only. Now you can also use K2
Dashboard. For more information, see Chapter 15, “Creating and Managing a
Recommendation Index” in the Verity K2 Dashboard Administrator Guide.

In K2 V5.0.1 stemming and profile decryption were disabled by default. They are now
both enabled by default.

To utilize these features if you did not enable them in K2 V5.0.1, see “Enabling
Stemming and Profile Decryption” on page 25.

To maintain your existing Recommendation Indexes without utilizing these
features, see “Preserving Existing Recommendation Indexes” on page 27.
Enabling Stemming and Profile Decryption
In K2 V5.0.1, stemming and profile decryption were enabled with environment variables:

RE_STEM managed stemming

RE_MAP_TERMS managed profile decryption
Note
Verity recommends that you re-create your Recommendation Indexes so
that these features are available to you. See the Verity K2 Recommendation
Engine Guide for more information on the benefits of stemming and profile
decryption.
Verity K2 Migration: V5.0.1 to V5.5
25
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Stemming and Profile Decryption Disabled in K2 V5.0.1
For Recommendation Indexes where both stemming and profile decryption were
disabled in K2 V5.0.1, and you want them both enabled in K2 V5.5, follow these steps to
re-create your Recommendation Indexes.
1. Run the command: mkre -purge
2. Run the command: mkre -update -xml saved_transaction_file
Repeat this command for each saved_transaction_file you have.
For more information on mkre, see the Verity K2 Recommendation Engine Guide.
Note
Because Recommendation Indexes capture user behavior over time by
way of transactions, re-creating the indexes does not reproduce them in
their entirety. If you must maintain your existing Recommendation
Indexes to preserve transaction information, see the following section,
“Preserving Existing Recommendation Indexes.”
Stemming Disabled, Profile Decryption Enabled in K2 V5.0.1
For Recommendation Indexes where stemming was disabled and profile decryption was
enabled in K2 V5.0.1, and you want to enable stemming in K2 V5.5, follow these steps.
1. Run the command: mkre -export filename
2. Enable stemming in the K2 Dashboard.
3. Run the command: mkre -purge
4. Run the command: mkre -update -xml filename
This process exports the current state of the Recommendation Indexes to XML files, and
stems the terms during the update process.
26
Verity K2 Migration: V5.0.1 to V5.5
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Preserving Existing Recommendation Indexes
You can preserve your existing Recommendation Indexes by using K2 Dashboard
immediately after installing K2 V5.5 to disable whichever feature you had disabled in K2
V5.0.1. You must disable the relevant feature(s) before any mkre commands are run.
Scenarios in K2 V5.0.1
Instructions
stemming enabled by way of RE_STEM
Do nothing. Both features are enabled by
default.
profile decryption enabled by way of
RE_MAP_TERMS
stemming enabled by way of RE_STEM
Disable profile decryption in K2 Dashboard.
profile decryption not enabled
stemming not enabled
Disable stemming in K2 Dashboard
profile decryption enabled by way of
RE_MAP_TERMS
stemming not enabled
Disable both features in K2 Dashboard
profile decryption not enabled
Using K2 Dashboard
1. Select the host view.
2. Select the appropriate Administration Server alias.
3. Select the Edit Properties action dialog.
4. De-select Enable Word Stemming and Enable Profile Decryption as appropriate.
Verity K2 Migration: V5.0.1 to V5.5
27
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Recommendation Index Location Changes
The location of Recommendation Indexes is different in K2 V5.5.
All Recommendation Indexes reside under data/ris/type/alias where data is a
user-configurable path ususally specified at installation.
Recommendation Indexes for Collections
In K2 V5.0.1, a Recommendation Index for a collection named C1 resided in:
data/collaux/C1/re/doc.dat
In K2 V5.5, the Recommendation Index for a collection named C1 resides in:
data/ris/doc/C1/index.dat
User Indexes Per Host
In K2 V5.0.1, user indexes created per host resided in:
data/host/re/user.dat
In K2 V5.5, the user index for a host resides in:
data/host/ri/user/users/index.dat
Other Recommendation Indexes
In K2 V5.0.1, other Recommendation Indexes resided in:
data/host/re/type/alias/index.dat
In K2 V5.5, the user index for a host resides in:
data/ris/type/alias/index.dat
map.dat File
The file map.dat remains in:
data/host/re/map.dat
28
Verity K2 Migration: V5.0.1 to V5.5
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Migrating Recommendation Indexes
Use the following mkre command to migrate your K2 V5.0.1 Recommendation Indexes
to their new locations.
mkre -update
Once you have verified that the Recommendation Indexers are in their new locations and
are known to be operating correctly, you must remove the old copies of the indexes by
running:
mkre -purgeOld
Note
Do not run the command mkre -purge, or mkre -purgeOld if you
want to migrate or move indexes. The command mkre -purge gets rid
of all the indexes and state (map.dat), rendering the old indexes invalid.
Verity K2 Migration: V5.0.1 to V5.5
29
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Modifying mkre Scripts
No changes are necessary to your scripts.
Changes to Transaction Logging
There is one transaction file created per index rather than a single transaction file per
host. This enables management of a single index at a time, for significantly reduced
resource overhead.
Changes to mkre
New options and changes to existing options in mkre facilitate managing and updating a
single Recommendation Index at a time.
New options are available that enable mkre to execute on a different host from the host
with K2 Server, reducing the memory requirements on the host. This requires that the file
system locations for the indexes are the same on both hosts. For example, on network
mounted storage.
The new options are:

-adminhost

-adminport

-adminalias
The following options have been changed to include <type> and <alias> parameters:

-create

-update

-updatenoreload
Use the <type> parameter to operate on all RIs of the specified type. Use the <alias>
parameter to operate on an RI of a specific alias.
For more information, see the Verity K2 Recommendation Engine Guide.
30
Verity K2 Migration: V5.0.1 to V5.5
3 Migrating Other Data and Settings
Preparing Recommendation Indexes
Changes to Recommendation Engine Configuration
All Recommendation Indexes are now treated uniformly by way of creating and
attaching RIs, to conform to the model of user-defined RIs.
The AdminConfigImport command line tool, described in “Migrating K2
Configuration Settings with AdminConfigImport” on page 12, migrates your RIs to V5.5
for you.
For more information, see:

“Managing Recommendation Indexes” in Chapter 7, “Managing Indexes” in the Verity
K2 rcadmin Guide.

Chapter 15, “Creating and Managing a Recommendation Index” in the Verity K2
Dashboard Administrator Guide.
Administering Recommendation Indexes
Verity recommends that you use K2 Dashboard for all of your administration needs with
regard to the Recommendation Engine and Recommendation Indexes.
If you want to continue to use the rcadmin command line tool, note the following:

the collreset command has been deprecated, replaced with riset.

the reuserset command has been deprecated, replaced with indexattach of a
Recommendation Index of type user, with an alias of users
Verity K2 Migration: V5.0.1 to V5.5
31
3 Migrating Other Data and Settings
Preparing Verity Federator
Preparing Verity Federator
The Verity Federator product is not bundled with K2 V5.5. It was shipped as part of
Verity K2 V5.0.1, and is now distributed as a stand-alone application. See the Verity
Federator documentation for information about the latest version of Verity Federator.
Customers with JSP Deployment of Federator with K2 V5.0.1
If you had installed the JSP version of the Federator with K2 5.0.1 and upgrade to K2 V5.5
on the same host, Federator will continue to work with the new version of K2.
Customers with JSP Deployment of Federator with K2 V5.0.1
Existing ASP deployments of Federator are NOT compatible with K2 5.5 because the
libraries shipped with K2 5.5 no longer include the Federator. So if you have deployed
Federator in ASP mode, do NOT install K2 V5.5 on the same host.
32
Verity K2 Migration: V5.0.1 to V5.5

Download Report

Verity K2 Migration: V5.0.1 to V5.5

Paperzz.com

Your Paperzz