iManage WorkSite Server Administrator’s guide Version 8.5 June 2009
Copyright Notice
Notice © 1999-2009 Autonomy Corporation plc and its affiliates. All rights reserved. No part of this publication (hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of Autonomy Corporation plc and its affiliates. Information in this manual is furnished under license by Autonomy Corporation plc and its affiliates and may only be used in accordance with the terms of the license agreement. If this software or documentation directs you to copy materials, you must first have permission from the copyright owner of the materials to avoid violating the law which could result in damages or other remedies.
Trademarks and Copyrights Interwoven, iManage, ConfirmSite, ContentServices, ControlHub, DataDeploy, DeskSite, FileSite, iManage, iManage Universal Search, iManage WorkSite, LiveSite, MediaBin, MetaCode, MetaTagger, OffSite, OpenDeploy, Primera, Records Manager, iManage Records Manager, Scrittura, TeamPortal, TeamSite, VisualAnnotate, WorkDocs, WorkPortal, WorkRoute, WorkSite, WorkSite Express Search, WorkTeam, the respective taglines, logos and service marks are trademarks of Autonomy Corporation plc and its affiliates, which may be registered in certain jurisdictions. All other trademarks are owned by their respective owners. Some or all of the information contained herein may be protected by patent numbers: US # 6,505,212, GBRI # 1053523, US # 6,480,944, US# 5,845,270, US #5,430,812, US #5,754,704, US #5,347,600, AUS #735365, AU 7830068, GB #GB2333619, US #5,845,067, US #6,675,299, US #5,835,037, AUS #632333, CAN #2,062,965, FRAN / GRBI / SPAI / SWED #480941, GERM #69020564.3, KORS 10-0576487, JAPA #2968582, MX #219522, NZ #516340, SING #109524, SG #89006, SG #89086, SG #74973, SG #85502 US #5,065,447, US #6,609,184, US #6,141,017, US #5,990,950, US #5,821,999, US #5,805,217, US #5,838,832, US #5,867,221, US #5,923,376, US #6,434,273, US #5,867,603, US #4,941,193, US #5,822,721, US #5,923,785, US #5,982,938, US #5,790,131, US #5,721,543, US #5,982,441, US #5,857,036, US #6,697,532, US #6,792, 454, US #6,928,149, US #7,092,969 or other patents pending application for Autonomy Corporation plc and its affiliates.
Autonomy Corporation plc Cambridge Business Park Cowley Rd Cambridge CB4 0WZ Tel: +44 (0) 1223 448000 Fax: +44 (0) 1223 448001 Email:
[email protected]
6/12/09 Part Number 04-001-07-EN
Contents
About This Book Intended Audience. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Notation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Manual Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Product Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Documentation Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 1:
Introduction Components of the WorkSite Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkSite Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkSite Server Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkSite Indexer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Client Applications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administrative Tools or Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 2:
Using the WorkSite Service Manager Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About WorkSite Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkSite Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Started with WorkSite Service Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . Understanding the Table View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Finding WorkSite Servers. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registering and Unregistering Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registering a WorkSite Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unregistering a Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting and Stopping a Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configure Startup Properties for the Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring WorkSite Server Service Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring WorkSite Server Service Database Properties . . . . . . . . . . . . . . . . . . . Configure Connections from WorkSite Server to File Servers . . . . . . . . . . . . . . . . Troubleshooting Startup Errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Version Information and Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WorkSite Server Administrator’s guide
19 19 19 20 21 21 22
23 23 24 24 24 25 25
27 27 27 28 28 29 30 30 31 31 32 32 33 33 34 38 41 43 44 • • • 3 • • •
Contents
Chapter 3:
Using the Database Administration Tool
45
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Database Administration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting and Stopping the DBAdmin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DBAdmin Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Tree Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Table Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching the Table Frame . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Right-click Menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Information Tables and Subtables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registering WorkSite Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Login Feature. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Login Failures and the Reconnect button . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring WorkSite Database Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing the User History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Database Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Synchronization Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Items to an Information Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Items in an Information Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching in a Table or List View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Lookup Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Max Lookup Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 4:
Administering Users, Groups, and Security
65
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purpose of the User Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Virtual Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Microsoft Windows OS Domain Users. . . . . . . . . . . . . . . . . . . . . . . Adding Novell Bindery Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Novell NDS Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding LDAP Directory Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing the Default Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing User Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Synchronize Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NRTADMIN Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Virtual Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Microsoft Windows Domain Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a Novell Bindery Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Novell NDS Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding LDAP Directory Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • • • 4 • • •
45 45 46 46 46 47 48 48 49 49 51 53 53 53 57 57 58 59 60 60 61 62 63 63 65 65 66 67 67 69 71 73 75 82 82 83 84 85 85 87 88 90 92
WorkSite Server Administrator’s guide
Contents
Assigning Users to Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Changing Group Membership . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Adding Users to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Removing Users from a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99 Editing Group Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Preferred Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Adding a Database to the Databases Information Table . . . . . . . . . . . . . . . . . . 101 Assigning Preferred Databases to Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Changing Preferred Database Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 File Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Adding File Servers to a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 Assigning File Servers to Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 Adding Users to a File Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Reassigning Authors to the Default File Server. . . . . . . . . . . . . . . . . . . . . . 107 Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Roles and Document Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Examples of Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Creating Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Default role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Setting Restrictions for Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . 113 Edit/Create Profile and Search Profile Tabs . . . . . . . . . . . . . . . . . . . . . . . . 113 Assigning Roles to Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Editing Membership for a Single Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115 Editing Membership for Multiple Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 Security Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Creating a Security Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Assigning Users to an Existing Security Template . . . . . . . . . . . . . . . . . . . 120 Renaming Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Using the Rename Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Chapter 5:
Configuring Server Settings Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Defining Application Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Customizing the App Setup List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding an Application Setup Entry. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing an Existing Application Record . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping Multiple Document Types to the Same Application. . . . . . . . . . . Managing Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Default Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Autodetect Document Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . NonAutodetect Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File Type Mapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping WorkSite Document Types to File Types . . . . . . . . . . . . . . . . . . . . . Adding Custom Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WorkSite Server Administrator’s guide
125 125 125 126 126 127 130 131 131 132 133 133 134 135 • • • 5 • • •
Contents
Adding a Document Type to a Database . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Document Class and Subclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a New Document Class. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Document Class Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Document Class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Subclasses . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a Subclass . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing Subclass Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing PC Locations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a PC Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a PC Location . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing PC Locations from an ANSI Text File . . . . . . . . . . . . . . . . . . . . . . . Managing Custom Tables and Subtables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Common Usage for Custom Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Administering Custom3 to Custom12 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Entries to Custom3 to 12 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying Entries in Custom3 to Custom12 Tables . . . . . . . . . . . . . . . . . . Deleting Entries in Custom3 to Custom12 Tables . . . . . . . . . . . . . . . . . . . . Modifying the Custom3 to Custom12 Table Headings . . . . . . . . . . . . . . . . Importing Custom3 to Custom12 Table Entries . . . . . . . . . . . . . . . . . . . . . Administering Custom1/Custom2 and Custom29/Custom30 Tables . . . . . . . . Introduction to Custom1/Custom2 Tables . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Editing Custom1 and Custom29 Items. . . . . . . . . . . . . . . . . . . Deleting a Custom1 or Custom29 Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding and Editing Custom2 and Custom30 items . . . . . . . . . . . . . . . . . . . Importing Custom1/Custom2 and Custom29/Custom30 Table Entries . . . . Using the Subtable Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 6:
Using the Document Import Tool
159
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Document Import . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features and Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Import Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting and Stopping the Document Import Tool . . . . . . . . . . . . . . . . . . . . . . . . . Log into a WorkSite Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Off from a WorkSite Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a New Profile Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting a Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Autodetect and Nonautodetect Document Types. . . . . . . . . . . . . . . . . . . . . Using Selection Boxes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dynamic Profile Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Where to Use Dynamic Profile Field Commands . . . . . . . . . . . . . . . . . . . . Combining Profile Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Filename or Extension Substring Extraction . . . . . . . . . . . . . . . . . . . . . . . . • • • 6 • • •
136 138 139 139 140 141 142 143 143 144 144 145 145 145 147 148 148 149 150 150 150 150 151 151 153 153 153 155 158 159 159 160 160 161 162 163 163 165 166 167 168 169 169 170
WorkSite Server Administrator’s guide
Contents
Subdirectory and Subdirectory Substring Extraction. . . . . . . . . . . . . . . . . . Default Profile Entry Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Types of Custom Fields. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating an Exclude and Include List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Loading an Import Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Log Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Purging the Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 7:
Using the Dialog Editor Tool Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About Dialog Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging into a Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Logging Off a Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selecting or Deselecting Database(s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dialog Editor Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Dialog Editor Left Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Align Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Elements Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Captions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Form Management. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Opening a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Forms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Forms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reloading Forms from the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Saving a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Closing a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Form Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Controls to a Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a Canvas Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding a Logo Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding the External User Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Controls. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Control-Specific Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Aligning Spacing and Resizing Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Properties on a Form or Control . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WorkSite Server Administrator’s guide
171 171 172 172 173 174 176 176 176 177 178 180 180
181 181 181 182 183 183 184 184 185 185 186 186 186 187 188 188 188 189 190 190 190 191 192 192 194 195 197 197 198 199 199 200 • • • 7 • • •
Contents
Moving and Deleting Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing and Exporting Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Importing Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting Controls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Testing and Analyzing a Form Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Tab Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 8:
Using the Monitor Tool
205
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About WorkSite Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Starting WorkSite Monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Registering and Unregistering WorkSite Servers. . . . . . . . . . . . . . . . . . . . . . . . . . The WorkSite Monitor Desktop. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Keyboard Shortcuts and Toolbar Buttons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Server WorkSpace Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Icons in the Server WorkSpace Window . . . . . . . . . . . . . . . . . . . . . . . . . . . Information Window . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Results WorkSpaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Statistics Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document Search Results Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Document History Search Results Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . Active Users Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Results Tab Right-click Menu Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Search Results Display Options . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Support Dialogs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Selection Dialog Box (Lookup Tables) . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setup Additional Custom Fields Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . Setting Up Custom Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using WorkSite Monitor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching for Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching the Document History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Entries in the Document History Table . . . . . . . . . . . . . . . . . . . . . Redisplaying Search Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Printing Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Printer Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Print Preview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unlocking Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Relocating Documents between Databases. . . . . . . . . . . . . . . . . . . . . . . . . . . . Relocating Documents. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Changing Document Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bulk Profile Edit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Reassigning Documents by Author or Operator . . . . . . . . . . . . . . . . . . . . . . . . Document Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Marking Documents for Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Unmarking Documents for Archiving . . . . . . . . . . . . . . . . . . . . . . . . . . . . . • • • 8 • • •
201 201 201 201 202 202 205 205 206 206 208 209 210 211 212 213 213 214 215 216 216 217 220 221 221 221 222 222 224 226 226 226 226 226 227 227 229 231 235 237 239 240 241 244
WorkSite Server Administrator’s guide
Contents
Viewing Marked Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Archiving. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring Archived Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring Archived Documents from User Requests . . . . . . . . . . . . . . . . . Restoring Archived Documents from Archive Sets . . . . . . . . . . . . . . . . . . . Set Priority . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Create a Custom Toolbar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Log Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Find Dialog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 9:
Configuring the Rules Engine Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Requirements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preparing for the Rules Engine Server Installation . . . . . . . . . . . . . . . . . . . . . . . . Installing Rules Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Rules Engine Service Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring Rules Engine Database Properties . . . . . . . . . . . . . . . . . . . . . . . . Configuring Rules Engine Service File Server Properties . . . . . . . . . . . . . . . . Configuring Rules Engine Service Properties . . . . . . . . . . . . . . . . . . . . . . . . . Starting the Rules Engine Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test SMTP Connectivity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring SMTP Service to Allow Forwarding to Remote Domains. . . . . . . . . Associating Events with a Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up an E-mail Host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 10:
WorkSite Cluster Manager Service Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Introduction to Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using Server Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Advantages of Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Does Clustering Work? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Features of Clustering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Load Balancing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Automatic Client Redirection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up a WorkSite Server Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phase 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phase 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phase 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Phase 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using the Cluster Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UDP Port Requirements for Clustering Transport . . . . . . . . . . . . . . . . . . . . . . . . . UDP Reply Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Cluster Manager Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring WorkSite Server Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Service Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
WorkSite Server Administrator’s guide
246 246 248 249 250 254 254 255 255
257 257 257 258 258 261 261 262 264 265 265 267 270 271
273 273 273 274 274 275 275 276 277 278 278 278 279 279 279 279 280 280 281 283 283 • • • 9 • • •
Contents
Database Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285 WorkSite Server Cluster Example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 286
Chapter 11:
Directory Service Synchronization Service
287
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Directory Service Synchronization Service Works . . . . . . . . . . . . . . . . . Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing DSS Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the DSS Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting the DSS Schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating Connections to DSS Services. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Specifying External Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mapping Directory Service Attributes to WorkSite. . . . . . . . . . . . . . . . . . . Running the DSS Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 12:
Symantec Enterprise Vault Integration
301
About Symantec Enterprise Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SEV Integration for WorkSite Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Supported Versions and Packaging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Upgrading the Database Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Test the DbUpgrade Utility on a Database Copy . . . . . . . . . . . . . . . . . . . . . . . Using the DbUpgrade Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Vault Admin Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Microsoft Exchange Server MAPI Client and CDO . . . . . . . . . . . . . . . User Account Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Adding User Account to Windows Registry . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Integrating Symantec Enterprise Vault with WorkSite Server . . . . . . . . . . . . . . . . Understanding DMS Log File Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . EMAIL_ATTRS Table and Status Codes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Fatal and Non-Fatal SEV Errors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Heartbeat Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 13:
WorkSite Server with Caching
Tools and Utilities
301 301 302 302 303 304 304 305 305 305 308 313 313 314 314
317
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About WorkSite Server with Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Caching Server Technology. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Cache Fileserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Preloading the Cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Configuring the WorkSite Server for File Caching. . . . . . . . . . . . . . . . . . . . . . Purging the Cache Fileserver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview of Proxying Capabilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting up Library Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chapter 14:
287 288 288 289 291 291 292 297 298 299
317 317 318 319 320 321 323 323 325
329
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 Migrating Users to a Different Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 329 • • • 10 • • •
WorkSite Server Administrator’s guide
Contents
Working of User’s Preferred Database Migration Tool . . . . . . . . . . . . . . . . . . Stage 1: Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stage 2: Copy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stage 3: Finalization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stage 4: Deletion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Performing a Preferred Database Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . Populating Custom Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The clload Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Format for the ANSI Text File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Skipping the Description Field . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Loading Multiple Child Table Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Examples of Valid Command Line Entries . . . . . . . . . . . . . . . . . . . . . . . . . Populating User Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The userload command. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Required Format for the ANSI Text File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Appendix A: Reading the WorkSite Server Log File
330 330 331 331 332 332 333 333 333 334 334 337 337 338 338 339 339 339 339
343
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 343 Common DMSLog.txt File Entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 344
Appendix B: Database Schema
349
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 349
Appendix C: Server Configuration Options Allowing Description Fulltext Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . OCR-TIFF Replacement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . UTC Date Storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Search Results Sorting. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Restrict Data Sizes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Case Insensitive Searches in Oracle Databases . . . . . . . . . . . . . . . . . . . . . . . . . . . Version Editing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retain Only Latest Version on Worklist . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ignore Disabled Groups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Immutable E-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkList Filtering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pessimistic Security. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . One-Way or Two-Way Document Relations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . E-mail Duplicate Detection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Enable/Disable User Edit of the Folder E-mail Address Field. . . . . . . . . . . . . . . . Unicast or Multicast Clustering Transport Options . . . . . . . . . . . . . . . . . . . . . . . . Default Minutes Between Synchronization Passes . . . . . . . . . . . . . . . . . . . . . . . . Kerberos Authentication on Trusted Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . WorkSite Server Administrator’s guide
355 356 357 357 358 360 361 361 362 363 363 364 364 365 366 366 367 367 368 • • • 11 • • •
Contents
Using a Local System Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using a Domain User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Using a Domain User Account on Windows 2000 Server Domain . . . . . . . Using a Domain User Account on a Windows Server 2003 Domain. . . . . . Enforcing Kerberos Authentication on Trusted Login . . . . . . . . . . . . . . . . . . . Support for Unknown File Types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Retain Extension for ANSI Types Registry Key . . . . . . . . . . . . . . . . . . . . . Retain Extension for Non-E-mail Types Registry Key . . . . . . . . . . . . . . . . Server Side Email Filing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Allow Folder Creation in Public Workspaces . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Index
• • • 12 • • •
368 369 369 370 371 372 373 374 375 375
377
WorkSite Server Administrator’s guide
Figures
Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 Figure 15 Figure 16 Figure 17 Figure 18 Figure 19 Figure 20 Figure 21 Figure 22 Figure 23 Figure 24 Figure 25 Figure 26 Figure 27 Figure 28 Figure 29 Figure 30 Figure 31 Figure 32 Figure 33 Figure 34 Figure 35 Figure 36 Figure 37 Figure 38
Components of the WorkSite Server .......................................................................... 23 WorkSite Service Manager with Registered Servers .................................................. 29 WorkSite Servers Search status box .......................................................................... 31 Select Server dialog box ............................................................................................. 32 WorkSite Server Startup Dialog .................................................................................. 33 WorkSite Server Properties Dialog ............................................................................. 35 WorkSite Server Database Setup Dialog.................................................................... 38 Database Properties Dialog ........................................................................................ 39 Advanced Properties dialog box ................................................................................. 40 File Server Connections Dialog, Windows tab ............................................................ 42 File Server Connections Dialog, NetWare Tab ........................................................... 43 Configuration Error Message ...................................................................................... 43 About WorkSite Service Manager Dialog.................................................................... 44 DBAdmin Main Program Window ............................................................................... 47 Right-click menu for the table frame ........................................................................... 48 Floating toolbar ........................................................................................................... 49 Register/Unregister Databases Dialog........................................................................ 52 Set Database Options Dialog...................................................................................... 54 Information window for the Database ......................................................................... 58 Synchronization Options dialog box............................................................................ 59 Edit Jurisdiction Dialog................................................................................................ 61 Find Dialog.................................................................................................................. 61 Lookup Bar in DBAdmin.............................................................................................. 62 Edit Max Lookup Entries Dialog.................................................................................. 63 Sample error message................................................................................................ 64 User accounts and their function ................................................................................ 66 Add New Users dialog box, Virtual User tab ............................................................... 68 Add New Users Dialog, Microsoft Windows OS Domain Users Tab .......................... 70 Add New Users dialog box, Novell Bindery Users tab ................................................ 72 Add New Users dialog box, Novell NDS Users tab..................................................... 74 LDAP Directory Users Tab.......................................................................................... 76 LDAP Authentication Dialog........................................................................................ 77 LDAP Attribute Mapping (User) Dialog ....................................................................... 78 Add New Users Dialog, LDAP Directory Users Tab ................................................... 79 Too many directory objects warning ........................................................................... 80 LDAP Directory Search Filter...................................................................................... 81 Edit User Information Dialog ....................................................................................... 83 Add New Groups Dialog, Virtual Group Tab ............................................................... 86
WorkSite Server Administrator’s guide
• • • 13 • • •
Figures
Figure 39 Figure 40 Figure 41 Figure 42 Figure 43 Figure 44 Figure 45 Figure 46 Figure 47 Figure 48 Figure 49 Figure 50 Figure 51 Figure 52 Figure 53 Figure 54 Figure 55 Figure 56 Figure 57 Figure 58 Figure 59 Figure 60 Figure 61 Figure 62 Figure 63 Figure 64 Figure 65 Figure 66 Figure 67 Figure 68 Figure 69 Figure 70 Figure 71 Figure 72 Figure 73 Figure 74 Figure 75 Figure 76 Figure 77 Figure 78 Figure 79 Figure 80 Figure 81 Figure 82 Figure 83 Figure 84 Figure 85 Figure 86 Figure 87 • • • 14 • • •
Add New Groups Dialog, Microsoft Windows OS Domain Groups Tab...................... 88 Add New Groups Dialog, Novell Bindery Groups Tab ................................................ 89 Add New Groups Dialog, Novell NDS Groups Tab ..................................................... 91 LDAP Directory Groups Tab ....................................................................................... 93 LDAP Authentication Dialog........................................................................................ 94 LDAP Attribute Mapping (Group) dialog box............................................................... 95 Add New Groups Dialog, LDAP Directory Groups Tab............................................... 96 Too many directory objects warning ........................................................................... 97 LDAP Directory Groups, LDAP Directory Search Filter .............................................. 97 Group Management Dialog......................................................................................... 99 Add Databases Dialog .............................................................................................. 101 Preferred Database Management Dialog ................................................................. 102 Add File Servers Wizard, Select File Server Container ............................................ 104 Add File Servers Wizard, File Server Name ............................................................. 105 File Server Assignment dialog box ........................................................................... 106 Role Setup Dialog, Privileges Tab ............................................................................ 111 Role Setup Dialog, Edit/Create Profile Tab............................................................... 114 Role Setup dialog box, Membership Assignment tab ............................................... 116 Role Management Dialog ......................................................................................... 117 Add Security Templates Dialog................................................................................. 119 Security Template Assignment Dialog ...................................................................... 120 Add App Setup Entry dialog box ............................................................................... 127 Document Type Mapping Management dialog box .................................................. 135 Add Type Dialog ....................................................................................................... 136 Add Class dialog box ................................................................................................ 140 The Add New Node dialog box ................................................................................. 145 The Import From File dialog box ............................................................................... 146 Custom1-Custom 2 tables in parent-child relationships............................................ 152 Add New Item in Custom2 Dialog ............................................................................. 154 Edit Custom2 dialog box ........................................................................................... 154 Import from File (Custom1 and Custom2) dialog box ............................................... 156 Custom2 subtable window ........................................................................................ 158 WorkSite Document Import....................................................................................... 161 Connect Servers ....................................................................................................... 162 Document Import Profile Template dialog box.......................................................... 164 Select Type dialog box.............................................................................................. 167 Setup Additional Custom Fields................................................................................ 173 Include and Exclude File List dialog box................................................................... 175 Import Documents dialog box ................................................................................... 177 Log File, Sample output ............................................................................................ 179 Dialog Editor Left Pane ............................................................................................. 185 File Toolbar ............................................................................................................... 186 Align Toolbar............................................................................................................. 186 Elements Toolbar...................................................................................................... 186 Set Captions dialog box ............................................................................................ 187 Dialog Editor Left Pane ............................................................................................. 188 Sample Form with all the Controls ............................................................................ 191 Elements toolbar ....................................................................................................... 192 Database Association dialog box.............................................................................. 194
WorkSite Server Administrator’s guide
Figures
Figure 88 Custom Control Association dialog box .................................................................... 195 Figure 89 Custom Control Properties dialog box, General tab ................................................. 196 Figure 90 Custom Control Properties dialog box, Color tab...................................................... 197 Figure 91 External User control, Database Association dialog box .......................................... 198 Figure 92 Quick Search dialog box with tab order .................................................................... 203 Figure 93 Register Servers dialog box...................................................................................... 207 Figure 94 WorkSite Monitor main window................................................................................. 209 Figure 95 Server WorkSpace Window, Servers tab.................................................................. 211 Figure 96 Server WorkSpace Window, Database tab............................................................... 211 Figure 97 Information Window .................................................................................................. 212 Figure 98 Results WorkSpace, Statistics tab ............................................................................ 213 Figure 99 Document Search Results tab .................................................................................. 215 Figure 100Document History Search Results tab ..................................................................... 216 Figure 101Right-click menu in Search Results tab ................................................................... 217 Figure 102Document Search Display, Fields Shown tab .......................................................... 218 Figure 103Document Search Display dialog box, Short Profile Display tab.............................. 219 Figure 104Document Search Display dialog box - Search Size tab.......................................... 220 Figure 105Document Search dialog box ................................................................................... 223 Figure 106Document History dialog box ................................................................................... 225 Figure 107Delete Documents dialog box .................................................................................. 228 Figure 108Deleting Documents dialog box ............................................................................... 229 Figure 109Relocate Documents dialog box .............................................................................. 232 Figure 110Relocate Documents dialog box............................................................................... 234 Figure 111Security Assignment dialog box ............................................................................... 236 Figure 112Bulk Edit Document Profiles dialog box ................................................................... 238 Figure 113Reassign Documents by Operator dialog box .......................................................... 239 Figure 114Reassigning Documents dialog box ......................................................................... 240 Figure 115Mark Documents for Archiving dialog box ................................................................ 243 Figure 116Documents Marked for Archiving dialog box ............................................................ 245 Figure 117Archive Documents dialog box ................................................................................. 247 Figure 118Archiving Documents status box .............................................................................. 248 Figure 119Restore Document Requests dialog box. ................................................................. 249 Figure 120The Document Request List dialog box ................................................................... 250 Figure 121Restore Archived Documents dialog box ................................................................. 251 Figure 122Restore Documents in Archive Set dialog box ......................................................... 252 Figure 123Restore Documents from Archive Set dialog box .................................................... 253 Figure 124Find dialog box ......................................................................................................... 255 Figure 125WorkSite Service Add/Remove ................................................................................ 259 Figure 126Rules Engine Startup Dialog .................................................................................... 260 Figure 127Database Setup dialog box ...................................................................................... 261 Figure 128Database Properties Dialog ..................................................................................... 262 Figure 129File Server Connections Dialog, NetWare tab ......................................................... 262 Figure 130File Server Connections Dialog, Microsoft Windows Tab ........................................ 263 Figure 131File Server Connections Dialog, Microsoft Windows tab ......................................... 263 Figure 132Rules Engine Properties Dialog ............................................................................... 264 Figure 133Command window showing SMTP Connectivity test ............................................... 266 Figure 134Computer Management Window, New Domain ....................................................... 268 Figure 135New SMTP Domain Wizard Dialog .......................................................................... 269 Figure 136New SMTP Domain Wizard Domain Name Dialog .................................................. 269 WorkSite Server Administrator’s guide
• • • 15 • • •
Figures
Figure 137Computer Management, Properties ......................................................................... 270 Figure 138Clustering Model ...................................................................................................... 275 Figure 139Cluster Manager working as a load balancer ........................................................... 276 Figure 140WorkSite Service Add/Remove Program ................................................................. 282 Figure 141Cluster Manager Startup dialog box......................................................................... 282 Figure 142WorkSite Server Service Properties dialog box ....................................................... 284 Figure 143WorkSite Server Database Setup dialog box ........................................................... 285 Figure 144Database Properties dialog box ............................................................................... 285 Figure 145WorkSite Service Add/Remove ................................................................................ 289 Figure 146Directory Synchronization Service Startup Dialog ................................................... 290 Figure 147DS Synchronization Schedule Properties Dialog ..................................................... 292 Figure 148Directory Service Connections Dialog...................................................................... 293 Figure 149DS Synchronization Connection Properties Dialog .................................................. 294 Figure 150DS Synchronization Root Context Dialog ................................................................ 296 Figure 151DS Synchronization Attribute Map Dialog ................................................................ 298 Figure 152WorkSite Service Manager ...................................................................................... 300 Figure 153Registry Editor.......................................................................................................... 306 Figure 154imDmsSvc ................................................................................................................ 306 Figure 155Reconcile UserId ...................................................................................................... 307 Figure 156Edit String Dialog ..................................................................................................... 307 Figure 157WorkSite Service Manager ...................................................................................... 308 Figure 158Stop Service ............................................................................................................. 309 Figure 159Service Properties .................................................................................................... 310 Figure 160WorkSite Server Properties Dialog .......................................................................... 311 Figure 161Enable Symantec(tm) Enterprise Vault Integration .................................................. 312 Figure 162Start Service............................................................................................................. 313 Figure 163WorkSite Server Properties dialog box .................................................................... 321 Figure 164WorkSite Server Database Properties dialog box .................................................... 322 Figure 165Traditional WAN Environment .................................................................................. 324 Figure 166WorkSite Server with Proxying Capabilities ............................................................. 324 Figure 167WorkSite Server Database Setup dialog box ........................................................... 326 Figure 168Server Connection Properties dialog box................................................................. 326 Figure 169Database Properties Dialog ox ................................................................................ 327
• • • 16 • • •
WorkSite Server Administrator’s guide
Tables
Table 1 Table 2 Table 3 Table 4 Table 5 Table 6 Table 7 Table 8 Table 9 Table 10 Table 11 Table 12 Table 14 Table 15 Table 16 Table 17 Table 18 Table 19 Table 20 Table 21 Table 22 Table 23 Table 24 Table 25 Table 26 Table 27 Table 28 Table 29 Table 30 Table 31 Table 32 Table 33 Table 36 Table 37 Table 38 Table 39 Table 40 Table 41
Notation Conventions............................................................................................... Revision History ....................................................................................................... Toolbar buttons and menu options .......................................................................... WorkSite Server Properties Dialog Options ............................................................. Information Tables in the tree frame ........................................................................ Database icon color ................................................................................................. Document Tab, Document History Options ............................................................. User tab, Information ............................................................................................... Document management tasks associated with roles............................................ Using Roles to Manage Document Searches ........................................................ Examples of Roles ................................................................................................. Options on the Privileges Tab................................................................................ Application Setup Properties.................................................................................. Default Document Types ....................................................................................... Document Type Dialog Properties ......................................................................... Changes to NRT.INI file ......................................................................................... Information Fields in the Add and Edit Class dialog boxes.................................... Sample PC Location Records................................................................................ Common Uses for Custom Tables......................................................................... Sample Custom Table entries................................................................................ Dynamic Profile Field Commands.......................................................................... Dialog boxes that can be customized .................................................................... Types of Forms ...................................................................................................... Valid formats for the Custom fields ........................................................................ Restrictions on controls.......................................................................................... Elements toolbar Icons .......................................................................................... Required Controls for Each Form Type ................................................................. Align Controls......................................................................................................... Keyboard Shortcuts and Toolbar Buttons .............................................................. Icons in the Server WorkSpace window ................................................................ Column Headings on the Statistics tab .................................................................. Status Icons ........................................................................................................... ............................................................................................................................... Options Available for Changing Security Settings ................................................. Setting the Frequency with which the Statistics window is updated ...................... Events to Associate with Rules.............................................................................. Abbreviations used in the DMS log file .................................................................. Command Line Parameters ...................................................................................
WorkSite Server Administrator’s guide
19 21 30 35 49 52 55 56 108 109 109 112 128 131 136 137 140 144 148 149 169 181 187 191 192 192 198 199 209 211 213 215 230 235 254 270 315 334 • • • 17 • • •
Tables
Table 42 Table 43 Table 44 Table 45 Table 46
• • • 18 • • •
Mode action on current user values....................................................................... Format Criteria ....................................................................................................... Abbreviations used in the DMSLog.txt file ............................................................. Database Table Functions ..................................................................................... Comparison of two types of support for unknown file types...................................
340 341 343 349 374
WorkSite Server Administrator’s guide
About This Book The WorkSite Server Administrator’s Guide is the reference manual for WorkSite Server and WorkSite Server with Caching. It provides information on WorkSite Services and detailed information about the administrative tools and utilities that come with WorkSite Server.
Intended Audience This guide is recommended for the WorkSite Administrators who are experienced in setting up the WorkSite Server and its components. Contact Autonomy technical support to resolve issues that are not addressed in this guide.
Notation Conventions This manual uses the following notation conventions: Table 1
Notation Conventions
Convention
Definition and Usage
Bold
Text that appears in a GUI element such as, a menu item, button, or element of a dialog box, and command names are shown in bold. For example: Click Edit File in the Button Bar.
Italic
Book titles appear in italics. Terms are italicized the first time they are introduced. Important information may be italicized for emphasis.
Monospace
Commands, command-line output, and file names are in monospace type. For example: The iwextattr command-line tool allows you to set and look up extended attributes on a file.
WorkSite Server Administrator’s guide
• • • 19 • • •
About This Book
Table 1
Notation Conventions
Convention
Definition and Usage
Monospaced italic
Monospaced italics are used for command-line variables.For example: iwckrole role user
This means that you must replace role and user with your values. Monospaced bold
Monospaced bold represents information you enter in response to system prompts. The character that appears before a line of user input represents the command prompt, and should not be typed. For example: iwextattr -s project=proj1 //IWSERVER/default/main/dev/ WORKAREA/andre/products/index.html
Monospaced bold italic
Monospaced bold italic text is used to indicate a variable in user input. For example: iwextattr -s project=projectname workareavpath
means that you must insert the values of projectname and workareavpath when you enter this command. []
Square brackets surrounding a command-line argument mean that the argument is optional.
|
Vertical bars separating command-line arguments mean that only one of the arguments can be used.
This guide also uses the following conventions:
The term “Windows” indicates any supported version of the Microsoft Windows operating system, such as Windows® 2000.
Directory paths use UNIX conventions. These conventions mandate using forward slashes (/ ) in path names. (Windows systems use backward slashes.) The Windows convention is used when referring to a Windows-specific directory. For example: UNIX: docroot/news/front.html Windows: docroot\news\front.html
Manual Organization
• • • 20 • • •
“Introduction” on page 23
“Using the WorkSite Service Manager” on page 27
“Using the Database Administration Tool” on page 45
“Using the Document Import Tool” on page 159
“Using the Dialog Editor Tool” on page 181
WorkSite Server Administrator’s guide
Additional Product Documentation
“Using the Monitor Tool” on page 205
“Rules Engine” on page 253
“WorkSite Cluster Manager Service” on page 273
“WorkSite Server with Caching” on page 317
“Directory Service Synchronization Service” on page 287
“Tools and Utilities” on page 329
“Reading the WorkSite Server Log File” on page 343
“Database Schema” on page 349
“Server Configuration Options” on page 355
Additional Product Documentation Refer to the following guides for additional information:
DeskSite Installation and User's Guide or FileSite Installation and User's Guide. Provides more information on WorkSite client applications such as DeskSite, or FileSite.
WorkSite Installation Guide. Provides detailed, step-by-step instructions for installing the WorkSite Server and its components.
WorkSite Design Guide. Provides information on the design principals for the WorkSite Server.
WorkSite Resource Kit Administrator’s Guide. Provides instructions for using various WorkSite Server utilities that are not documented in this book.
Revision History Refer to Table 2 for a list of updates to this guide. Table 2
Revision History
Revision
Date
Comments
1
August 2007
8.2 SP1 Release.
WorkSite Server Administrator’s guide
• • • 21 • • •
About This Book
Table 2
Revision History
Revision
Date
Comments
2
December 2007
• Removed information about 8.2 Indexer. • Added a reference to the new schema entry for Symantec Enterprise Vault in Appendix B, “Database Schema.”.
3
September 2008
8.3 SP1 Release. Added updated information to “Directory Service Synchronization Service” on page 287.
4
April 2009
8.5 Release Added the following information • File dates and system dates in “Configuring WorkSite Server Service Properties” on page 34. • Preventing flat space filing in “Configuring WorkSite Server Service Properties” on page 34. • Server side email filing in “Server Side Email Filing” on page 375. • Allow folder creation in public workSpaces in “Allow Folder Creation in Public Workspaces” on page 375. • Search Results Sorting in “Search Results Sorting” on page 358. • Chapter 11 “Directory Service Synchronization Service” on page 287. • Support for unknown file types in “Support for Unknown File Types” on page 372.
Documentation Updates Additions and corrections to this document (when available) can be downloaded in PDF format from the following Web site: https://customers.autonomy.com.
• • • 22 • • •
WorkSite Server Administrator’s guide
Chapter 1
Introduction Components of the WorkSite Server The WorkSite Server is a 3-tiered architecture with components at each tier. The WorkSite Server forms the middle tier between the client and library tiers. Figure 1
Components of the WorkSite Server
The components of each tier may be distributed across several machines or may coexist on the same machine. See the WorkSite Design Guide for details on recommended installation. The tier levels can be broadly classified as WorkSite Library, WorkSite services, and client applications. The following sections describe the tiers and their components.
WorkSite Server Administrator’s guide
• • • 23 • • •
Chapter 1: Introduction
WorkSite Library From an end-user’s standpoint, a WorkSite Library is a repository for documents. From an Administrator’s standpoint, a WorkSite Library consists of two fundamental components:
One or more file servers, where the actual documents are stored.
An SQL database, which stores information about the documents.
WorkSite Server Services WorkSite Server has several fault-tolerant, multi-threaded services that function as the broker between WorkSite client applications and the WorkSite Library, or data layer WorkSite services include:
WorkSite Server—this core service connects to the SQL Server, the WorkSite Indexer, and the Document File Server. This service coordinates transactions with these back end systems and returns data to the client.
WorkSite Server with Caching (add-on service).
Rules Engine—processes system events, such as e-mail notification for certain system activities.
Cluster Manager—an optional service that performs automatic client redirection when a server in the cluster fails. The Cluster Manager Service also performs automatic load balancing across available WorkSite Servers.
WorkSite Communications Server—an optional service enabling e-mail messages from internal and external sources to be sent directly to WorkSite folders.
Directory Service Synchronization—an optional service enabling the WorkSite Server to perform repeated one-way synchronizations with hierarchical directory services, including LDAP and NDS.
These services interact through an interface known as the WorkSite Service Manager.
WorkSite Indexer The WorkSite Indexer is responsible for creating the indexes which allow users to search for WorkSite documents. The WorkSite Indexer also processes all search queries and returns the results to the WorkSite Server. For more information, refer to the WorkSite Indexer Administrator’s Guide. • • • 24 • • •
WorkSite Server Administrator’s guide
Components of the WorkSite Server
Client Applications In the WorkSite Server architecture, client applications do not make direct connections to components of the WorkSite Library, or data layer. The WorkSite Server service functions as a virtual firewall between your users and the data. The client applications that are commonly used are DeskSite, FileSite, WorkSite Web and E-mail Management for Lotus Notes. For more information, see the user guide for a particular product.
Administrative Tools or Utilities WorkSite Server includes a series of administrative tools that are used to manage, maintain, and administer the WorkSite Server, or DMS. This section contains a short description of each tool. See the appropriate chapters for more information on these tools.
WorkSite Service Manager—The WorkSite Service Manager is the main interface used configure and manages all services that are part of the WorkSite Server installation. See Chapter 2, “Using the WorkSite Service Manager,” for an introduction to using the Service Manager.
Database Administration—The WorkSite Database Administration (DBAdmin) tool is used to modify tables in the WorkSite Database. The DBAdmin tool has a two-tiered application that connects directly to the WorkSite Database. See Chapter 3, “Using the Database Administration Tool,” for an introduction to using DBAdmin.
Document Import—The WorkSite Import tool can import large numbers of documents into the WorkSite Database. This tool is most frequently used to migrate documents that were previously stored directly on a shared file server into the WorkSite Server. See Chapter 6, “Using the Document Import Tool.”
Dialog Editor—The Dialog Editor tool is used to edit the customizable dialog boxes and field names (captions) in the WorkSite Database. The Dialog Editor tool is three-tiered, so it connects to the WorkSite Server service rather than the database. See Chapter 7, “Using the Dialog Editor Tool.”
Monitor—The WorkSite Monitor tool is an administrative utility that is used to monitor activities on the WorkSite Server. WorkSite Monitor is a three-tiered application, so it connects to the WorkSite Server service rather than the database. See Chapter 8, “Using the Monitor Tool.”
WorkSite Server Administrator’s guide
• • • 25 • • •
Chapter 1: Introduction
• • • 26 • • •
WorkSite Server Administrator’s guide
Chapter 2
Using the WorkSite Service Manager Overview This chapter includes information on the following topics:
“About WorkSite Service Manager”
“WorkSite Services”
“Getting Started with WorkSite Service Manager”
“Registering and Unregistering Servers”
“Starting and Stopping a Service”
“Configuring WorkSite Server Service Properties”
“Configuring WorkSite Server Service Database Properties”
NOTE
The WorkSite Server Installation Guide provides the information required to install the WorkSite Server, and configure the services.
About WorkSite Service Manager WorkSite Service Manager is a required application for each service in the WorkSite Server. The WorkSite Service Manager manages all services that are part of the WorkSite Server installation. The WorkSite Service Manager is responsible for:
WorkSite Server Administrator’s guide
• • • 27 • • •
Chapter 2: Using the WorkSite Service Manager
Registering and Unregistering Servers. The computer on which the WorkSite Server has been installed must be registered in the WorkSite Service Manager before starting any service.
Starting and Stopping Individual Services. The WorkSite Service Manager starts and stops individual services and detects when a service terminates.
Configuring the Services. The WorkSite Service Manager allows you to configure the properties for each of the services that are installed.
Log File. The WorkSite Service Manager generates a log file that records all the actions or events connected to the services.
WorkSite Services The WorkSite Service Manager includes the following primary services:
WorkSite Server. See “Configuring WorkSite Server Service Properties” on page 34.
Rules Engine. For more information on the Rules Engine Service, see Chapter 9, “Configuring the Rules Engine,” of the WorkSite Server Administrator’s Guide.
Directory Service Synchronization. For more information on the Directory Servise Synchronization, see Chapter 11, “Directory Service Synchronization Service,” of the WorkSite Server Administrator’s Guide.
You can install the following additional services:
WorkSite Server with Caching (add-on service). For more information on the WorkSite Clustering Service, see Chapter 13, “WorkSite Server with Caching,” of the WorkSite Server Administrator’s Guide.
Cluster Manager (add-on service). For more information on the WorkSite Clustering Service, see Chapter 10, “WorkSite Cluster Manager Service,” of the WorkSite Server Administrator’s Guide.
WorkSite Communications Server (add-on service). See the WorkSite Communications Server for Exchange Administrator’s Guide for more information.
Getting Started with WorkSite Service Manager If you are using Windows 2008, then you can run WorkSite Service Manager only if you are a part of the Administrator's group on the local machine. • • • 28 • • •
WorkSite Server Administrator’s guide
Getting Started with WorkSite Service Manager
To start the WorkSite Service Manager: 1. Select Start, then point to All Programs. 2. Select Autonomy, then iManage Service Manager. When the WorkSite Service Manager is started for the first time, none of the services will be available until the server has been registered. In this context, server refers to the computer on which WorkSite Server has been installed. See “Registering and Unregistering Servers” on page 31. Figure 2
WorkSite Service Manager with Registered Servers
Understanding the Table View The main window in the WorkSite Service Manager displays information for each registered service.
The first column lists the Computer or Server name.
The second column lists the type of service that is installed.
The third column indicates whether the service is currently running.
Each row in the table has a colored bullet at the far left of the table. The bullet is yellow if the service listed in that row is stopped; the bullet is green if the service is running.
WorkSite Server Administrator’s guide
• • • 29 • • •
Chapter 2: Using the WorkSite Service Manager
Using the Toolbar The toolbar provides easy access to several menu options available in the WorkSite Service Manager. See the following sections for additional information on these options. Table 3 Button
Toolbar buttons and menu options Menu option
Keyboard Shortcut
Register Server
Ctrl-R
Used to create a connection between the WorkSite Service Manager and the services.
Find Servers
Ctrl-A
Used to find WorkSite Servers on the network.
Function
Startup Properties
–
Used to setup the startup properties for each service.
Service Properties
Ctrl-P
Used to configure the service properties for each service.
Database Setup
Ctrl-D
Used to connect databases to servers and to configure database properties.
File Server Setup
Ctrl+F
Used to configure connections between WorkSite Servers and Document File Servers.
Start Service
Ctrl-S
Used to start a service that is stopped.
Stop Service
Ctrl-T
Used to stop a service that is running.
Service About
Used to set the comments field for a service and to show version information.
View Log
Ctrl+V
Used to display the log file for the selected service in the WorkSite Log Viewer.
–
Topics
F1
Displays the contents of the WorkSite Server Manager Online Help.
–
About
–
Displays version information for the WorkSite Service Manager.
Finding WorkSite Servers The WorkSite Service Manager can automatically search the network for all servers that are running WorkSite services.
• • • 30 • • •
WorkSite Server Administrator’s guide
Registering and Unregistering Servers
To find all WorkSite Servers on the network: 1. Click Find icon in the toolbar, select Find Servers from the Service menu, or press Ctrl-A. When you select Find Servers, the WorkSite Servers Search status box is displayed. Figure 3
WorkSite Servers Search status box
This status box appears while the WorkSite Service Manager searches the network for WorkSite Server, Cluster Manager, and Rules Engine Servers. 2. To stop the search while this status box is displayed, click Cancel. All servers located by the WorkSite Service Manager are automatically registered with the service manager. See “Registering and Unregistering Servers” on page 31.
Registering and Unregistering Servers One of the first steps in setting up the WorkSite Server is to register the computer or server on which the WorkSite Server is installed. Registering a server with the WorkSite Server Manager enables you to configure and manage its WorkSite services.
Registering a WorkSite Server 1. Click the Register Server icon in the toolbar or select Register Server from the Service menu. The keyboard shortcut for Register Server is Ctrl+R. The Select Server dialog box is displayed.
WorkSite Server Administrator’s guide
• • • 31 • • •
Chapter 2: Using the WorkSite Service Manager
Figure 4
Select Server dialog box
2. In the Server box, enter the name of the computer where the WorkSite Server has been installed. 3. Click OK. If the WorkSite Service Manager connects to the WorkSite Server service successfully, the main table view lists each server. When you restart the WorkSite Service Manager, it automatically logs into any servers that were registered during your previous session. See “Automatic Login” on page 32.
Automatic Login When you register a server with the WorkSite Service Manager, an attempt to log into the server is made automatically each time you launch the WorkSite Service Manager until you unregister the server.
Unregistering a Server When the WorkSite Server Manager is started, it automatically tries to log into all of the servers that were registered with it when you last exited from the tool. To prevent the WorkSite Service Manager from automatically logging into a particular server, or to close the WorkSite Service Manager’s connection to a server, the Server must be unregistered. • • • 32 • • •
WorkSite Server Administrator’s guide
Starting and Stopping a Service
To unregister a server: 1. Select the server that must be unregistered from the table view. 2. Select Unregister Server from the Service menu. The connections to the services that are displayed in the table view will disappear.
Starting and Stopping a Service Each service listed in the main table view can be started or stopped from within the WorkSite Service Manager. Select the service, then click the
Start or
Stop icons in the toolbar.
Configure Startup Properties for the Service 1. Highlight the WorkSite Server Service in the main table view. 2. Click the button in the toolbar or select Startup Properties from the Service pull-down menu. The WorkSite Server Startup opens. Figure 5
WorkSite Server Administrator’s guide
WorkSite Server Startup Dialog
• • • 33 • • •
Chapter 2: Using the WorkSite Service Manager
3. Enter the Login ID and Password for the Windows User account under whose context the WorkSite Server Service program will run. This account must be different from the Windows service account Local System and must have “Log on as a service” privileges. The default value that appears in the Login ID field in the Startup dialog box is that of the current user. 4. Select the Startup Type: If you want the service program to start up automatically on boot, check Automatic. If you want the service program to start up only when launched manually from within the WorkSite Service Manager, then check Manual. 5. Click OK to register your changes.
Configuring WorkSite Server Service Properties To configure a WorkSite Server Service: 1. Highlight the WorkSite Server Service name in the table view. 2. Click the service properties button Service Properties.
in the toolbar or from the Properties menu, select
Change the appropriate the settings as desired in the WorkSite Server Properties dialog, then click OK. Table 4 lists all available options on the WorkSite Server Properties dialog.
• • • 34 • • •
WorkSite Server Administrator’s guide
Configuring WorkSite Server Service Properties
Figure 6
Table 4
WorkSite Server Properties Dialog
WorkSite Server Properties Dialog Options
Field/Feature
Description
Cluster/Server Name
The Cluster/Server Name field is used to specify the name of the cluster a WorkSite Server Service program is associated with. If the WorkSite Server Service is not part of a cluster, this field should be left blank. For more information on clustering, see the WorkSite Server Administrator’s Guide.
Cache Fileserver Path If your WorkSite deployment utilizes the WorkSite Server with Caching feature, enter the path to the fileserver that is used to cache files downloaded from remote locations. E-mail Domain
If you WorkSite deployment utilizes the WorkSite Communications Server, enter the name of the e-mail domain used by the WorkSite Communication Server. This is the domain name of the POP3 server.
WorkSite Server Administrator’s guide
• • • 35 • • •
Chapter 2: Using the WorkSite Service Manager
Table 4 Field/Feature
WorkSite Server Properties Dialog Options Description
Security Configuration
Accept Trusted Authentication
When the Accept Trusted Authentication feature is enabled, users who are already logged into the Windows domain can connect to WorkSite without providing a second, addtional login ID and password. The user must be a valid user on the database and the user’s database login ID must be identical to his or her login ID on the domain. Trusted authentication will not work if the user is not logged into the domain. Users such as virtual users who are not logged into the domain cannot use trusted authentication.
Enable Impersonation The Enable Impersonation feature allows anyone who knows the Enable Impersonation password to logon to the WorkSite system as any user whose login has not been disabled. The administrator uses the Administrative Impersonation password in place of the normal password of the user being impersonated. When enabled a password of at least six characters must be entered in the Password field. TCP/IP Port Configuration
Service Port and File Port
The values entered in the Service Port and File Port text-entry fields are dedicated TCP/IP port numbers assigned to the WorkSite Server Service program. The service port is used for service transactions, and the file port is used for transmitting files. Use the default value for the service port (1080) and file port (1081) unless instructed otherwise by Autonomy Technical Support.
Meta-Data Cache Configuration
Refresh Frequency
• • • 36 • • •
This value determines with what regularity the WorkSite Server will check that all database tables in memory contain less than the maximum number of rows and unload infrequently used entries from any tables that are larger than the maximum size. Use the default value of 1 unless instructed otherwise by Autonomy Technical Support.
WorkSite Server Administrator’s guide
Configuring WorkSite Server Service Properties
Table 4 Field/Feature
WorkSite Server Properties Dialog Options Description
Rows per Cache Table By specifying a value in the Rows per Cache Table field, you can limit the number of entries to cache in memory from each of database tables. If this value is set to 10, for instance, no more than 10,000 entries will be cached from any one table. When a database table contains more total entries than the maximum specified in the Rows per Cache Table field, then the WorkSite Server Service will identify infrequently used entries and remove them from the cache. The following tables are cached in memory for each database to which the WorkSite Server is connected: • User Table • Document Types • Custom1/Custom2 • Custom Tables • Class/Subclass • App Setup • Custom29/Custom30 Preload Cache Data
When the Preload Cache Data option is selected, the WorkSite Server will preload the database tables into the memory cache at startup. If this option is disabled, the database tables are loaded into the memory cache dynamically or incrementally (as needed). Turning off the Preload Cache Data feature will improve startup time.
Share Cache
If the WorkSite Server is connected to multiple databases, and those databases all have identical Custom1/Custom2 tables, then you may choose to load those tables into the memory cache on the WorkSite Server only once and allow all of the databases to share that same table in the cache. This feature is particularly beneficial when the WorkSite Server is connected to many WorkSite databases and the Custom1/Custom2 tables on each are very large. For this feature to work, all of the Custom1/Custom2 tables on the databases to which the WorkSite Server is connected must be identical. To turn this feature on, check the Shared Cache checkbox and enter the name of the preferred source database in the From Database field.
Enable Symantec Enterprise Vault Integration
If you have installed Symantec Enterprise Vault (SEV), you can integrate WorkSite with SEV by checking this option. Enter the DNS name or address of the Enterprise Vault Server in the Server Address field. Refer to Chapter 12, “Symantec Enterprise Vault Integration” for more information.
WorkSite Server Administrator’s guide
• • • 37 • • •
Chapter 2: Using the WorkSite Service Manager
Table 4
WorkSite Server Properties Dialog Options
Field/Feature
Description
Document Date Options
This option determines whether the created and modified dates on a file are set based on information in the file, or by WorkSite. • Use System Dates: When a file is imported into WorkSite, the "Created" property is populated with the date and time of when the file was imported to WorkSite. The "Modified" property is updated with the date and time when the file was last modified in WorkSite. This method ignores the original created and modified information of the file. Use System Dates is the default setting. • Use File Dates: This option saves both the original file dates (created and modified) as well as the dates and times of when the file was imported or modified in WorkSite. Note. Do not switch these settings back and forth.
Configuring WorkSite Server Service Database Properties Configure each WorkSite Server database belonging to this server. 1. From the WorkSite Service Manager tool, select the WorkSite Server service. 2. From the Properties menu, select Database Properties. The WorkSite Server Database Setup dialog opens. Figure 7
• • • 38 • • •
WorkSite Server Database Setup Dialog
WorkSite Server Administrator’s guide
Configuring WorkSite Server Service Database Properties
The Database Setup dialog box shows those databases that the WorkSite Server is currently serving. If you have not connected WorkSite Server Service to any databases yet, the list view in this dialog box is blank. 3. Click Add Database, or select an existing database from the list and click Modify. The Database Properties dialog opens. Figure 8
Database Properties Dialog
4. Enter the database name. You can select it from the list of available ODBC sources, by using the browse button. 5. Enter the Logon ID and Password for the entered or selected ODBC. 6. Select the Enable Cache Fileserver option if you are using WorkSite Server with Caching and want to enable Fileserver caching for this database. 7. In the How many connection section, choose one of the following options:
As Many Connections as Threads—this option configures the WorkSite Server to establish a 1:1 ratio of database connections The default ratio of threads running on the WorkSite Server to database connections is 1:1. You can customize this ratio to optimize performance on the system. When your WorkSite database is local and heavily used, the recommended ratio of threads to connection is 1:1. When the WorkSite Server is connecting to a remote database or to a database that is infrequently used, you may want to reduce the number of SQL database connections to reduce the number of connections that must be maintained over the WAN. You may also want to customize the number of database connections when the WorkSite Server is connecting to an infrequently used database, such as a read-only repository of old documents. When the ratio of threads to connections is not 1:1, the
WorkSite Server Administrator’s guide
• • • 39 • • •
Chapter 2: Using the WorkSite Service Manager
number of SQL connections available to the WorkSite Server are pooled and shared among the simultaneous threads running on the WorkSite Server.
Connection Count—Enter the number of SQL database connections that the WorkSite Server service should maintain to this database.
8. In the Designate database as section, select one of the following options:
Preferred Database—Select this option to designate this database as the source for dialog boxes, captions, and roles. Any database that is identified as a Preferred Database can serve as a source for dialog boxes, captions and roles. Each WorkSite Server must be connected to at least one database that is identified as a preferred database. You can specify alternate preferred databases for individual users using the Database Administration tool.
Web Content—select this option if the WorkSite Server is to be used as the database for the WorkSite web client. Select the Hidden option if you do not want to display the Web Content database.
9. Click Advanced to set the following options for this library. The Advanced Properties dialog box opens. Figure 9
Select Prevent flat space filing to force users to file content inside a workspace. When enabled, WorkSite clients will prevent any content from being filing outside a workspace.
In the Grace period to undeclare (hours) field, select one of the following grace period options. •
• • • 40 • • •
Advanced Properties dialog box
No grace period. This option does not provide a grace period to undeclare a declared document. Selecting it denotes that once a document is declared, it cannot be undeclared. This is the default option.
WorkSite Server Administrator’s guide
Configure Connections from WorkSite Server to File Servers
•
Infinite grace period. This option provides an unlimited period to undeclare a declared document. Selecting it denotes that a normal user can undeclare a declared document irrespective of when the document was declared.
•
Specify grace period (hours): Specify the time period within which a normal user can undeclare a declared document. This time period is calculated from when the document was declared. The value set here updates the Undeclare Record registry setting in the following key on the WorkSite Server:
HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\Databases\ \
In the Locale ID field, enter the numerical identifier for the language of the WorkSite database. WorkSite supports the storage of information in U.S. English plus one additional language. For WorkSite to support this additional language, you must enter the Locale ID of the second language here. The locale ID value must compliment the database collation setting. Refer to the WorkSite Design Guide for more information and for a complete list of Locale IDs. This list can also be found on the Microsoft web site. The default value is 1033 (U.S. English). Caution: The Locale ID setting must only be set for a new WorkSite database. Do not alter this setting for an existing (deployed) WorkSite database.
NOTE
For information about configuring the WorkSite Indexer portion of this dialog, refer to the WorkSite Indexer Administration Guide. 10. Click OK to add the database. The database is now added to the list seen in the WorkSite Server Database Setup dialog. 11. Click Close to save the settings.
Configure Connections from WorkSite Server to File Servers The File Server Connections dialog is used to enter login information for the accounts which will be used by the WorkSite Server Service to access the document file server(s). By default, the WorkSite Server uses the Windows account that was used to log in to access to the file server. To specify an alternative account to use.
WorkSite Server Administrator’s guide
• • • 41 • • •
Chapter 2: Using the WorkSite Service Manager
For Windows File Servers To configure connections between WorkSite Server and a Windows file server: 1. In the WorkSite Service Manager, select the WorkSite Server Service. 2. From the Properties menu, select File Server Setup or click the icon. The File Server Connections dialog opens.
File Server Setup
3. Click the Microsoft Windows Operating System tab. Figure 10 File Server Connections Dialog, Windows tab
4. Disable the Use Service Logon only option. 5. Enter a valid Windows domain Login ID and Password which has access to the file server. 6. Click OK. 7. Stop and restart the WorkSite Server service.
For NetWare File Servers To configure connections between WorkSite Server and a NetWare file server: 1. In the WorkSite Service Manager, select the WorkSite Server Service. 2. From the Properties menu, select File Server Setup or click the icon. The File Server Connections dialog opens.
• • • 42 • • •
File Server Setup
WorkSite Server Administrator’s guide
Troubleshooting Startup Errors
Figure 11 File Server Connections Dialog, NetWare Tab
3. Select either a Bindery or NDS connection. 4. Enter the LoginID and Password for the Novell NetWare User Account created for the WorkSite Server. 5. If you selected NDS, then you must also enter a Context. 6. Click OK. 7. Stop and restart the WorkSite Server service.
Troubleshooting Startup Errors Problem: If you attempt to start a service and receive the error message shown in Figure 12 (possibly followed by other error messages), then the Login ID and Password provided in the service’s Startup dialog may be incorrect for this service. Figure 12 Configuration Error Message
WorkSite Server Administrator’s guide
• • • 43 • • •
Chapter 2: Using the WorkSite Service Manager
Solution: Reconfigure the startup properties for that service in the appropriate Startup dialog, then try to start the service again. NOTE
You may receive a positive confirmation message after you configure the startup properties for a service, but still receive this error message if the login and password provided are not correct.
Version Information and Comments You can check version information for any service program listed in the main program view by selecting the service name and then selecting Service About from the Properties pulldown menu. Or, you can also click the Service About button in the toolbar. When you select Service About, a dialog will be displayed for the service with a field for entering or editing the comments field that is displayed in the main program view. Figure 13 About WorkSite Service Manager Dialog
You can use the About dialog to edit or enter comment information or to view version information for the selected service.
• • • 44 • • •
WorkSite Server Administrator’s guide
Chapter 3
Using the Database Administration Tool Overview This chapter includes information on the following topics:
“About Database Administration”
“Starting and Stopping the DBAdmin”
“DBAdmin Desktop”
“Registering WorkSite Databases”
“Configuring WorkSite Database Options”
“Common Functions”
“Error Messages”
About Database Administration The Database Administration (DBAdmin) tool is part of the WorkSite Administrative tools group and is used to perform the following typical database management functions:
Defining user login or access privileges
Initializing and registering databases with WorkSite
Adding or editing document types and applications
Editing the list of PC nodes
WorkSite Server Administrator’s guide
• • • 45 • • •
Chapter 3: Using the Database Administration Tool
Creating new document classifications to identify and differentiate documents in your database
Starting and Stopping the DBAdmin Access the DBAdmin tool from the WorkSite Server installation directory. To start the DBAdmin: 1. Select Start and point to All Programs. 2. Select Autonomy, then iManage Database Administration. Register the Database to start using the tool. See “Registering WorkSite Databases” on page 51. To stop the DBAdmin: 1. Unregister the database from the DBAdmin. 2. From the File menu, select Exit.
DBAdmin Desktop The main program window in the DBAdmin tool resembles the layout of Windows Explorer. On the left is a tree frame that displays a list of databases and information tables in hierarchical form. On the right is a table frame, where the contents of each of the information tables are displayed.
Tree Frame The tree frame lists only those databases that are currently registered. Multiple databases can be listed in the tree frame at the same time. If a database is not listed in the tree frame, you need to register the database with WorkSite. To display the list of information tables for a database, click the plus sign next to the Database icon. To collapse a branch of the tree frame, click the icon’s minus sign. All the icons seen below the database in the tree frame are the information tables available to each database. See “Information Tables and Subtables” on page 49.
• • • 46 • • •
WorkSite Server Administrator’s guide
DBAdmin Desktop
Figure 14 DBAdmin Main Program Window
Table Frame The contents of an information table are displayed in the table frame in the right pane of the main program window. To display the contents of an information table in the table frame, click an icon in the tree frame. To edit an entry in the table frame, double-click the item in the table or press Enter. The rows in the table frame are commonly identified as Items, Entries or Records. Use the Tab key to shift focus between the tree frame and the table frame. While the cursor is in the tree frame, you can use the arrow keys to move up and down the tree.
WorkSite Server Administrator’s guide
• • • 47 • • •
Chapter 3: Using the Database Administration Tool
Searching the Table Frame You can search among the entries currently displayed in the table frame for a specified string. Press Ctrl-F or select Find from the Edit menu to display the Find dialog box. To find the next occurrence of the same search string among the entries in the table frame, press F3 or select Find Next. See “Searching in a Table or List View” on page 61.
Right-click Menus There are two right-click menus available in the main program window.
In the tree frame, select and right-click a database to display the Database menu.
In the table frame, select and right-click an item to display the Edit and Manage menus.
Figure 15 Right-click menu for the table frame
NOTE
Custom2 and Custom30 are subclasses that are dependent on Custom1 and Custom29 respectively. The subclasses appear only when the appropriate parent class is displayed in the table frame.
• • • 48 • • •
WorkSite Server Administrator’s guide
DBAdmin Desktop
Toolbar The toolbar provides quick access to frequently needed functions. The toolbar can be hidden or redisplayed by selecting Toolbar from the View menu. The position and configuration of the toolbar on your desktop is entirely customizable. To move the toolbar to a new location, click the edge of the toolbar and drag it to that location. The shape of the toolbar can be customized by clicking and dragging on the edge of the toolbar to reshape it. Figure 16 Floating toolbar
Information Tables and Subtables Each WorkSite database has a series of information tables associated with it. These information tables are created when the database is first initialized using the DBAdmin tool. These information tables contain data relating to:
Users, Groups and Roles
Document types
Document classifications
Software applications
PC locations
Preferred databases
File servers
Table 5 lists each of the information tables seen in the tree frame and its importance to the database. Detailed information about each information table is provided in the corresponding sections of this chapter. Table 5 Information Table
Information Tables in the tree frame
Description
This information table lists users who have been granted access to the database. Users can be of six types, depending on how they access the database: Novell Bindery users, Novell NDS users, NT users, LDAP users, external users, and virtual users. Virtual users are DOS users or users who access the database over the internet. See “Managing Users” on page 65.
WorkSite Server Administrator’s guide
• • • 49 • • •
Chapter 3: Using the Database Administration Tool
Table 5 Information Table
Information Tables in the tree frame
Description
This information table lists groups of users who have been defined for the purpose of granting them access collectively to documents. When a group is granted access rights to a document, all users who are defined as part of that group are granted the same access privileges. See “Managing Groups” on page 84. This information table lists generic security profiles that you can assign to users. These profiles grant customizable levels of access to document management functions. Typical roles include database librarian, administrator, user, guest, group supervisor, and project supervisor. See “Roles” on page 107. This information table lists the document types that enable WorkSite to link up a document with its native application. Document types are normally based on the application used to create the document. A Microsoft Word document and a WordPerfect document may be in the same class of documents, but they would have different document types indicative of the application in which they were created. See “Managing Document Types” on page 131. This information table lists the document classes defined for a database. Document classes are custom categories used to differentiate documents. Typical classes of documents include legal briefs, original site plans, letters, memos, proposals, or transmittals. Document classes can be further subdivided into subclasses. Document classes and subclasses determine the default security setting for documents. See “Managing Document Class and Subclass” on page 139. This information table includes information essential to integrate WorkSite DMS with other applications. This table also identifies the principal application for each document type. See “Defining Application Formats” on page 125. This information table maps PC Node Addresses to descriptive information that will help identify a PC’s actual location. This information is useful for locating documents that are in use or checked-out. See “Managing PC Locations” on page 144. The Custom1 table is a custom category, typically a Client. It is also used to differentiate documents in your database. Each Custom1 category can be subdivided into Custom2 classifications. Custom2 is typically customized as Matter. They are used to identify the specific case (or project) to which all the documents relate. See “Managing Custom Tables and Subtables” on page 147. to
The Custom3 to Custom12 tables are lookup tables for the Custom3 to Custom12 profile fields. These profile fields provide you with the opportunity to create new custom categories to identify and differentiate documents in your database. Custom categories may include Department, Account, Region, Country, Language, Organization, Division, Coauthor, and Project. See “Managing Custom Tables and Subtables” on page 147. The Custom29 table, like the Custom1 table, presents an additional opportunity to differentiate documents in your database. The Custom29 table can also be further subdivided into custom Custom30 classifications. See “Managing Custom Tables and Subtables” on page 147.
• • • 50 • • •
WorkSite Server Administrator’s guide
Registering WorkSite Databases
Table 5 Information Table
Information Tables in the tree frame
Description
This information table is a list of WorkSite databases that can be assigned to users as their preferred database. See “Preferred Databases” on page 100. The Doc File Servers table is a list of the document file servers associated with this database that can be assigned to users. See “File Server” on page 103. This information table lists the templates of security settings that operate globally and can be assigned to particular authors. When a new document is created for an author who has been assigned a security template, those security settings will be applied to the document by default. See “Security Templates” on page 118. NOTE
Table 5 lists the default captions for the information tables. You can change the captions using the Dialog Editor administrative tool.
Registering WorkSite Databases DBAdmin tool allows the WorkSite administrator to register, and to connect to the database, created using SQL Enterprise Manager. When the database is registered for the first time, it allows the administrator to create WorkSite related tables or schema in it. This section discusses registering and unregistering databases, automatic login, and creating WorkSite tables or schema. (Creating tables or schema is part of the database initialization procedure.) When you run the DBAdmin tool for the first time, you must register the databases before you can access any of the information tables. To register the database: 1. From the Database menu, select Register/Unregister to open the Register/Unregister Databases dialog.
WorkSite Server Administrator’s guide
• • • 51 • • •
Chapter 3: Using the Database Administration Tool
Figure 17 Register/Unregister Databases Dialog
The UnRegistered Database column lists databases that have not been logged into but have already been defined as ODBC data sources. Table 6 contains database icons and their descriptions. Table 6 Icon
Database icon color Description
Green icons indicate registered databases to which you are currently logged in. Yellow icons indicate unregistered databases. Red icons indicate that the DBAdmin tool attempted to log into the database on startup, but the database did not respond in time and the automatic login feature timed out. 2. Select the database to be registered from the UnRegistered Databases list and click Register. The Logon to Database dialog opens. 3. Enter the Login ID and Password, and click Login. If the database was already initialized as a WorkSite database, the database name is displayed in the Registered Databases column and an icon for the database appears in the tree frame of the main program window.
• • • 52 • • •
WorkSite Server Administrator’s guide
Configuring WorkSite Database Options
If you are registering the database for the first time or if the database has not been initialized as a WorkSite database, you are prompted to create the database. Click OK. Refer to the WorkSite Server Installation Guide for information about the steps to initialize this database. NOTE
Follow the same procedure to Unregister the database using the DBAdmin tool. Select the database and click .
Roles WorkSite Server implements a dynamic security model called Roles. Roles allow administrators to distribute access to document management functions selectively across an organization. Users are each assigned a generic security profile, called a role, which controls the kinds of document management activities that the user can perform. NOTE
Roles do not affect a user’s access to documents. Access rights are determined by default security settings and access control lists. The kinds of document management activities that users can perform and that are controlled by their security profile or role are
Importing documents
Editing documents
Viewing public documents
WorkSite Server Administrator’s guide
• • • 107 • • •
Chapter 4: Administering Users, Groups, and Security
Table 9 illustrates how roles can be used to control access to document management tasks. System administrators can assign the same security profile to one or more users. Table 9
Document management tasks associated with roles
Role
Example User
Create New Docs
Edit Docs
Archive Read-only Docs Access
Legal User
Typist
Granted
Granted
Legal Power Corporate User Attorney
Granted
Granted
Accounting Power
Accounting Secretary
Granted
Granted
Temp
Temp in Accounting
Granted
Granted
DB Librarian Archivist
Granted
Granted Granted
Office Manager
Office Manager
Granted
Granted
Sys Admin
Sys Admin
Granted
Granted
Create New Users
Delete Documents
Granted
Granted Granted
Granted
Granted
Granted
Roles and Document Profile Information For each role that you create, you also define two templates of document profile information. One template is applied to all new documents created by users who are assigned that role. The other template controls the profile information that users can use as search criteria when performing WorkSite searches. These two profile templates are powerful yet flexible tools for controlling user’s access to documents and their operations on documents, folders, and workspaces. For example, the value of a document profile field can be used to control access to the database. An administrator has created a custom profile field called DEPARTMENT that contains values of LEGAL, ACCOUNTING, BUSINESS, and OTHER. In the roles created for the database, the administrator has created limitations on what users can enter in this field of profile information when creating new documents and performing searches. By controlling this profile field, the administrator has control over user access to documents. Table 10 illustrates how an Office Manager can never create a search that will include the Tax Attorney’s documents, and the Tax Attorney can never create a search that will include the
• • • 108 • • •
WorkSite Server Administrator’s guide
Roles
Office Manager’s documents. They can share documents by creating public folders or sharing saved searches. Table 10 Using Roles to Manage Document Searches User
Role
Tax attorney Legal User
New Docs Labeled
Legal
Accounting
Business
Other
Legal
Granted Granted Search Access Search Access
Corporate Attorney
Legal Power Legal User
Granted Granted Search Access Search Access
Accounting Secretary
Accounting Accounting User
Granted Search Access
Office Manager
Office Manager
Granted Granted Search Access Search Access
Accountant
Accounting Accounting Power User
Granted Granted Search Access Search Access
Sys Admin
Sys Admin
Granted Granted Granted Search Access Search Access Search Access
Business
Other
Examples of Roles You can create various types of roles to assign to users and groups. Table 11 Examples of Roles Role for...
Enables ability to...
Disables ability to...
Temporary Employees
Create new documents
• • • • • •
Typical Users
Essential WorkSite Server activities
• Delete documents • Release documents
Supervisors
Delete and release others’ documents Note: Supervisors must also be a member of the NRTADMIN group to have this privilege.
WorkSite Server Administrator’s guide
Checkout documents Delete documents Search for public documents Create public folders Perform public searches Perform full-text searches
• • • 109 • • •
Chapter 4: Administering Users, Groups, and Security
Creating Roles Roles consist of two items:
Security profile
Membership list
All users listed in the membership for a role receive the privileges (or limitations) associated with that role. You can edit the membership for a single role from the same dialog used to create the security profile for that role, while the Role Management dialog is available for managing the membership of multiple roles at once.
Default role When a WorkSite database is first created, a default role is added to the table of existing roles. Users who are not assigned a specific role in the database are granted the privileges that are assigned to the default role. You cannot edit the membership of the default role. You can, however, change the privileges assigned to the default role. You can assure that a user is assigned the default role by removing the user from the membership of all other roles that are defined. NOTE
Roles cannot be deleted, however they can be disabled by removing all members or by clearing all task privileges.
Adding a Role to the Database To add a role to the database: 1. Select the
Roles icon in the tree frame of the DBAdmin main program window.
The available roles are displayed in the table frame. 2. Click the
Add icon in the toolbar or select Add from the Manage menu.
The Role Setup dialog box is displayed.
• • • 110 • • •
WorkSite Server Administrator’s guide
Roles
Figure 54 Role Setup Dialog, Privileges Tab
3. In the Role field, enter a name for the role. 4. In the Description field, enter a description or additional information about this role. 5. Select the External Role option if you want to create a role for external users. 6. Select the privileges you would like to grant users who will be assigned this role. The Privileges tab contains information organized into four broad columns:
Content Operations. Permission to work with documents.
Folder Operations. Permission to work with folders, tabs, and workspaces.
Administrative Operations. Permission to work with system workspaces.
Web Operations. Permission to perform operations online.
Select or clear the check boxes in the columns to indicate permission to perform activities for the users assigned to that role. See Table 12.
WorkSite Server Administrator’s guide
• • • 111 • • •
Chapter 4: Administering Users, Groups, and Security
7. Create a custom document profile and search profile for the role using the Edit/Create Profile tab and the Search Profile tab. To prepopulate or disable fields in the New Document Profile and Document Search dialog boxes, see “Edit/Create Profile and Search Profile Tabs” on page 113. 8. Click the Membership Assignment tab to assign the new role to users. See “Assigning Roles to Users” on page 115. 9. Click OK to add the role to the database. Table 12 Options on the Privileges Tab If this check box is selected...
The person with this role can…
Content Operations Import/Create
Import documents into the database. If this permission is not selected, the user cannot add events, tasks, or discussion topics (WorkSite Web)
Checkout Documents
Check in and check out documents in the database to which the user has access
Unlock Documents
Unlock documents checked-out or in use by the user
Delete
Permanently remove content from the database to which the user has access
Allow Full-Text Searches
Perform full-text searches
Read Only
User has strictly read-only access to documents. User can still create or check in new documents.
Folder Operations Create Public Folder
Create a new public project folder. User can still create Private folders or subfolders with security inherited from the parent folder.
Create Public Searches
Save public searches and mark them as public
Administrative Operations Use WorkSite Import
When checked, user can use the bulk Document Import tool. NRTADMIN group has this permission by default.
Use WorkSite Monitor
When checked, user can use the WorkSite Monitor to track database transactions. NRTADMIN group has this permission by default.
Use WorkSite Administration
When checked, users in INTERNAL_ADMIN, INTERNAL_USERADMIN, EXTERNAL_ADMIN, and EXTERNAL_USERADMIN groups in WorkSite Web can manage users, groups and roles. NRTADMIN group has this permission by default.
Web Operations (These privileges are specific to users accessing the database through the WorkSite Web product.) • • • 112 • • •
WorkSite Server Administrator’s guide
Roles
Table 12 Options on the Privileges Tab If this check box is selected...
The person with this role can…
Search Via Web
Perform searches
Create WorkSpaces
Create new workspaces
Create Public WorkSpaces
Create shared workspaces
Create System WorkSpaces
Create system workspaces, such as templates and profiles that reside on the Webdb
Delete WorkSpaces
Delete workspaces
Setting Restrictions for Profile Information From the Role Setup dialog you can set restrictions for document profile fields. This information appears in the Search, New Profile, and Profile Edit and View dialogs for users assigned to this role. Use the Search Profile tab to set role restrictions for the Search dialog in client applications. Use Edit/Create Profile tab to set restrictions for the New Profile and Profile Edit and View windows in WorkSite. Figure 55 shows the Edit/Create Profile tab on the Role Setup dialog.
Edit/Create Profile and Search Profile Tabs The Edit/Create Profile and Search Profile windows display the following information columns:
Profile IDs. Identifies the field of document profile information that is being referenced.
Default Values. The Default value(s) for the corresponding profile field.
Access Rights. Indicates whether the user who is assigned this role can change the default value applied to the corresponding profile field. Access Rights can be read-only (“R”) or read-write (“W”) in the Search Profile tab and the Edit/Create Profile tab. With read-write access, the user can override the default value.
To customize the document or document search profile: 1. From the Role Setup dialog, click the Edit/Create Profile tab or the Search Profile tab.
WorkSite Server Administrator’s guide
• • • 113 • • •
Chapter 4: Administering Users, Groups, and Security
Figure 55 Role Setup Dialog, Edit/Create Profile Tab
2. Select a Profile ID and click Edit. In Figure 55, the Matter profile field is selected, and the Edit Matter dialog is shown. 3. Enter values in the Edit dialog.
• • • 114 • • •
In the Default Value field, enter a default value for this field of information. This field will be prepopulated with the default value when the user opens the New Document Profile, New Version Profile, or Document Search dialog box. When a default value is assigned to a profile field, the user is assigned read-only access. The user cannot change the value of the profile property. When multiple default values are specified for a profile field, then these are the only valid values available to the user.
Set the Access Rights on the profile field. If you want users to be able to change the value of this profile field, select read-write access. If you do not want users to be able to change the value of this profile field, select read-only.
WorkSite Server Administrator’s guide
Roles
NOTE
All values entered in the Edit/Create Profile tab are read-only. Values can be set to read-write in the Search Profile tab only. 4. Click OK. The new values are displayed under Profile Access Information on the tab. “R” in the Access Rights column indicates that users have read-only rights on the field. “W” indicates users have read-write access.
Assigning Roles to Users You can assign roles to users:
When you first define the role
When you are editing the access privileges associated with a role
In the Role Setup dialog Membership Assignment tab, you can add or remove users associated with a specific role. This dialog can be used to edit the membership for only one role at a time. To edit the membership for multiple roles at once, select Role Management from the Manage menu.
Editing Membership for a Single Role 1. Select the
Roles icon in the tree frame of the DBAdmin main program window.
The available roles are displayed in the table frame. 2. Double-click the name of the role whose membership you want to edit. The Role Setup dialog box is displayed. 3. Click the Membership Assignment tab. The list of users who are already assigned to the role is listed in the Users column. The users who are not assigned a role in the database are listed in the Available Users column.
WorkSite Server Administrator’s guide
• • • 115 • • •
Chapter 4: Administering Users, Groups, and Security
Figure 56 Role Setup dialog box, Membership Assignment tab
4. To assign the role to a user, select the user’s name in the Users column and click >. NOTE
As a shortcut, you can double-click a user’s name to move it from one column to the other. You can also move multiple users at once by selecting the users’ names and clicking the Add or Remove buttons. 6. Click OK. NOTE
When the default role is being edited in the Role Setup dialog box, the Membership Assignment tab is not displayed. You cannot explicitly edit the membership for the default role. Users who are not assigned to any other roles receive the privileges assigned to the default role.
• • • 116 • • •
WorkSite Server Administrator’s guide
Roles
Editing Membership for Multiple Roles You can edit membership for multiple roles at once from the Role Management dialog box. 1. From the Manage menu, select Role Management. The Role Management dialog opens. Figure 57 Role Management Dialog
2. Highlight the name of the role in the Roles column. 3. To assign the role to a user, select a name in the Available Users, and then click Add. The username displays in the Users column. 4. To remove a user from a role, select a name in the Users column, and click Remove. The username is displayed in the Available Users column. 5. Click OK. NOTES
Membership for the default role cannot be edited. Users who are not explicitly assigned to a role inherit the privileges set for the default role. Only external users can be assigned to an External role. They cannot be assigned to other roles that are not external.
WorkSite Server Administrator’s guide
• • • 117 • • •
Chapter 4: Administering Users, Groups, and Security
Security Templates Security templates operate similarly to the preferred database and file server assignments. The Security Templates information table is a list of predefined security settings that can be assigned to a particular user. The security settings of the template assigned to a user are applied by default to all the documents for which that user is the author.
Creating a Security Template To create a security template: 1. Start DBAdmin. From the Windows Start menu, point to All Programs, then Autonomy, and then select iManage Database Administration. 2. Select the
Security Templates icon in the tree frame.
The available security templates are displayed in the table frame. 3. Right-click in the table frame and select Add. You can also select Add from the Manage menu. The Add Security Templates dialog box is displayed.
• • • 118 • • •
WorkSite Server Administrator’s guide
Security Templates
Figure 58 Add Security Templates Dialog
4. Enter the name and description in the Security Template Name and Description fields. 5. Select the level of default security from the Default Security list. The options available are Private, Public or View. 6. Select a level of security from the Security Type list. The options available are Read/Write, Read, Full Access, and No Access. 7. Select the user or group from the Available Users/Groups list. NOTE
Use the User Filter button to filter the users based on specifics in the Select User dialog box. 8. Click < Add to add the user or group to that security template. 9. Click OK.
WorkSite Server Administrator’s guide
• • • 119 • • •
Chapter 4: Administering Users, Groups, and Security
NOTE
To remove the user(s) from the security template, select the user(s) from the Security Information column and double-click or click Remove>>.
Assigning Users to an Existing Security Template 1. Select the
Security Templates icon in the tree frame.
The available security templates are displayed in the table frame. 2. Right-click in the table frame. Select Security Template Management from the menu. You can also select Security Template Management from the Manage menu. The Security Template Assignment dialog box is displayed. Figure 59 Security Template Assignment Dialog
3. Select the template from the Security Template column. 4. Select the users from the Available Users column. 5. Click > to add the Cluster Manager to the list of installed services. The Cluster Manager Startup dialog box is displayed. Figure 141 Cluster Manager Startup dialog box
• • • 282 • • •
WorkSite Server Administrator’s guide
Configuring WorkSite Server Service
5. Enter the Login ID and Password for the WorkSite Server administrative domain account. This account must have service privileges. The default value that appears in the Login ID field in the Startup dialog is that of the current user. 6. Select the Startup Type If you want the Cluster Manager service program to startup automatically on boot, select Automatic. Autonomy recommends that this option be selected. If you want the service program to start up only when launched manually from within the WorkSite Service Manager, then select Manual. 7. Click OK to register your changes. A status box indicates that the account entered in the Service Startup dialog box was granted login privileges to the service.
Configuring WorkSite Server Service You must configure the Database Properties and Service Properties for the WorkSite Server Service.
Service Properties Configure each WorkSite Server service belonging to the cluster. 1. From the WorkSite Service Manager tool, select the WorkSite Server service then select Service Properties from the Properties menu. The WorkSite Server Service Properties dialog box is displayed. 2. Enter the cluster name in the Cluster Name field.
WorkSite Server Administrator’s guide
• • • 283 • • •
Chapter 10: WorkSite Cluster Manager Service
Figure 142 WorkSite Server Service Properties dialog box
NOTE
If you have not registered all the servers in one instance of the WorkSite Service Manager, you have to configure each of your WorkSite Servers. 3. To log into a server within the cluster from a client application, specify the cluster name (for example, CLDMS) instead of a literal server name or IP Address.
• • • 284 • • •
WorkSite Server Administrator’s guide
Configuring WorkSite Server Service
Database Properties Configure each WorkSite Server service belonging to this cluster. 1. From the WorkSite Service Manager tool, select the WorkSite Server service then select Database Properties from the Properties menu. The WorkSite Server Database Setup dialog box is displayed. 2. Enter the cluster name in the Cluster Name field. Figure 143 WorkSite Server Database Setup dialog box
3. Click Add Database. The Database Properties dialog box is displayed. Figure 144 Database Properties dialog box
WorkSite Server Administrator’s guide
• • • 285 • • •
Chapter 10: WorkSite Cluster Manager Service
4. Enter the database name. You can select it from the list of available ODBC sources, by using the browse button. 5. Enter the Logon ID and Password for the entered or selected ODBC. 6. Click OK to add the database. The database is now added to the list seen in the WorkSite Server Database Setup dialog box. 7. Click Close to save the settings.
WorkSite Server Cluster Example In this example, there are three WorkSite Servers running on your network (NYDMS1, NYDMS2, and NYDMS3) that you want to configure as a cluster. They service the same databases (DB1, DB2, DB3). 1. Install the WorkSite Cluster Manager service on each of the WorkSite servers that should be part of the cluster (for example, NYDMS1, NYDMS2, and NYDMS3). 2. Select a name for your WorkSite Server Cluster. This example uses NYDMS. 3. Define an entity on your Domain Name Service (DNS) named NYDMS that points to the IP Addresses for the machines that you want to be part of your cluster. This example uses the IP Addresses of NYDMS1, NYDMS2, and NYDMS3. 4. From the WorkSite Service Manager tool, configure the Service Properties and the Database properties for each WorkSite Server service in the cluster. For this example, configure the WorkSite Server service on NYDMS1, NYDMS2, and NYDMS3. Include the Cluster name NYDMS in the Service Properties and add the databases from the available ODBCs in Database Properties. NOTE
All the WorkSite Servers in the cluster must be connected to the same set of databases. You must create an ODBC connection for every database that is connected to the WorkSite Servers in the cluster. Create the connection for each WorkSite Server. 5. Register the databases in DBAdmin tool. 6. After changing the cluster name, stop and restart each WorkSite Server service.
• • • 286 • • •
WorkSite Server Administrator’s guide
Chapter 11
Directory Service Synchronization Service Overview This chapter includes information on the following topics:
“How Directory Service Synchronization Service Works”
“Installing DSS Service”
“Configuring the DSS Service”
“Mapping Directory Service Attributes to WorkSite”
“Running the DSS Service”
The Directory Service Synchronization (DSS) service enables the WorkSite Server to perform repeated one-way synchronizations with hierarchical directory services, including Microsoft Active Directory or other LDAP server. The service can perform continuous or scheduled imports of users and groups that are added to directories on remote domains. Using the Directory Service Synchronization service saves administrators time by automatically updating user information on WorkSite when changes are made on the directory service. The Directory Service Synchronization service is configured using the WorkSite Service Manager. The service currently supports synchronization with the following directory services:
Microsoft Active Directory (ADS)
Sun ONE Directory Services
Novell NDS
Windows NT
WorkSite Server Administrator’s guide
• • • 287 • • •
Chapter 11: Directory Service Synchronization Service
How Directory Service Synchronization Service Works The DSS service runs as a separate service on the WorkSite Server. You can synchronize the directory of an entire organization, or you can designate a specific organizational unit as the root container, for example, a city or department, and import all users under that container to a WorkSite library. The synchronization process has two parts.
The first process compares all the users and groups on the directory service with those on the WorkSite library. New users are added to the WorkSite library and profile information is updated for existing users, if necessary.
The second process determines whether each user and group on the WorkSite library exists on the directory service. Users that have been removed from the directory on the remote domain are disabled in WorkSite.
Synchronization is one-way only. If user or group accounts are added or modified on the WorkSite database, the changes are not recorded on the external Directory Service. The key to performing synchronization is having a unique identifier for each user and group imported from the directory service. The K1SyncID is stored on both the WorkSite library and the external directory service, enabling exact matching on directory objects even when those objects are modified. (For example, an employee changes department or name.) The value of the K1SynchID of a user or group cannot be modified. If it is changed on the directory service, the synchronization process logs an error, and the user and group accounts are not updated on the WorkSite library. The DSS service can be set to run continuously or on a schedule. In either case, the basic program flow consists of a basic interval repeated continuously or as time remains in the scheduled period. If the WorkSite Server is connected to more than one directory service, only one connection is serviced during an interval. During the next interval, the next connection is serviced, and so on. NOTE
WorkSite Server does not support nested groups. When nested groups are imported from Active Directory, the members of the nested group are added to the parent group.
Requirements The DSS service requires administrative privileges on the machine where it is installed and permission to log on as a service.
• • • 288 • • •
WorkSite Server Administrator’s guide
Installing DSS Service
Installing DSS Service The DSS Service is an optional service which is included with the WorkSite Server. After completing the WorkSite Server installation, the WorkSite Service Add/Remove dialog opens, as shown in Figure 145: Figure 145 WorkSite Service Add/Remove
1. Select the Directory Synchronization Service in the left column and click Add to move it to the Installed column. The Directory Synchronization Service Startup dialog opens, as shown in Figure 146.
WorkSite Server Administrator’s guide
• • • 289 • • •
Chapter 11: Directory Service Synchronization Service
Figure 146 Directory Synchronization Service Startup Dialog
2. In the Logon section, enter a Username (Logon ID) and Password for the Windows User Account that will be used to run this service. 3. In the Startup Type section, select one of the following options to determine how the service will be started:
Automatic—the service starts automatically on system boot/reboot.
Manual—the service must be started manually using the WorkSite Service Manager tool.
4. Click OK. A dialog opens with an informational message: Granted “Service logon privilege” to account. 5. Click OK to return to the WorkSite Service Add/Remove dialog. 6. Click Exit. NOTE
WorkSite services can be uninstalled or reinstalled later by running the imSvrIns.exe program located by default at C:\Program Files\Autonomy\WorkSite\Server\.
• • • 290 • • •
WorkSite Server Administrator’s guide
Configuring the DSS Service
Configuring the DSS Service Before starting the DSS Service, you must perform the following configuration steps:
Set the synchronization schedule
Create connections to the directory service server
Map the Directory Service attributes to WorkSite user/group properties
Setting the DSS Schedule Establishing a schedule for the DSS Service determines when the service will update the user and group information in WorkSite. To set the DS synchronization schedule: 1. Start WorkSite Service Manager. 2. From the Windows Start menu, click All Programs, then Autonomy, then click iManage Service Manager. 3. Select the Directory Synchronization Service from the list of available services. 4. From the Properties menu, select Service Properties. The DS Synchronization Schedule Properties dialog opens.
WorkSite Server Administrator’s guide
• • • 291 • • •
Chapter 11: Directory Service Synchronization Service
Figure 147 DS Synchronization Schedule Properties Dialog
5. Select Schedule or Continuous.
If you select Schedule, the DSS service runs only during the periods you specify. Select the time of day (in 2-hour intervals) and the days of the week when you want the synchronization to occur.
If you select Continuous, the service continuously compares and updates the WorkSite libraries with user and group information from the external directory service. The default interval is 10 minutes.
6. Click OK.
Creating Connections to DSS Services From the WorkSite Service Manager, you can establish connections to one or more DSS services on remote servers/domains.
• • • 292 • • •
WorkSite Server Administrator’s guide
Configuring the DSS Service
To create a connection to a directory service: 1. In WorkSite Service Manager, select the Directory Synchronization Service from the list of available services. 2. From the Properties menu, select Databases Setup to open the Directory Service Connections dialog. Figure 148 Directory Service Connections Dialog
This following options are available:
Add. Define a new connection to a directory service.
Copy. Create a copy of an existing connection.
Edit. Modify the properties of an existing connection.
Delete. Delete a connection.
Clear. Delete all connections.
3. Click Add to open the DS Synchronization Connection Properties dialog.
WorkSite Server Administrator’s guide
• • • 293 • • •
Chapter 11: Directory Service Synchronization Service
Figure 149 DS Synchronization Connection Properties Dialog
4. Enter a name for the connection. This name appears in the Directory Service Connections dialog (see Figure 148). 5. Under Directory Service, enter the following information:
• • • 294 • • •
Server Type – Select the type of directory service to which you are connecting.
TCP/IP Port – Enter the TCP/IP port number of the server/domain hosting the directory service.
Context (for Novell NDS only) – Enter the location of an object in the Directory tree. NDS objects are identified by their relative location in the Directory tree.
Server – Enter the name of the server hosting the directory service.
Service Logon and Other (Specify) – Select Service Logon to log on as the service account for the DSS service. Select Other to enter the User Name and Password.
WorkSite Server Administrator’s guide
Configuring the DSS Service
User ID – Enter the FQDN, UPN, or Domain\User ID of a user with access to the directory service using one of the following forms: Fully Qualified Distinguished Name, for example:CN=Tim Jones, OU=AMER, OU=Domain Users, DC=Autonomy, DC=COM User Principal Name (UPN) format or e-mail address, for example:
[email protected]. Domain\UserID, for example: autonomy\tjones. Note: Administrative-level access is required for Sun ONE and Novell NDS in order to update those directories with the K1SyncId value. Read-only access is sufficient for ADS. Be sure that the ADS user has sufficient access to read from the nodes they choose. Note: For Windows NT, the user account must have, on the machine where the DS Synchronization Service is running, “Act as part of the operating system” and “Log on locally” as part of the machine’s Local Security Policy. These permissions are granted automatically when you click Test Login, if they have not already been granted.
Password – Enter the password of the administrative user you entered in the User ID field.
6. Under Attribute Maps, select a map from the Defined Maps list or create a map. To create an attribute map, click Add. See “Mapping Directory Service Attributes to WorkSite” on page 298. 7. Click Test Login. A confirmation message is returned if the login is successful. 8. In the Root Container DN field, define the directory container that should be imported. All groups and users within (and below) this container will be imported. If you are connecting to an LDAP type service (for example, ADS), the Root Container DN field is populated automatically after successfully connecting to the directory service, showing the top-level container. Click Browse to specify an alternate container (see Figure 150).
WorkSite Server Administrator’s guide
• • • 295 • • •
Chapter 11: Directory Service Synchronization Service
Figure 150 DS Synchronization Root Context Dialog
9. If any of the users or groups should be designated as external users in WorkSite, you can specify the specific objects (OUs, groups, users) in the External DNs portion of this dialog. Refer to “Specifying External Users and Groups” for step-by-step instructions. 10. Under WorkSite Server, enter the following information:
• • • 296 • • •
Server Name – The name of the WorkSite Server.
Database – The name of the WorkSite library to which the users/groups will be imported. Each WorkSite library must have a synchronization connection configured separately. This enables you to import only those users and groups which need access to that library.
Service Logon and Other (Specify) – Select Service Logon to log in as the service account for the DSS service. Select Other to enter the User Name and Password.
User Name – Enter the username of a user who has administrative privileges on the WorkSite Server (part of the NRTADMIN group).
Password – Enter the password for this administrative user.
TCP/IP Port – Select Default or specify a port by entering a port number in the text box.
WorkSite Server Administrator’s guide
Configuring the DSS Service
11. Under User Defaults, enter the following information:
Password – Enter a default password to be assigned to users when imported to WorkSite from the directory service.
Confirm Password – Confirm the default password.
Select User Must Change Password at Next Logon or Password Never Expires as needed.
12. Click OK. The connection appears in the Directory Service Connections dialog (see Figure 148).
Specifying External Users and Groups User and groups defined in WorkSite as external are automatically assigned to the DEFAULT_EXTERNAL role. These users have limited privileges. DSS enables you to specify specific groups or OUs as external when synchronized with a directory service. This functionality is only available when importing directory information from Microsoft Active Directory. For other directory service types, you must mark the users or groups as external after they have been imported to WorkSite. Take extra care when selecting OUs or groups to be imported as external users. Depending on how the OU or group is organized, it may contain groups or users from other containers in the directory. To specify a directory service container as external: 1. In the DS Synchronization Connection Properties dialog (see Figure 149), enter the distinguished name of the domain, organization, group, etc. that is to be defined as external. All users defined within (and below) this container will be marked as external users in WorkSite. a. You can use the Browse button below the Root Container DN field in order to navigate to the appropriate container, then select the distinguished name string at the bottom of the dialog in the Selected DN field. Click CTRL+C to copy the string. b. Click OK to close the context dialog, then double-click the first line in the External DNs box. Now you can paste the distinguished name string that you copied in step a. Tips for using the External DNs field:
You can only enter one DN per line.
You must double-click the line in order to enter, modify, or delete the DN string.
WorkSite Server Administrator’s guide
• • • 297 • • •
Chapter 11: Directory Service Synchronization Service
If a user or group should no longer be marked external in the library, you must deselect the “external” option individually for each user or group using DBAdmin. DSS will not update this setting, even if you modify the DS Synchronization Connection Properties.
Mapping Directory Service Attributes to WorkSite Importing users and groups from a directory service requires that the properties containing user or group information in the directory service be mapped to comparable user or group profile properties in WorkSite. Additionally, the K1SyncID property must exist on both the directory service and the WorkSite database. WorkSite provides default maps for Microsoft ADS and Sun ONE directory services. To map Directory Service attributes to WorkSite: 1. Click Add under Attribute Map on the DS Synchronization Connection Properties dialog (see Figure 149). The DS Synchronization Attribute Map dialog opens, as shown. Figure 151 DS Synchronization Attribute Map Dialog
2. Enter a name for the attribute map in the Map Name field, for example, Novell. 3. To select a predefined map for Microsoft ADS or Sun ONE directory services, click the ADS Defaults or Sun ONE Defaults button. This action populates the form with default values. 4. To create a new attribute map, select a field from the list to serve as the K1SyncID.
• • • 298 • • •
WorkSite Server Administrator’s guide
Running the DSS Service
5. Under Group, select Directory Service group attributes from the lists that correspond to the following WorkSite fields:
Group ID
Name
Members
6. Under Organizational Unit, select a Directory Service attribute from the list that corresponds to the WorkSite Name field. 7. Under User, select Directory Service user attributes from the lists that correspond to the following WorkSite fields:
User ID
Name
Location
Telephone
Fax
E-mail
8. Click OK. The new map appears in the list of Defined Maps on the DS Synchronization Connection Properties dialog (see Figure 149).
Running the DSS Service To launch the synchronization process, the DSS service must be enabled in the WorkSite Service Manager. NOTE
Whenever you change any DSS service settings, you must stop and restart the service in the WorkSite Service Manager. 1. Open the WorkSite Service Manager.
WorkSite Server Administrator’s guide
• • • 299 • • •
Chapter 11: Directory Service Synchronization Service
Figure 152 WorkSite Service Manager
2. Select DSS service. 3. Click the
• • • 300 • • •
Start icon from the toolbar.
WorkSite Server Administrator’s guide
Chapter 12
Symantec Enterprise Vault Integration About Symantec Enterprise Vault Symantec Enterprise Vault (SEV) from Symantec Corporation and is one of the most widely used email archiving solutions. Using intelligent classification and archiving solutions, Enterprise Vault is able to improve a company's ability to protect corporate information. It also helps reduce storage requirements for emails and other data and provides added security. Enterprise Vault integrates with Microsoft Exchange 2000 Server, Exchange Server 5.5, and Exchange Server 2003 and 2007 environments. After SEV is integrated with Outlook, vaulted emails are replaced by stubs; a stub includes the message header and the first few kilobytes of text from the email. When you open the stub, Outlook automatically connects to SEV and downloads the entire email. For information on installing and configuring SEV, refer to the user documentation provided with the product or contact Symantec Corporation, http://www.symantec.com.
SEV Integration for WorkSite Server SEV integration for WorkSite Server is currently available for Microsoft Exchange only. When e-mail stubs from Outlook are imported to WorkSite, they are placed on the WorkSite file-server, just like any other files that are imported. A back-end process continuously scans for newly imported emails. All new emails are analyzed and when SEV stubs are detected, the back-end process retrieves the fully realized e-mail from SEV and replaces the email stub on the file-server with the fully realized e-mail.
WorkSite Server Administrator’s guide
• • • 301 • • •
Chapter 12: Symantec Enterprise Vault Integration
The SEV integration will restore e-mail stubs that have been imported into WorkSite to fully realized emails as long as the e-mail content still exists within SEV. The integration will adhere to the business rules of the existing e-mail management and the records management functionality in WorkSite. If e-mails are declared as records on import, WorkSite will only allow reconciliation of the e-mail with SEV and will deny any attempt to modify the record. Also, if an e-mail stub in Worksite that has not been restored to a fully realized e-mail is accessed, WorkSite will rely on the SEV client to display the email to the user. When emails are imported from Outlook into WorkSite, the following rules apply.
If an email is imported into WorkSite from Outlook using a move command, the reference to that email is removed from that inbox.
If the email is imported into WorkSite from Outlook using a copy command, the reference to that email remains within that inbox and is continued to be served by SEV.
NOTE
None of these actions impact the actual content in SEV. Content in SEV is still referable using the SEV shortcut until the content is removed from SEV by its configured records management rules.
Supported Versions and Packaging This integration supports.
WorkSite 8.3 using database schema version 8.3 and later.
SEV 6.0, 7.0 and 2007.
NOTE
The Microsoft Exchange version is dependant on the version of SEV and WorkSite.
Upgrading the Database Schema You must upgrade the database schema to version 8.3 or later before integrating SEV with WorkSite 8.3. Upgrade the database schema after upgrading the WorkSite Server software. For information, see WorkSite Server and WorkSite Server with Caching Release Notes 8.3.
• • • 302 • • •
WorkSite Server Administrator’s guide
Upgrading the Database Schema
WorkSite Server 8.3 includes a database upgrading utility (DbUpgrade.exe). It is a command line utility that upgrades your database schema. You can find this utility in the WorkSite Server installation directory. When you run the upgrade utility, it adds a column to your database. For more information, see “EMAIL_ATTRS Table and Status Codes” on page 313. To verify if the schema upgrade proceeds correctly, test the DbUpgrade utility on a backup copy of your SQL database in a development environment. After completing a successful upgrade in a development environment, you can upgrade your production environment. NOTE
The DbUpgrade utility may fail if it encounters constraint violations in the database. Contact Autonomy Technical Support for additional information.
Test the DbUpgrade Utility on a Database Copy Before you upgrade the database on your production environment, you should test the upgrade on a copy of your database. Use these instructions to complete this test. 1. Stop all WorkSite services that are connected to the database(s) that you want to upgrade. 2. Back up your SQL databases and verify that the backup files are restorable. NOTE
Autonomy is not responsible for loss of data caused by the failure to backup your databases. 3. Create a new test SQL database. Restore the backup of your production database to this database. Run the upgrade against this test copy of your production database, before running it in your production environment. 4. Install WorkSite Server 8.3 on the test server machine. (The installation directory contains the executable for the DbUpgrade utility.) For more information, see the WorkSite Server and WorkSite Server with Caching Release Notes 8.3. 5. Run DbUpgrade.exe against the restored test copy of your database. See “Using the DbUpgrade Utility” on page 304. Complete one of the following tasks based on the outcome of the upgrade test.
Errors Reported: Review the DbUpgrade.log file located in WorkSite Server installation directory, and resolve the errors as necessary. Contact Autonomy Technical Support for assistance with errors that you are unable to resolve.
No Errors Reported: Proceed with the upgrade. Run DbUpgrade utility against the production database.
WorkSite Server Administrator’s guide
• • • 303 • • •
Chapter 12: Symantec Enterprise Vault Integration
NOTE
Do not run DbUpgrade utility against your production database until you verify that there are no errors when you run it against the test database.
Using the DbUpgrade Utility Use the following instructions to run the database upgrade utility, and upgrade the databases that connect to the WorkSite Server 8.3. 1. Locate the installation directory for the WorkSite Server. (This directory contains the executable (dbUpgrade.exe) for the utility. 2. Start the command prompt in this directory. 3. To run the DbUpgrade utility, use the following format to enter the ODBC Data Source Name (DSN), SQL login account, and password as parameters on the command line: > DBUPGRADE.EXE -DSN [data_source_name] -USR [username] -PSWD [password]
For example, you would enter the following information if the ODBC Data Source Name for your SQL Database is NEWYORK, the SQL login account is SA, and the Password is Barney27: > DBUPGRADE.EXE -DSN NEWYORK -USR SA -PSWD Barney27
4. Confirm that the command prompt displayed a message indicating that the upgrade was successful. You can also view the DbUpgrade.log file to confirm the upgrade. This file is located in the same directory as the DbUpgrade utility. Contact Autonomy Technical Support if you find errors in this log file that you have been unable to resolve.
Installing Vault Admin Console The Vault Admin Console (VAC) must be installed on each WorkSite Server node that integrates with SEV. The Vault Admin Console is a standard part of the Symantec Enterprise Vault server installation package and will provide all of the components necessary for the WorkSite Server to access the Symantec Enterprise Vault server to reconcile e-mail stubs. The version of the Vault Admin Console installed on the WorkSite Server should match the version of the production Symantec Enterprise Vault server. For example, Vault Admin Console 6 should not be used on the WorkSite Server at sites running Symantec Enterprise Vault 7.
• • • 304 • • •
WorkSite Server Administrator’s guide
Installing Microsoft Exchange Server MAPI Client and CDO
For more information about the Vault Admin Console, contact Symantec Corporation.
Installing Microsoft Exchange Server MAPI Client and CDO The WorkSite Server with SEV Integration requires the Microsoft Exchange Server MAPI Client and Collaboration Data Objects (CDO) in order to connect to Exchange and examine e-mail contents to determine if the e-mail is an SEV stub. Download and install the MAPI Client and CDO installer, ExchangeMapiCdo.EXE, from the Microsoft website, http://www.microsoft.com.
User Account Information SEV authentication and authorization is accomplished using trusted login. Therefore, the Windows account used to run the WorkSite Server must be a local administrator and an Active Directory domain account that has administrator access to SEV. The WorkSite Server also needs a WorkSite account in order to perform DMS transactions like replacing the email and logging audit entries. This DMS user account should be a member of the NRTADMIN group and the user id should be added to the Windows Registry. For more information, see “Adding User Account to Windows Registry” on page 305 NOTE
If user account does not have administrator access to SEV, the SEV API will return ‘Internal Failure’ error messages when the DMS attempts to download email messages from the Vault.
Adding User Account to Windows Registry Use the instructions in the following section to add the WorkSite NT user account information to the registry.
WorkSite Server Administrator’s guide
• • • 305 • • •
Chapter 12: Symantec Enterprise Vault Integration
CAUTION
Modifying the registry improperly can cause serious problems with the operating system. Be sure to make a backup of the registry and exercise caution when modifying the registry. Autonomy is not responsible for loss of data due to improper use of the Registry Editor or failure to backup the registry. 1. Go to Start > Run and enter Regedit, or type regedit at the C: prompt. The Registry Editor appears. Figure 153 Registry Editor
2. Locate the hive, imDmsSvc, in the following path: HKEY_LOCAL_MACHINE\ SOFTWARE\Interwoven\WorkSite\imDmsSvc. Click imDmsSvc. The right pane shows the String Values associated with imDmsSvc. See Figure 154. Figure 154 imDmsSvc
3. In the right pane, scroll down to locate the String Value, Reconcile UserId.
• • • 306 • • •
WorkSite Server Administrator’s guide
Adding User Account to Windows Registry
Figure 155 Reconcile UserId
4. Double-click the Reconcile UserId String Value. The Edit String dialog box appears. Figure 156 Edit String Dialog
5. Enter the WorkSite NT user account information in the Value data text box. 6. Click OK. The WorkSite NT user account gets updated in the registry.
WorkSite Server Administrator’s guide
• • • 307 • • •
Chapter 12: Symantec Enterprise Vault Integration
Integrating Symantec Enterprise Vault with WorkSite Server To enable SEV integration with Worksite. 1. From the Windows Start menu, point to All Programs, then Autonomy, then click iManage Service Manager. The WorkSite Service Manager opens. See Figure 157. Figure 157 WorkSite Service Manager
2. If the WorkSite Server Service is running, select the Service and click the Stop button in the toolbar. Alternatively, you can click Stop Service from the Service drop-down menu or type Ctrl-T. See Figure 158.
• • • 308 • • •
WorkSite Server Administrator’s guide
Integrating Symantec Enterprise Vault with WorkSite Server
Figure 158 Stop Service
3. Once the WorkSite Server Service has stopped, click the Service Properties button in the toolbar. Alternatively, you can select Service Properties from the Properties drop-down menu or type Ctrl-P. See Figure 159.
WorkSite Server Administrator’s guide
• • • 309 • • •
Chapter 12: Symantec Enterprise Vault Integration
Figure 159 Service Properties
The WorkSite Server Properties dialog box appears. See Figure 160.
• • • 310 • • •
WorkSite Server Administrator’s guide
Integrating Symantec Enterprise Vault with WorkSite Server
Figure 160 WorkSite Server Properties Dialog
4. Select the Enable Symantec(tm) Enterprise Vault Integration check box to enable SEV. See Figure 161.
WorkSite Server Administrator’s guide
• • • 311 • • •
Chapter 12: Symantec Enterprise Vault Integration
Figure 161 Enable Symantec(tm) Enterprise Vault Integration
5. Insert the DNS name or address of the SEV Server in the Server Address text box. 6. Click OK. 7. Restart the WorkSite Server Service by clicking the Start button in the toolbar. Alternatively, you can click Start Service from the Service drop-down menu or type Ctrl-S. See Figure 162.
• • • 312 • • •
WorkSite Server Administrator’s guide
Understanding DMS Log File Information
Figure 162 Start Service
Understanding DMS Log File Information Status codes and errors related to SEV integration with WorkSite can be found in the DMS log file. They are explained in detail in the following section.
EMAIL_ATTRS Table and Status Codes All emails that are scanned and processed by WorkSite NT are recorded in the EMAIL_ATTRS table with a status code. This table can be found in the DMS log file. Any email without a record or with a “P” status in the EMAIL_ATTRS table is a candidate for the next scan. The status codes are as follows.
“E” indicates that the email has been reconciled, in either of the following two ways.
WorkSite Server Administrator’s guide
• • • 313 • • •
Chapter 12: Symantec Enterprise Vault Integration
It was sourced from SEV and the stub was replaced with the fully realized email.
It was sourced from Exchange and no changes were made.
“P” indicates that the reconciliation encountered an error while processing the email and increased its retry count. When the retry count equals the maximum value in the DMS registry key, ReconciliationRetry (found in the Windows registry), it will no longer be selected as a candidate email.
“X” indicates that the email has failed reconciliation the maximum number of times and will no longer be a candidate for reconciliation. For more information, see the explanation for status code “S”.
“S” indicates that the email, sourced from SEV, has failed reconciliation the maximum number of times and will no longer be a candidate for reconciliation but will remain an SEV stub message file.
“U” indicates that the WorkSite Server cannot determine whether the origin of the e-mail was from Exchange or from Enterprise Vault. This can happen because of corrupted or non-existent file or because the origin is from other e-mail servers, like Lotus Notes.
Fatal and Non-Fatal SEV Errors Fatal SEV errors occur when SEV is offline, does not respond or denies permission to download a file. In these cases, the Email Reconciliation subsystem goes into a sleep state, giving the system administrator a chance to correct the issue. Non-fatal errors are those in which a requested item cannot be found in the Vault but the Vault is still operational and online. In this case, reconciliation proceeds as normal. NOTE
Email Reconciliation subsystem is the background process running in the WorkSite Server that manages the connection to SEV and resolves SEV shortcuts.
Heartbeat Statistics The Email Reconciliation subsystem will write a status message to the DMS log file just before going into a sleep state: QPT=0 QPS=0 QPE=0 QFR=0 QFX=0, TPT=0 TPS=0 TPE=0 TFR=0 TFX=0
• • • 314 • • •
WorkSite Server Administrator’s guide
Understanding DMS Log File Information
The “Quantum” records (QPT, QPS, QPE, QFR, QFX) are the delta for the last cycle and the “Total” records (TPT, TPS, TPE, TFR, TFX) are the total since the Email Reconciliation subsystem was started. Table 40 shows the records with their expansion. Table 40 Abbreviations used in the DMS log file Abbreviation
Expansion
QPT
Quantum Processed Total
QPS
Quantum Processed sourced from SEV (reconciled successfully, marked “E”)
QPE
Quantum Processed sourced from Exchange (marked “E”)
QFR
Quantum Failed, in Retry phase
QFX
Quantum Failed, marked as X (or S if sourced from SEV)
TPT
Total Processed Total
TPS
Total Processed sourced from SEV (reconciled successfully, marked “E”)
TPE
Total Processed sourced from Exchange (marked “E”)
TFR
Total Failed, in Retry phase
TFX
Total Failed, marked as X (or S if sourced from SEV)
WorkSite Server Administrator’s guide
• • • 315 • • •
Chapter 12: Symantec Enterprise Vault Integration
• • • 316 • • •
WorkSite Server Administrator’s guide
Chapter 13
WorkSite Server with Caching Overview This chapter includes information on the following topics:
“About WorkSite Server with Caching”
“Caching Server Technology”
“Cache Fileserver”
“Overview of Proxying Capabilities”
About WorkSite Server with Caching WorkSite Server with Caching is an optional feature of WorkSite Server. This chapter contains instructions for how to configure the WorkSite Server with Caching. File caching is useful in multi-office systems where documents are frequently accessed over a WAN. The File Servers used for caching should have the same specifications as the network file servers. The WorkSite Server with Caching is a key enabling technology that allows firms to seamlessly transition from the traditional office centric approach of organizing and consuming content, to a global approach where content is more readily accessible and organized around a firm’s business needs. While there are several benefits of caching from both the business and IT perspective, this section addresses following topics for the WorkSite administrators:
Developing a deeper understanding of our caching server technologies.
Understanding the infrastructure requirements for a successful caching server deployment.
Surfacing the issues and dependencies involved when planning a successful caching server rollout.
Understanding the new proxying capabilities
WorkSite Server Administrator’s guide
• • • 317 • • •
Chapter 13: WorkSite Server with Caching
Caching Server Technology The WorkSite Server with Caching is a specialized WorkSite Server application that has the ability to maintain and serve documents from a local cache. (This is a folder configured as the cache server.) The caching server does not maintain or store any document meta-data or full-text indexing information. Users connect to the local caching server with any client application and work just as they would if connected to a regular (non-caching) WorkSite Server. For example, a user sends a request to open a document. The caching server first checks its local cache to see if an up-to-date copy of the file exists. If so, the file is served to the client application from the cache. This process is faster than retrieving it across the WAN. The SQL database is also updated to mark the document as checked-out. If the document does not exist in the local cache, or if the local cached copy is older than the central copy of the document, the caching server will automatically download the latest copy from the central location and refresh the cache. A similar sequence of events takes place when checking in the document. The caching server accepts the document from the client application and copies it to the local cache. The client application is then released, and the user can completed related tasks. The caching server copies the document to the central location. It updates the SQL information to mark it as checked-in, updates history, and so on. The overall time for the check-in is shortened, because the document is uploaded to the cache when the user closes it. The user does not have to wait for the document to be uploaded to the central location. This operation is handled asynchronously by the caching server. The issues discussed in this section apply to file caching only. The caching server does not cache any information about the document stored in the SQL database, such as profile information. For example, client-matter meta-data, security rights and so on. Caching only applies when transferring files, but not when performing document searches, profile updates and so on. NOTE
This type of caching differs from the meta-data caching and “shared cache” capabilities that are also part of the WorkSite Server. In addition, WorkSite proxy capabilities enhance performance for the caching server. This proxy capability reduces the number of SQL transactions from the caching server to the remote SQL Database.
• • • 318 • • •
WorkSite Server Administrator’s guide
Cache Fileserver
Cache Fileserver A caching server is essentially a regular WorkSite DMS server with additional configuration options that allow it to perform caching functions. When deployed as a cache server, it acts as an “appliance” in the remote office. The caching server can be configured to cache content from multiple centralized databases. It maintains SQL ODBC connections to each database, and it connects to the central file server. Each database maintains a list of all caching servers currently connected and all documents currently maintained in each server’s cache. NOTE
The cache fileserver should have the same specifications as your system fileserver: SCSI, RAID configured drive capable of handling the amount of content for the number of documents to be placed into the cache plus 20%. When a user makes a document request, such as, a checkout, the caching server queries the appropriate database to see if: 1. The document currently exists in the local cache. 2. The document in the cache is up-to-date. If both conditions are true, then the caching server returns the local copy from the cache folder and marks the document as checked-out. If either condition is false, the caching server connects directly to the central file server, checks out the document, and streams it to the client machine while retaining a copy of the document in the cache. The database is also updated to reflect that the cache contains an up-to-date copy. When the document is checked in, the caching server accepts the document from the client application. It releases the client so that the user can continue working. (This happens very quickly, regardless of document size.) The caching server then checks the document back in, which physically updates the document on the central server and updates the SQL database accordingly. The caching server maintains a queue of all the documents to be uploaded. It wakes up at one-minute intervals, and uploads all the documents in the queue to the central file server. (It does not upload a document to the centralized file server immediately after receiving it from the client.) If the upload time extends the one-minute boundary, the cache server does not go to sleep but continuously uploads documents until the queue is empty. Configuring the caching server consists of three steps:
Determine which repositories to be cached
Specify the local path or folder on the WorkSite Caching Server where cached documents are stored
WorkSite Server Administrator’s guide
• • • 319 • • •
Chapter 13: WorkSite Server with Caching
For WorkSite Server with caching 8.0 SP1 (With proxying capabilities) and above, specify the WorkSite Server at the central location where the transactions will be proxied.
Example A firm that has regional data centers in New York and Chicago. It is common for attorneys in New York to work on documents for matters based in Chicago, and vice versa. The New York DMS server needs to “see” the Chicago databases in order to access that content. Consequently, it might make sense to configure the New York DMS server to cache the Chicago content locally. (This minimizes the delays due to uploads or downloads of files across the slower WAN.) The New York DMS acts as a local DMS for local New York content, and as a caching server for remote content in Chicago. (The New York DMS does not cache the files of the New York database, since these files are readily accessible on the fast LAN.) The Chicago site can be configured the same way, providing both locations with quick, seamless access to content regardless of its physical location. Additional considerations includes the number and location of smaller offices around the regional data centers, the quality of network connections, the work patterns of users, average document size, and others.
Preloading the Cache An attorney based in Chicago travels to New York to work on a case. Many of the documents that the attorney has been working on reside in the Chicago repository. The New York cache could be pre-loaded with all the documents for that particular matter prior to the attorney’s arrival. The attorney can begin working on documents without having to wait for each document to be streamed to the current machine from the file server in Chicago via the caching server in New York. A process could be setup to refresh the cache on a regular basis, ensuring that any documents needed by the attorney are always up-to-date in the cache. When the attorney leaves New York, the cache could then be purged to remove those documents, and free up space on the caching file store. Pre-populating the cache is also performed when a remote office is rolling out for the first time. The caching server API can be used to pre-populate the documents that these users frequently access so this content is readily available. NOTE
See IManCacheableContent in the COM Object for WorkSite Developer's Reference Guide.
• • • 320 • • •
WorkSite Server Administrator’s guide
Cache Fileserver
Configuring the WorkSite Server for File Caching You must configure your WorkSite Server to use the file caching option. Perform this procedure on the WorkSite Server at each site. To configure your WorkSite DMS server: 1. Open the WorkSite Server Service Manager. Highlight the WorkSite Server service. Select Service Properties from the Properties menu. The WorkSite Server Properties dialog box opens. Figure 163 WorkSite Server Properties dialog box
2. Enter the path to the Cache Fileserver in the Cache Fileserver Path text box. You can use the browse button to navigate to the Cache Fileserver and select it.
At Site 1, the centralized site where the databases reside, the Cache Fileserver for Database 1 will be a path to the Cache Fileserver at Site 2.
At Site 2, the Cache Fileserver for Database 2 will be a path to the Cache Fileserver at Site 1. See the examples in “Cache Fileserver” on page 319.
WorkSite Server Administrator’s guide
• • • 321 • • •
Chapter 13: WorkSite Server with Caching
NOTE
A server that does not belong to a cluster must have a unique fileserver cache. All servers belonging to a specific cluster must have an identical fileserver cache. 3. To complete the other fields in the WorkSite Service Properties dialog box, see the WorkSite Server Implementation Guide. These fields are all related to Meta-Data caching and not to File caching. 4. Click OK to save your settings. 5. Set up your databases to enable caching files. Select Databases Setup from the Properties menu. Select the name of the library you want to enable and click Modify. The WorkSite Server Database Properties dialog box is displayed. Figure 164 WorkSite Server Database Properties dialog box
6. Select the Enable Cache Fileserver check box. 7. Click OK to save your settings and close the dialog box. 8. Click Close. NOTE
Enable caching only for databases with remote fileservers, that is, fileservers that are located across the WAN from the WorkSite Server.
• • • 322 • • •
WorkSite Server Administrator’s guide
Overview of Proxying Capabilities
Purging the Cache Fileserver You can purge the Cache Fileserver of files that have not been accessed since a specified date and time, so that the cache does not become overloaded. You should do this on a regular basis. The Cache Purge tool also deletes documents from the cache which have been previously deleted from the remote library. The Cache Purge tool is a command line executable program performed on the WorkSite Server. To perform a cache purge: 1. On the Cache Fileserver, choose Run from the Start menu, and type cmd to open the command window. 2. Enter the cache purge information using the following syntax: C:\> imCachePurge.exe [-info] -dsn -usr -pswd -dtm
For example: C:\> imCachePurge.exe -dsn Colorado -usr sa -pswd mhdocs -dtm "06/18/2003 18:59:00"
3. Type Enter. The utility removes documents in the cache file server for the library you named that are older than the date you selected. 4. Repeat for each library (Data Source Name) connected to that Cache Fileserver.
Overview of Proxying Capabilities When a client initiates a request in a traditional WAN environment, the transaction requests are handed over the WAN, and sent to the centralized or remote SQL database. The centralized or remote SQL database extracts the requested documents from the File Server, and returns request over WAN to the WorkSite Server with Caching. This is a time consuming task since each transaction normally consists of sub components to move to and fro over the WAN network. A client request can result in multiple transactions across the WAN, which slows down performance in a traditional WAN system. Figure 166 illustrates the traditional way of handling requests.
WorkSite Server Administrator’s guide
• • • 323 • • •
Chapter 13: WorkSite Server with Caching
Figure 165 Traditional WAN Environment
Currently, WorkSite Server with Caching works to enhance performance over a WAN in a distributed environment. It utilizes "proxy" architecture to minimize SQL transactions over the WAN. When a client initiates a request, the transaction requests are sent directly from a local WorkSite Server to the remote WorkSite Server. The remote WorkSite Server "proxies" the requests to the SQL database locally and returns the response to the requesting WorkSite Server. Figure 166 WorkSite Server with Proxying Capabilities
The proxying capabilities minimize the number of SQL roundtrips over the WAN. The WorkSite Advanced Server allows a client request to a remote library to go from the local DMS to the • • • 324 • • •
WorkSite Server Administrator’s guide
Overview of Proxying Capabilities
remote DMS. The remote DMS handles the multiple server transactions locally, and responds to the client request in a much shorter time. Rather than relying on the caching server to communicate directly with the centralized SQL server, a partial server-to-server proxy mechanism is implemented for transactions that generated several roundtrips over the WAN. For transactions that require several roundtrips over the WAN, the caching server can make a single call to the central WorkSite Server. The central WorkSite Server performs all the individual SQL transactions locally on the LAN in the central data center, where latency is not an issue. It then reports the status of the completed transaction to the caching server. Only one atomic transaction takes place between the caching server and the data center. NOTES
This capability is referred to as a “partial” proxy mechanism since only proxied core transactions result in several round trips over the WAN. The caching server maintains an ODBC connection to the SQL server for transactions such as authentication, to the file server for file upload or download, and so on. It is not possible to turn on file caching for a database, but to turn off the proxying capabilities. With WorkSite Server with Caching 8.0 sp1 and above, the proxy capabilities are an integral part of the caching functionality and cannot be disabled.
WorkSite Server with Caching refers to the proxying capability as well. Proxying is an integral part of the caching technology.
Setting up Library Connections When you are configuring the WorkSite Advanced Server in the WorkSite Service Manager, you must set up communication to the proxy server and to each database. To configure library connection properties: 1. On the WorkSite Server in the remote location, open the WorkSite Service Manager, and select Databases Setup on the Properties menu. See Figure 166.
WorkSite Server Administrator’s guide
• • • 325 • • •
Chapter 13: WorkSite Server with Caching
Figure 167 WorkSite Server Database Setup dialog box
2. Click Add Server to open the Server Connection Properties dialog box. You can add a server connection across the WAN. Figure 168 Server Connection Properties dialog box
3. Enter the name of the Proxy server in the Cluster/Server Name field. 4. Enter the Logon ID and Password for a WorkSite user, who is a member of the NRTADMIN Group for the enterprise server. This ID and password must have system administrator-level access to the enterprise server. 5. Enter TCP/IP Port Configuration information. The values entered in the Service Port and File Port fields are dedicated TCP/IP port numbers assigned to the WorkSite Server service tool. The service port is used for service transactions, and the file port is used for transmitting files. Autonomy recommends that you use the default value for the service port (1080) and file port (1081), unless otherwise instructed by WorkSite Technical Support. • • • 326 • • •
WorkSite Server Administrator’s guide
Overview of Proxying Capabilities
6. If you want to maintain a 1:1 ratio of threads to connections for this database, select the As many connections as threads check box. Otherwise, clear this check box and enter a custom number of connections that should be maintained between the WorkSite Server and database. See the WorkSite Server Installation Guide. 7. Click OK to save your entries and return to the WorkSite Server Database Setup dialog box. 8. Click Add Database to open the Database Properties dialog. Figure 169 Database Properties Dialog ox
9. Enter the name of the database in the Database Logon Setup field. 10. Enter the SQL Logon ID and Password for the database. This ID and password must have system administrator-level access to the database, such as the SA account. 11. Select the Enable Cache Fileserver check box. 12. If you want to maintain a 1:1 ratio of threads to connections for this database, select the As many connections as threads check box. Otherwise, clear the check box and enter a custom number of connections that should be maintained between the WorkSite Server and database. 13. Select the Preferred Database option to designate this database as the source for dialog boxes, captions, and roles. Any database that is identified as a Preferred Database can serve as a source for dialog boxes, captions and roles. Each WorkSite Server must be connected to at least one database that is identified as a preferred database. You can specify alternate preferred databases for individual users using the Database Administration tool. 14. If this database functions as a web content database for use with the WorkSite Web client, select the Web Content check box.
WorkSite Server Administrator’s guide
• • • 327 • • •
Chapter 13: WorkSite Server with Caching
15. If you want the Web Content database to be hidden from end-users, select the Hidden check box. 16. If you want to enable full-text searching on this database, select the Enable Full- Text Searching check box. 17. Enter values for the full-text search setup for this database:
Specify the name or IP address of the full-text search server or cluster in the Cluster / Server Name field.
To specify a TCP/IP service port for the full-text search server, select Specify Service Port and enter the service port in the field. The default is 1082.
18. Click OK to save your entries and return to the WorkSite Server Database Setup dialog box. 19. Click Close to return to the WorkSite Server Service Manager window.
• • • 328 • • •
WorkSite Server Administrator’s guide
Chapter 14
Tools and Utilities Overview This chapter includes information on the following tools or utilities:
“Migrating Users to a Different Database”
“Populating Custom Tables”
“Populating User Tables”
Migrating Users to a Different Database Users in a WorkSite System are assigned a default database where the user’s personal settings, subscriptions and favorites are stored. This database is the user’s preferred database. It may be necessary to assign a user to a different database. For example, the user might move to a different department or a different office within the organization. In this case, the user’s personal settings, subscriptions and favorites should move to the new default database. You can use the WorkSite User’s Preferred Database Migration Tool to make this modification.
Prerequisites The WorkSite User’s Preferred Database Migration Tool requires the following prerequisites:
Every WorkSite Database must contain information about the intended destination database in the MGHGROUP.LIBRARIES table.
Each WorkSite Server must have a common administrator account for every WorkSite Server and WorkSite Database across the entire system.
WorkSite Server Administrator’s guide
• • • 329 • • •
Chapter 14: Tools and Utilities
Working of User’s Preferred Database Migration Tool The WorkSite User’s Preferred Database Migration Tool is a command line program. You can use the Migration Tool to enter the following information:
Server
Administrative user ID and password to log in to the server
Source database
Destination database
Target user ID name in both the source and destination database
Option the name and path of a log file
When the information is entered on the command line and executed, the Migration Tool performs a four-stage algorithm:
“Stage 1: Initialization”
“Stage 2: Copy”
“Stage 3: Finalization”
“Stage 4: Deletion”
Stage 1: Initialization 1. Using the administrative userID and password, the Migration Tool logs into the first server in the server list, and checks the connection to the source and the destination database. If any connection fails, the Migration Tool closes. 2. The Migration Tool checks to see if the targeted user is in the source database, and if that the source database is the current preferred database for this user. If not, no further action is performed for this targeted user and the Migration Tool closes. 3. Next the Migration Tool checks to see if the target user exists in the destination database. If not, no further action is performed for this targeted user and the Migration Tool closes. 4. The Migration Tool checks to see if the destination database contains any of the following information for the targeted user:
Any user's preference settings
Any subscription hierarchy
Any favorite hierarchy
If any of this information is found, it is the result of a previous unsuccessful migration. This data is removed from the destination database before initiation of the Copy Stage. If any error occurs, the Migration Tool closes. • • • 330 • • •
WorkSite Server Administrator’s guide
Migrating Users to a Different Database
Stage 2: Copy In this stage the target user’s preference settings, subscription hierarchy, and favorite hierarchy are copied to the destination database.
User's preference settings In the WorkSite Web Client product, users can choose whether or not to display the following items:
Checkout list
Worklist
Recent pages
Preferences
Subscriptions
Favorites
Explorer
Search histories
The Migration Tool copies the visibility flag settings for these items from the source database to the destination database. If any unrecoverable error occurs, the Migration Tool closes.
Subscription Hierarchy The Migration Tool copies the entire subscription hierarchy recursively to the destination database. If any unrecoverable error occurs, the Migration Tool closes.
Favorites Hierarchy The Migration Tool copies the entire subscription hierarchy recursively to the destination database. If any unrecoverable error occurs, the Migration Tool closes.
Stage 3: Finalization In this stage, all the target user's preferred database settings in every database across the system are updated so that they point to the new destination database. Also, any existing references in other users' subscription hierarchies that point to the target user's old subscription hierarchy in the old database are updated so that they reference the new hierarchy in the destination database. If any unrecoverable error occurs, the Migration Tool closes.
WorkSite Server Administrator’s guide
• • • 331 • • •
Chapter 14: Tools and Utilities
Stage 4: Deletion When the migration succeeds, all of the user preferred database settings in all the databases have been updated, and all existing subscription shortcuts that point to the old subscription hierarchy has been redirected. At this point the Migration Tool deletes the old information in the source database.
Performing a Preferred Database Migration Use the following procedure to move a user’s settings, subscriptions, and favorites from one preferred database to another. 1. Verify that every WorkSite database in the system contains information about the intended destination database in the MGHGROUP.LIBRARIES table. 2. Verify that each WorkSite Server has a common administrator account for every WorkSite Server and every WorkSite Database across the entire system. 3. Choose Run from the Start menu and type cmd. Then click OK. A command window opens. 4. Enter the following parameters. Table 2.1: Parameter
Description
-svr
A list of server names, separated by one or more spaces.
-usr
The common login to every server.
-pwd
The common password for -usr.
-sdb
The source WorkSite 8.2 database name. This parameter is case-sensitive.
-ddb
The destination WorkSite 8.2 database name. This parameter is case-sensitive.
-tuser
The target user login name in both the source database and the destination database.
-logfile
The log file with the full path. If not specified, the log file name is PDMTool.log, and it is located in the working directory.
You can enter the parameters in any sequence. For example, both of the following entries should be valid for migrating user UU from database SS to database DD using the default administrator login in both databases. C:\ > PDMTool.exe -svr workdemo -usr adminuserid -pwd adminpassword -sdb SS -ddb- DD -tuser UU
or • • • 332 • • •
WorkSite Server Administrator’s guide
Populating Custom Tables
C:\> PDMTool.exe -svr workdemo -sdb SS -ddb DD -tuser UU -usr adminuserid -pwd adminpassword
5. Press Enter after you have listed all the parameters.
Populating Custom Tables The Custom Table Loading Utility, clload.exe, is a command line executable that can be used to populate or load entries into the custom tables of a WorkSite database from any ANSI text file. This executable can be run from the command line or from a standard Windows batch file. The actual loading process performed by the custom table loading utility is identical to that performed from within the Database Administration program, but it can be executed automatically from within a batch file. The parameters used to configure the loading process are explained below, along with the specifications for the text files used in the loading process. The custom table loading utility can only load entries into the Custom1/Custom2 tables (custom 1 and 2), custom tables 3-12, and the Custom29/Custom30 tables (custom 29 and 30).
Prerequisites
Database created using WorkSite Network version 4.0
The clload.exe can only be run from a batch file or from the command line.
The clload Command The general form of the clload command is listed below. The parameters listed in are always required. The parameters listed in [brackets] have default values assigned to them and only need to be specified when performing certain types of loads. Each of these parameters is explained fully with examples in the pages that follow. The parameters may appear on the command line in any order. clload [/parentAlias:parentalias] [/overwrite:flag] [/childflag:flag] [/format:[delimiter][column1][column2][column3][column4]]
WorkSite Server Administrator’s guide
• • • 333 • • •
Chapter 14: Tools and Utilities
Required Format for the ANSI Text File The Custom Table Loading Utility can insert entries taken only from an ANSI text file into the custom tables on a WorkSite database. The text file should be formatted to contain a series of records (or rows), each of which contains at least a custom alias, a custom description, and an enabled/disabled value. Fields (or columns) in each record must be delimited by a single, consistent character, such as a comma, pipe symbol, exclamation point, or asterisk. When importing parent and child table entries simultaneously, each record in the text file must contain, minimally, a parent alias, parent description, parent enabled/disabled value, child alias, child description, and child enabled or disabled value. Each row (or record) in the text file must end with an end of line character. Each record in the text file may contain additional fields which will be skipped in the course of loading in the table entries. Valid enabled or disabled values are Y or N and empty string. Empty string is treated as a Y.
Command Line Parameters Table 41 lists line parameters classified as Required or Optional. Table 41 Command Line Parameters Required Command Line Parameters
Optional Command Line Parameters
/db:databasename loginid password
/parentalias:parentalias
/file:filename
/overwrite:Y or N
/table:tablename
/childflag:Y or N /format:“delimiter” field1 field2 field3 field4 field5 field6
Required Parameters /db:databasename loginid password The /db parameter is required and must provide the ODBC data source name (databasename), the user ID which will be used to log into the database, and the password. If the password is null, use two double quotes to indicate a null password: “” Examples: clload /db:atlanta sa “” clload /db:WorkSite sa password
• • • 334 • • •
WorkSite Server Administrator’s guide
Populating Custom Tables
/file:filename The /file parameter indicates the path and name of the ANSI text file that contains the entries that will be loaded in the specified custom table. Examples: clload /file:c:\temp\clients.txt clload /file:d:\public\accounts.txt clload /file:e:\acc\public\accounts\css.txt
/table:tablename The /table parameter specifies which table the entries will be loaded into. The only valid table names that may be entered for this parameter are listed below. The table name is case-sensitive: all table names must be entered in all caps, as shown. When importing entries into a parent table and its child table simultaneously, enter the table name for the parent table in the /table parameter (i.e., enter either CUSTOM1 or CUSTOM29.) When importing entries into the Client, Matter, Practice or Subpractice tables, use the table names, CUSTOM1, CUSTOM2, CUSTOM29, or CUSTOM30 respectively. /table:CUSTOM1(Client table) /table:CUSTOM2(Matter table) /table:CUSTOM3 /table:CUSTOM4 /table:CUSTOM5 /table:CUSTOM6 /table:CUSTOM7 /table:CUSTOM8 /table:CUSTOM9 /table:CUSTOM10 /table:CUSTOM11 /table:CUSTOM12 /table:CUSTOM29(Practice table) /table:CUSTOM30(Subpractice table)
Optional Parameters /parentalias:parentalias The /parentalias parameter is only used when the table name specified is CUSTOM2 or CUSTOM30. (i.e., when you are importing Matter or Subpractice entries.) When you are importing entries into either of these child tables, you must specify the parent alias to which the imported entries should belong. This parent alias must already exist as a valid entry in the corresponding parent table on the database. This parameter is ignored when the table name specified in the /table parameter is anything other than CUSTOM2 or CUSTOM30.
WorkSite Server Administrator’s guide
• • • 335 • • •
Chapter 14: Tools and Utilities
Examples: /parentalias:0012359
(Result: All child entries imported in this load will be added to the child table associated with this parent alias.) /overwrite:Y or N The /overwrite parameter specifies whether to overwrite existing description information if the alias already exists. Normally, the clload.exe program will not overwrite existing description information in the database. (By default, this parameter is set to N.) If an alias appears in the text file, and the /overwrite parameter is not set to N, then the entry in the database is not changed. If the /overwrite parameter is set to Y when an alias appears in the text file that already exists in the database, the clload program will replace the existing description field for that alias in the database with the one specified in the text file. If the /overwrite parameter is set to Y while description information is being skipped, then no substitutions will be made in the description field. /childflag:Y or N The /childflag parameter specified whether to load only parent table entries or both parent and child table entries simultaneously. To load both together, specify Y. To load only parent table entries, specify N. The /childflag parameter is set to Y by default. This parameter only applies when the table name selected in the /table parameter is set to CUSTOM1 or CUSTOM29. /format:“delimiter” field1 field2 field3 field4 field5 field6 The /format parameter is used to identify the character used to delimit fields in the text file. Double quotes must be placed around the delimiter character when the character used as a delimiter is a pipe symbol, less than or greater than characters, an asterisk, or any other symbol that may be parsed incorrectly on the command line. (A pipe symbol, for instance, indicates that you want to pipe the results of the first command to a particular input device.). The criteria that follows the /format parameter is: delimiter character used to delimit fields in the text file. The default delimiter is a comma. field1: number of field (or column) that contains the parent alias. This number defaults to 1. field2:number of field (or column) that contains the parent description. This number defaults to 2. field3:number of field (or column) that indicates whether this item should be enabled (Y) or disabled (N). This number defaults to 3. field4:number of field (or column) that contains the child alias. The value of this field defaults to 4. • • • 336 • • •
WorkSite Server Administrator’s guide
Populating Custom Tables
field5:Number of field (or column) that contains the child description. The value of this field defaults to 5. field6:number of field (or column) that indicates whether this item should be enabled (Y) or disabled (N). This number defaults to 6. When you are importing entries in any custom table other than CUSTOM1 and CUSTOM29 (the Client and Practice tables), any values entered for fields 4, 5 and 6 are ignored, and the values for fields 1, 2, and 3 only are used to extract the custom alias and description from each row or record in the text file. Example: /format:"|" 3 4 2 1 5 6
(Result: Given this formatting parameter, this load will parse the file using the pipe symbol as the character designated to delimit fields in the text file, and it will read in the third and fourth fields as the alias and description for each custom table entry. If the second field in that row in the text file contains an "N" or "n", the item will be disabled. If it contains a "Y" or "y" or empty string, the item will be enabled. If parent-child tables are being loaded simultaneously, then the first and fifth fields in each record will also be used to create a child table entry that will be associated with that parent table entry. The child table entry will be enabled or disabled based on the value in field six.)
Skipping the Description Field You can choose to load only aliases into any custom table by specifying a field number of negative one (–1) as the field number from which to take the description field. When –1 appears as the field number for the description field in the /format parameter statement, then description fields will be loaded in. Example: /format:“|” 3 -1 1 5
Result: No descriptions will be loaded in for any custom table entries or parent table entries loaded in. This feature may be used when loading in parent-child tables simultaneously. Either parent or child descriptions or both may be skipped.
Loading Multiple Child Table Entries While loading parent and child tables simultaneously, multiple child table entries can be loaded in and associated with the same parent table entry by repeating the same parent alias and description in multiple rows in the text file. For example, consider the results of loading in the following text file using the following command line:
WorkSite Server Administrator’s guide
• • • 337 • • •
Chapter 14: Tools and Utilities
Example command line: clload /db:chicago sa “” /table:CUSTOM1 /childflag:Y /file:c:\temp\climat.txt /overwrite:N /format:“,” 1 2 3 4
Example text file excerpt: PA00012,PETERS ACCOUNT,SS00001,DAYTON OFFICE PA00012,PETERS ACCOUNT,SS00002,WRIGLEY OFFICE PA00012,PETERS ACCOUNT,SS00003,STAMFORD OFFICE
If the above command line is used to load in data from a text file that contains the excerpt above, then three entries will be added to the Matter table for the single Client table entry, PA00012.
Examples of Valid Command Line Entries clload /db:ntdb sa "" /table:CUSTOM1 /file:c:\temp\climat.txt /overwrite:Y / childflag:n /format:"," 1 2 3 4
The above command line statement specifies that client entries should be loaded into the database NTDB using the userid SA with a null password from the file, CLIMAT.TXT, located in the C:/TEMP directory. The text file will be parsed using a comma and only parent table entries will be loaded in. The alias will come from the first field in each row (or record) in the text file, the description will come from the second field in each row (or record) in the text file. clload /db:ntdb sa "" /table:CUSTOM2 /parentAlias:000002 /file:c:\temp\ climat.txt
The above command line statement specifies that matter entries should be loaded into the database NTDB using the userid SA with a null password from the file, CLIMAT.TXT, located in the C:/TEMP directory. The matter entries will all be added to the entry in the client table with the alias, 000002. clload /db:ntdb sa "" /table:CUSTOM3 /file:c:\temp\climat.txt /overwrite:Y / client:n /format:"," 1 2
The above command will load entries into the custom3 table from the text file CLIMAT.TXT and overwrite the descriptions of existing entries.
Populating User Tables The User Table Loading Utility, userload.exe, is a command line executable that can be used to populate or load entries into the user tables of a WorkSite database from any ANSI text file. This executable can be run from the command line or from a standard Windows batch file. The actual loading process performed by the user table loading utility is identical to that performed from within the DBAdmin tool, but it can be executed automatically from within a batch file. The parameters used to configure the loading process are explained below, along with the • • • 338 • • •
WorkSite Server Administrator’s guide
Populating User Tables
specifications for the text files used in the loading process. This utility can only load entries into the user table.
Prerequisites
Database created using WorkSite 7.0 or later.
The userload.exe may only be run from a batch file or from the command line.
The userload command The general form of the userload command is listed below. The parameters listed in are always required. The parameters listed in [brackets] have default values assigned to them and only need to be specified when performing certain types of loads. Each of these parameters is explained fully with examples in the pages that follow. The parameters may appear on the command line in any order. [/format:[delimiter][column1][column2][column3] [column4][column5][column6][column7][column8][column9][column10][column11][c olumn12]]
Required Format for the ANSI Text File The User Table Loading Utility can insert entries taken only from an ANSI text file into the user table on a WorkSite database. The text file should be formatted to contain a series of records (or rows). Fields (or columns) in each record must be delimited by a single, consistent character, such as a comma, pipe symbol, exclamation point, or asterisk. Each row (or record) in the text file must end with an end of line character. Each record in the text file may contain additional fields which will be skipped in the course of loading in the table entries.
Command Line Parameters /db:databasename loginid password The /db parameter is required and must provide the ODBC data source name (database name), the user ID which will be used to log into the database, and the password. If the password is
WorkSite Server Administrator’s guide
• • • 339 • • •
Chapter 14: Tools and Utilities
null, use two double quotes to indicate a null password: "". Autonomy does not recommend using a null password. Examples: userload /db:atlanta sa "" userload /db:WorkSite sa password
[/MustChangePwd: [Y|N]] The /MustChangePwd parameter is optional. If used, Y indicates that the user must change the password at the next login; N indicates that the user is not required to change the password. The default is Y.
/mode: “insert” “overwrite” “sync” The /mode parameter defines how the Userload Utility treats current user values. The action of various modes is defined in the following table. Table 42 Mode action on current user values Mode
Description
“insert”
Inserts new users.
“overwrite”
Overwrites values, including Password and MustChangePwd.
“sync”
Synchronizes values; acts like overwrite, except Password and MustChangePwd are not updated.
/file:filename The /file parameter indicates the path and name of the ANSI text file that contains the entries that will be loaded in the specified custom table. Examples: userload /file:c:\temp\user.txt userload /file:d:\public\user.txt
/format:"delimiter" field1 field2 field3 field4 The /format parameter is used to identify the character used to delimit fields in the text file. Double quotes must be placed around the delimiter character when the character used as a delimiter is a pipe symbol, less than or greater than character, an asterisk, or any other symbol that may be parsed incorrectly on the command line. A pipe symbol on the command line, for
• • • 340 • • •
WorkSite Server Administrator’s guide
Populating User Tables
instance, normally indicates that you want to pipe the results of the first command to a particular input device. The criteria that follows the /format parameter is described in the following table. Table 43 Format Criteria Criteria
Description
delimiter
character used to delimit fields in the text file. The default delimiter is the pipe symbol “|”.
Column1:
Column number for UserID field.
Column2:
Column number for Password field; if Password field is empty, MHDOCS is used as the default password.
Column3:
Column number for Full Name field.
Column4:
Column number for Location field.
Column5:
Column number for Phone field.
Column6:
Column number for Extension field.
Column7:
Column number for Fax field.
Column8:
Column number for E-mail field.
Column9:
Column number for OS type field.
Column10:
Column number for Container field.
Column11:
Column number for File Server field.
Column12:
Column number for Primary Library field.
Examples of valid command line entries: UserLoad /db:ntdb sa "" /MustChangePwd:Y /file:c:\temp\UserData.txt / mode:insert /format:"," 1 2 3 4 5 6 7 8 9 10 0 0
The above command line statement specifies that entries should be loaded into the database NTDB using the userid SA with a password of “mhdocs” from the file, UserData.txt, located on the C drive in the TEMP directory. The text file will be parsed using a comma. There is no default FILE SERVER or PRIMARY LIBRARY in the data file. UserLoad /db:ntdb sa "" /MustChangePwd:N /file:c:\temp\UserData.txt / mode:overwrite /format:"," 1 0 0 0 0 0 0 0 0 0 2 3
The above command line is for a case where only the UserID, default FILE SERVER and PRIMARY LIBRARY are present in the data file. The password will default to “mhdocs.”
WorkSite Server Administrator’s guide
• • • 341 • • •
Chapter 14: Tools and Utilities
• • • 342 • • •
WorkSite Server Administrator’s guide
Appendix A
Reading the WorkSite Server Log File Overview This appendix includes information on the following topics:
“Abbreviations”
“Common DMSLog.txt File Entries”
Information to help you understand the log file generated by the WorkSite Server service is provided in this section. The log file generated by the WorkSite Server service is named DMSLog.txt and should be located in the installation path for WorkSite Network.
Abbreviations During normal operation, the log file grows by two lines of text every minute. Table 44 lists the abbreviations used in these entries during normal operation to report on the status of WorkSite Server service. Table 44 Abbreviations used in the DMSLog.txt file Abbreviation
Meaning
QD
Files download in last minute
TD
Files downloaded since startup
QU
Files uploaded in last minute
TU
Files downloaded since startup
WorkSite Server Administrator’s guide
• • • 343 • • •
Appendix A: Reading the WorkSite Server Log File
Table 44 Abbreviations used in the DMSLog.txt file Abbreviation
Meaning
QS
Queue size: number of transactions waiting to be processed
XQ
Number of transactions completed in last minute
US
Number of users attached to the WorkSite Server
XT
Total number of transactions completed since server was started.
NOTE
There are two values for QS recorded in each entry in the log file during normal operation. The FileXfer QS is the number of file uploads or downloads waiting to be performed. The RpcManager QS is the number of SQL database transactions waiting to be performed. You can use either of these entries to evaluate the efficiency of your WorkSite Server.
Common DMSLog.txt File Entries This section describes common entries in the DMSLog.txt file and their significance. Example 1: Normal operation Concerns: None Sun 03/01 17:39:33.875LogMsg: 76:Info [0230] ***************** STARTUP ****************** Sun 03/01 17:39:36.234DsRpcManager: 150:Info [0230] Connected to database madrid Sun 03/01 17:39:38.203DsRpcManager: 150:Info [0230] Connected to database madrid Sun 03/01 17:41:00.375FileXfer: 508:Info [0320] QD=0 TD=0 QU=0 TU=0 RL=0 XL=0 QS=0 Sun 03/01 17:41:00.703RpcManager: 592:Info [0224] XQ=14, XT=33, US=1, QS=0, Mon 03/02 20:19:41.968DataCache: 705:Debug [0288] Cache stats for database madrid Mon 03/02 20:19:42.031DataCache: 707:Debug [0288] C01: loads 1, adds 0, hits 26, miss 0 Mon 03/02 20:19:42.109DataCache: 712:Debug [0288] C02: loads 1, adds 0, hits 26, miss 0 MMon 03/02 20:19:43.515LogMsg: 83:Info [0288] *************** SHUTDOWN****************
Example 2: User's transaction was aborted, possibly because of call timeout or the user aborted the request. Concerns: None, unless repeating continually. Mon 03/02 15:49:55.015Executer: 100:Info [0244] Transaction aborted by user • • • 344 • • •
WorkSite Server Administrator’s guide
Common DMSLog.txt File Entries
Mon 03/02 15:49:55.078Executer: 587:Error [0247] getNextNum - Fetch command failed; SQL State: 00000, SQL Error: Mon 03/02 15:49:55.140Executer: 591:Error [0247] SQL Command: SELECT ID_VALUE FROM MHGROUP.ID_TABLE (TABLOCKX) Mon 03/02 15:49:55.281Common: 212:Warn [0247] Transaction rollback: getNextNum
Example 3: User’s pending request(s) were aborted, possibly due to timeout or because user exited the application Concerns: None, unless repeating continually. Mon 03/02 20:29:48.515 at 10.5.3.117
DsRpcManager: 68:Info [0330] Aborting work for user ZIA
Example 4: User's session was terminated after a long period of inactivity. Concerns: None. Tue 03/03 15:17:01.031 RpcManager: 639:Info [0161] Session from 10.5.3.114:31493 will be closed after 3700 seconds of inactivity
Example 5: The SQL transaction log is full and needs to be emptied. Concerns: This is a serious problem with database and requires immediate action. Wed 03/04 17:32:50.937Executer: 587:Error [0168] execStatement - Unable to execute SQL Command; SQL State: 37000, SQL Error: [Microsoft][ODBC SQL Server Driver][SQL Server]Can't allocate space for object 'Syslogs' in database 'paris' because the 'logsegment' segment is full. If you ran out of space in Syslogs, dump the transaction log. Otherwise, use ALTER DATABASE or sp_extend Wed 03/04 17:32:50.984Executer: 587:Error [0315] execStatement - Unable to execute SQL Command; SQL State: 37000, SQL Error: [Microsoft][ODBC SQL Server Driver][SQL Server]Can't allocate space for object 'Syslogs' in database 'paris' because the 'logsegment' segment is full. If you ran out of space in Syslogs, dump the transaction log. Otherwise, use ALTER DATABASE or sp_extend Wed 03/04 17:32:51.031Executer: 587:Error [0352] execStatement - Unable to execute SQL Command; SQL State: 37000, SQL Error: [Microsoft][ODBC SQL Server Driver][SQL Server]Can't allocate space for object 'Syslogs' in database 'paris' because the 'logsegment' segment is full. If you ran out of space in Syslogs, dump the transaction log. Otherwise, use ALTER DATABASE or sp_extend Wed 03/04 17:32:51.156Executer: 591:Error [0168] SQL Command: SELECT PRJNUM FROM MHGROUP.PRJNUMDB (TABLOCKX) Wed 03/04 17:32:51.234Executer: 591:Error [0315] SQL Command: SELECT PRJNUM FROM MHGROUP.PRJNUMDB (TABLOCKX) Wed 03/04 17:32:51.296Executer: 591:Error [0352] SQL Command: SELECT PRJNUM FROM MHGROUP.PRJNUMDB (TABLOCKX) Wed 03/04 17:32:51.421 Common: 212:Warn [0168] Transaction rollback: insertProject Wed 03/04 17:32:51.531 Common: 212:Warn [0315] Transaction rollback: insertProject Wed 03/04 17:32:51.671 Common: 212:Warn [0352] Transaction rollback: insertProject
Example 6: Database server terminated the transaction due to a transaction deadlock
WorkSite Server Administrator’s guide
• • • 345 • • •
Appendix A: Reading the WorkSite Server Log File
Concerns: Part of the normal operation; the server is capable of internally recovering from such conditions without the user noticing anything Wed 03/04 20:02:15.718Executer: 587:Error [0638] execStatement - Unable to execute SQL Command; SQL State: 40001, SQL Error: [Microsoft][ODBC SQL Server Driver][SQL Server]Your server command (process id 30) was deadlocked with another process and has been chosen as deadlock victim. Re-run your command Wed 03/04 20:02:16.062Executer: 591:Error [0638] SQL Command: UPDATE MHGROUP.DOCMASTER SET DOCINUSE = 'N', LOGNODEADDR = '', INUSEBY = '' WHERE (DOCNUM = 987) AND (VERSION = 1) Wed 03/04 20:02:16.156Common: 212:Warn [0638] Transaction rollback: copydocument Wed 03/04 20:02:16.390DocMgr:4387:Info [0638] Retrying transaction: retry# 1
Example 7: An uploaded file was not used in a transaction and cleaned up by the server Concerns: Usually none. This can happen for example when a user tries to import a document with invalid profile. The transaction is rejected by the server and the uploaded file is eventually removed Wed 03/04 889063191 Wed 03/04 889063199
20:05:46.937FileXfer: 781:Warn [0380] Removing uploaded file cookie for 205.205.205.205. Not used for >10 minutes after upload. 20:05:47.015 FileXfer: 781:Warn [0380] Removing uploaded file cookie for 205.205.205.205. Not used for >10 minutes after upload.
Example 8: User aborted the transaction during a file upload Concerns: Usually none. Thu 03/05 18:18:45.828FileXfer: 717:Warn [0366] File Receive - Did not receive entire file - 0 bytes of 42506716
Example 9: The database schema is either older or newer than the server. Concerns: Possibly serious. Upgrade or conversion may be required. Database will not be usable. Wed 03/11 17:25:52.890DsRpcManager: 159:Info [0166] Connected to database madrid Wed 03/11 17:25:53.078DsRpcManager: 220:Error [0166] Database schema for database madrid is not compatible with this DMS.
Example 10: The connection to the database has become invalid possibly because of a database shutdown or restart. Concerns: Possibly serious. The WorkSite Server Service is capable of reconnecting to a restarted database server. Wed 03/11 18:36:59.437Executer: 587:Error [0554] execStatement - Unable to execute SQL Command; SQL State: 08S01, SQL Error: [Microsoft][ODBC SQL Server Driver][dbnmpntw]Invalid connection. Wed 03/11 18:36:59.500Executer: 591:Error [0554] SQL Command: SELECT PRJNUM FROM MHGROUP.PRJNUMDB
Example 11: The connection to the database has become invalid possibly because of a database shutdown. • • • 346 • • •
WorkSite Server Administrator’s guide
Common DMSLog.txt File Entries
Concerns: Serious. Restart the database server. Wed 03/11 18:33:27.812Connect:1212:Error [0220] sqlserver_connect SQL Error: [Microsoft][ODBC SQL Server Driver][dbnmpntw]Specified SQL server not found. Wed 03/11 18:33:27.875Manager: 102:Info [0220] Reconnect attempt to database paris failed
Example 12: The WorkSite Server Service has reconnected to the database. One entry appears in the log file for each thread. Concerns:None (Be happy). Wed 03/11 18:35:23.890Manager: 98:Info [0554] Reconnected to database paris
Example 13: The connection to the database has become invalid possibly because of a database shutdown. Concerns: Serious. Restart the database server. Wed 03/11 18:35:25.125Manager: 69:Error [0220] Could not locate connection handle for paris
WorkSite Server Administrator’s guide
• • • 347 • • •
Appendix A: Reading the WorkSite Server Log File
• • • 348 • • •
WorkSite Server Administrator’s guide
Appendix B
Database Schema Overview This chapter lists the database tables and their functions. This list is subject to change in future releases. For related information, see the COM Object for WorkSite Database Administration Developer's Guide. Table 45 Database Table Functions Table Name
Function
APPS
This table maintains a record of applications, app paths, app alias and info needed to run apps
ARCHIVETBL
Keeps a record of where archives have been placed
ARCHIVENUMDB
Contains the ID number that will be given to the next archive
ARSET_INFO
This table maintains the relation of archived documents to their archive_ID
CACHE_UPDATE
Keeps track of when cached files were updated on the server
CAPTIONS
Records the captions used on the Search, New Profile, New Version, and Edit Profile dialogs
CHECKOUT
Tracks the location, checkout date, and other information pertaining to checkedout documents
CUSTOM1
Lookup values for the Custom1 field
CUSTOM10
Lookup values for the Custom 10 field
CUSTOM11
Lookup values for the Custom 11 field
CUSTOM12
Lookup values for the Custom 12 field
CUSTOM2
Lookup values for the Custom 2 field
CUSTOM29
Lookup values for the Custom 29 field
CUSTOM3
Lookup values for the Custom 3 field
WorkSite Server Administrator’s guide
• • • 349 • • •
Appendix B: Database Schema
Table 45 Database Table Functions
• • • 350 • • •
Table Name
Function
CUSTOM30
Lookup values for the Custom 30 field
CUSTOM31
Lookup values for the Custom 31 field
CUSTOM4
Lookup values for the Custom 4 field
CUSTOM5
Lookup values for the Custom 5 field
CUSTOM6
Lookup values for the Custom 6 field
CUSTOM7
Lookup values for the Custom 7 field
CUSTOM8
Lookup values for the Custom 8 field
CUSTOM9
Lookup values for the Custom 9 field
DEINDEX_DOCS
List of documents to be removed from index collections
DOC_ACCESS
Permissions to documents
DOC_DENIAL
Document access restrictions
DOC_INDEX
Location of documents within index collections
DOC_KEYWORDS
A list of words in documents that help to classify the documents. Not currently used in version 8.2.
DOC_NVPS
Name-value pairs for document
DOCARTIFACT
This table is used to reference documents that have been moved from one database to another through the WorkSpace Migrator
DOCCACHE
Table of information for document caching
DOCCLASSES
Table of Lookup values for the Document Class field
DOCHISTORY
History of all the documents
DOCMASTER
Document names and their profile information
DOCNUMDB
The next number that the server will assign a new document
DOCSERVERS
List of file servers
DOCSUBCLASSES
Lookup values for the Subclass field
DOCTYPES
Lookup values for the Document Type
DOCUSERS
List of users
DSECURITY
Specifications for default security settings
EMAIL_ATTRS
The status of reconciled or failed e-mails for Symantec Enteprise Vault
FORM_CONTROLS
Control layout for current dialog objects, such as buttons, fields, or labels
FORM_TEMPLATE
Default Layout for the dialogs, such as dialog size, or background color
WorkSite Server Administrator’s guide
Overview
Table 45 Database Table Functions Table Name
Function
FORM_TYPES
Relation of Form ID and Description
FORMS
Actual Layout for the dialogs, such as dialog size, or background color
GROUPMEMS
Group membership - Group Num. Cross listed with User numbers
GROUPS
Group information
GRP_SCTY_ACC_TEM Security templates assigned to groups P ID_TABLE
Next system ID number
INDEX_COLLECTION
List of Index Collections
KEYWORDS
List of Keywords. Not currently used in version 8.2.
LIBRARIES
List of databases
MHINFO
Not used
MHPERMS
List of database option bit masks
MHPROFILES
List of profile templates
NODELOC
List of PC locations
PALETTE
Palette used to populate database dialogs with buttons, fields, or other items
PRJNUMDB
Next folder number
PROJ_ACCESS
Folder access
PROJ_DENIAL
List of users and groups denied folder access
PROJARTIFACT
Lists artifact information for migrated projects needed to locate project table entries from the database
PROJECT_ITEMS
Folder items cross-referenced with folder IDs
PROJECT_NVPS
Name-value pairs for folders
PROJECTS
Folders
QUICK_RETRIEVE
User work lists
RE_RECIPIENT
Rules Engine - List of recipients of notification of events that trigger rules execution
RE_RULE_EVENT
Rules Engine - List of events that can be used to define rules
REEVENTDEF
Rules Engine - Definitions of different events, such as new version, edit profile, and other actions that trigger rule execution
WorkSite Server Administrator’s guide
• • • 351 • • •
Appendix B: Database Schema
Table 45 Database Table Functions Table Name
Function
REEVENTLOG
Rules Engine - Log listing different events, such as new version, edit profile, and other actions that trigger rule execution
RELATED_DOCS
Related documents
RERULEHANDLERS
Rules Engine - List of processes used to execute rules
RERULES
Rules Engine - List of rules
RERULESNUMDB
Rules Engine - Next rule number
RESTORETBL
Documents that have been requested to be restored from archive
ROLE_NVPS
Name-value pairs for roles
ROLE_PROFILES
Profile settings for each role
ROLES
List of Roles
SEARCH_PROFILES
Saved Search Ids and the users they belong to
SEARCH_PROFILE_DA Data placed in the fields of a saved searched TA SECURITY_TEMPLATE List of Security Templates SID_TABLE
List of SIDs
SRCH_PROF_ACCESS
List of users and groups with access to Saved Searches
SRCH_PROF_DENIAL
List of users and groups denied access to Saved Searches
STOPWORDS
Words that are not searched for
SYNC_ITEMS
Lists the containers synchronized by each user in an offline/online transition (for example, My Matters and Matter Worklist)
SYNC_LOCATIONS
Lists the last synchronization time for each (user, workstation) pair
SYNC_PREFERENCES
Lists the synchronization preferences for each user
SYSTEM_MANAGEME Information about password expiration, warning, and NT number of logon attempts SYSTEM_PREFERENC ES
Information about system characteristics that are set on the server
SYSTEM_SYNC_PREFS Lists default value at the database level for optional saved search to filter out documents TEMPLATE_CONTROL Default template of the controls used on the various dialogs S
• • • 352 • • •
TYPEMAP
Document type mapping
USER_PREFERENCES
Lists work area preferences for the user
WorkSite Server Administrator’s guide
Overview
Table 45 Database Table Functions Table Name
Function
USER_SYNC_PREFS
Store an optional saved search to filter out documents
USERACTIONS
List of actions that users can perform
USERHISTORY
History of actions performed by users
USERNUMDB
Next user ID number or Group ID number
USERROLES
Users and the Role they have been assigned
USR_SCTY_ACC_TEM The user rights defined by each security template P USR_SCTY_TEMP_ASS Lists which security templates are assigned to which users C VERINFO
Version information
WEB_PAGE_ACCESS
infoLink - List of access rights for web pages
WorkSite Server Administrator’s guide
• • • 353 • • •
Appendix B: Database Schema
• • • 354 • • •
WorkSite Server Administrator’s guide
Appendix C
Server Configuration Options This appendix contains information about how to customize your system using options available in WorkSite Server. Some additional options are explained in the chapters where you are likely to be performing customizations specific to a particular utility or operation. This section includes the following configuration options:
Allowing Description Fulltext Search
OCR-TIFF Replacement
UTC Date Storage
Search Results Sorting
Restrict Data Sizes
Case Insensitive Searches in Oracle Databases
Version Editing
Retain Only Latest Version on Worklist
Ignore Disabled Groups
Immutable E-mail
WorkList Filtering
Pessimistic Security
One-Way or Two-Way Document Relations
E-mail Duplicate Detection
Enable/Disable User Edit of the Folder E-mail Address Field
Unicast or Multicast Clustering Transport Options
Default Minutes Between Synchronization Passes
Kerberos Authentication on Trusted Login
Support for Unknown File Types
WorkSite Server Administrator’s guide
• • • 355 • • •
Appendix C: Server Configuration Options
Server Side Email Filing
Allow Folder Creation in Public Workspaces
Allowing Description Fulltext Search This configuration setting allows for the handling of a combined description and full-text search. The setting allows users to choose whether or not the description criteria is passed to the Verity index collection. NOTE
This setting is only for use with the Verity-based WorkSite Indexer 8.2. It is ignored when WorkSite Server is configured to connect to Indexer 8.3. In the following location in the registry: HKEY_LOCAL_MACHINE\SOFTWARE\Interwoven\WorkSite\imDmsSvc
Modify the String value: Name: Allow Description Fulltext Search Values:
• • • 356 • • •
Y (default) – The description search criteria is passed to the Index Search service. Both the description and full-text criteria are used to query the Verity full-text index collection. This configuration can help avoid the Verity “bucket” issue by performing a zoned search on the description, however it can result in poor search performance if leading wildcards are used in the description field.
N – The description search criteria is not passed to the Index Search service. Only the full-text criteria is sent to the Index Search service. The full-text results are returned to the WorkSite Server which then queries the WorkSite database for the description criteria. In this configuration users may receive an error message indicating the search is too broad if the full-text criteria hits the Verity “bucket”, regardless of the description criteria provided.
WorkSite Server Administrator’s guide
OCR-TIFF Replacement
OCR-TIFF Replacement The WorkSite Server supports the ability to substitute OCR documents with their corresponding related TIFF documents when returning the results of a full-text search. The feature can be enabled on a per database basis using the following registry setting. In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\ imDmsSvc\Databases\[ODBC DSN]\
Set the following string value: Name: "Perform OCR Replacement" Value: "Y"
UTC Date Storage For proper handling of client applications in different time zones, the WorkSite Server is now capable of storing all date values in UTC format. For new installations, it is recommended to enable this feature. For upgraded databases, this feature should be turned off (disabled). By default, the installation program will enable this feature. To enable the storage of date values in UTC format: On every WorkSite Server: In the following key in the registry: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\
Set the following string value: Name: "UTC In Use" Value: "Y"
To disable, set value to "N". On the machine running the WorkSite Rules Engine service: In the following key in the registry: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imRulesEngine\
Set the following string value: Name: "UTC In Use." Value: "Y"
WorkSite Server Administrator’s guide
• • • 357 • • •
Appendix C: Server Configuration Options
To disable, set value to "N". On the machine running the WorkSite Clustering Service: In the following key in the registry: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imFmaSvc\
Set the following string value: Name: "UTC In Use." Value: "Y"
To disable, set value to "N".
Search Results Sorting Search in conducted in different ways in WorkSite. Search results are sorted based on the type of search that was conducted. The different types of searches can be described as follows: 1. Full Text Search. The WorkSite Indexer returns a list of search results sorted in order of relevancy, which the WorkSite Server retrieves and displays to the WorkSite clients. Full-text searches in the all the clients (DeskSite, FileSite, Express Search, and Miner) involve indexer relevancy search. Further levels of sorting can be achieved through the client interface. Sorting in the client involves sorting on the search results provided by the WorkSite Server and WorkSite Indexer.
DeskSite and FileSite. The Look For field in the Search dialog box of DeskSite and FileSite indicate the use of Full-text search. You can sort results within the document grid. For more information on sorting in DeskSite, see DeskSite Installation and User's Guide.
Express Search and WorkSite Miner. You must enter the word that you are searching for in the search field. The search results displayed are sorted based on the order of relevancy determined by the Indexer. WorkSite Miner offers the user the ability to sort by relevance or by a particular column displayed in the grid.
2. Email Properties (to / from). If you are searching based on the Custom 13 (To), Custom 14 (From) ),Custom15 (Cc), or Custom16 (Bcc), the Indexer returns a list of search results sorted in order of relevancy, which the WorkSite Server retrieves and displays to the WorkSite clients. Further levels of sorting can be achieved through the client interface. Sorting in the client involves sorting on the search results provided by the WorkSite Server and Indexer.
• • • 358 • • •
DeskSite and FileSite. A search performed using only an Email field in the Search Dialog in DeskSite or FileSite is an exception to the Indexer search.
WorkSite Server Administrator’s guide
Search Results Sorting
Express Search and WorkSite Miner. A search from WorkSite Miner or Express Search always performs a full-text search. In WorkSite Miner the only exception is when you search using the keywords Show-checkout and Show-Worklist. Further sorting is possible in the client using the grid columns. WorkSite Miner sorts on the displayed search results, not on the entire set of results. If you have set a limit on the number of search results to be viewed only that many search results will appear in the grid. You can retrieve and view all the search results when you click See all Results. This results in a new search request from the server. The Indexer returns a complete list of all the search results sorted in order of relevancy. This new search result can be further sorted using the client.
3. Description Searches (including the subject of e-mails). The Indexer returns a list of search results sorted in order of relevancy, which the WorkSite Server retrieves and displays to the WorkSite clients. Description search is similar to full-text searches where search results are also sorted based on relevancy by the WorkSite Indexer relevancy as description / subject searches are full text searches. Further levels of sorting can be achieved through the client interface. Sorting in the client involves sorting on the search results provided by the WorkSite Server and Indexer. NOTE
Sorting on the WorkSite client (Desksite, FileSite, Express Search, and WorkSite Miner) operates only on the local result set provided by the server. For example, if the Server returned 500 results out of 1000, the client will sort on the 500, and will not request new results from the Server unless a new search is performed. 4. Metadata only. WorkSite Server supports the ability to deliver document search results sorted by edit date and sorted metadata selection values. This feature is only supported for Microsoft SQL Server databases. The feature may be enabled or disabled on a per table basis. To enable or configure this feature: In the registry on every WorkSite Server machine: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\Databases\ [ODBC Data Source Name]\
Set the following DWORD value: Name: "Sort Order Mask" Value: [see below]
The value to specify for "Sort Order Mask" depends on which tables you want to have sorted by the server. To determine what value to specify as the DWORD value, add together the values below for all tables for which you want to enable sorting. This is the value to specify in the registry setting.
WorkSite Server Administrator’s guide
• • • 359 • • •
Appendix C: Server Configuration Options
NOTE
These values are in hexadecimal format. SORT_APPS 0x00000001 SORT_DOCMASTER 0x00000002 SORT_CUSTOM1 0x00000004 SORT_CUSTOM2 0x00000008 SORT_CUSTOM3 0x00000010 SORT_CUSTOM4 0x00000020 SORT_CUSTOM5 0x00000040 SORT_CUSTOM6 0x00000080 SORT_CUSTOM7 0x00000100 SORT_CUSTOM8 0x00000200 SORT_CUSTOM9 0x00000400 SORT_CUSTOM10 0x00000800 SORT_CUSTOM11 0x00001000 SORT_CUSTOM12 0x00002000 SORT_CUSTOM29 0x00004000 SORT_CUSTOM30 0x00008000 SORT_CUSTOM31 0x00010000 SORT_DOCCLASSES 0x00020000 SORT_DOCSUBCLASSES 0x00040000 SORT_DOCTYPES 0x00080000 SORT_DOCUSERS 0x00100000 SORT_GROUPS 0x00200000 SORT_ROLES 0x00400000 SORT_TYPEMAP 0x00800000
For example, to enable server-side sorting of APPS and DOCMASTER values, you would specify a value of 3 (1 +2). To enable server-side sorting for all tables, specify the value: 0x00FFFFFF. To disable all server-side sorting, specify 0 (zero). 5. Any combination of 1, 2, or 3 with 4. The server sorts by relevancy in the WorkSite Indexer (same as full text).
Restrict Data Sizes The Database Administration program can be configured so that it will restrict alias sizes in the database to 16 characters. This feature is turned off by default when you install WorkSite Server 7.x or later. To restrict alias sizes to 16 characters, Create the following registry key on the machine running the Database Administration program:
• • • 360 • • •
WorkSite Server Administrator’s guide
Case Insensitive Searches in Oracle Databases
In the following hive in the registry: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\DbAdmin\
Create the following DWORD value: Name: Compatible Data Sizes Value: 1
Set this value to 1 (one) to restrict alias sizes to 16 characters. If you want to remove this restriction, set this value to 0 (zero). If this key does not exist, then the Database Administration program restricts alias sizes to 16 characters.
Case Insensitive Searches in Oracle Databases Since Oracle databases are case sensitive, searches in Custom13-16 are case sensitive on Oracle databases. You can configure WorkSite Server to perform case-insensitive searches in the nonvalidated Custom 13-16 fields if you are running an Oracle database. To enable case insensitive searches on an Oracle database you must: First, run the following SQL Script on your database. CONNECT MHGROUPMHDOCS@ORCL; DROP INDEX MHGROUP.IX_DCMSTR_DOCNAME; CREATE INDEX IX_DCMSTR_UPDOCNAME ON MHGROUP.DOCMASTER (UPPER(DOCNAME)); CREATE INDEX IX_DCMSTR_UPALIAS ON MHGROUP.DOCMASTER (UPPER(ALIAS)); CREATE INDEX IX_DCMSTR_UPC13ALIAS ON MHGROUP.DOCMASTER (UPPER(C13ALIAS)); CREATE INDEX IX_DCMSTR_UPC14ALIAS ON MHGROUP.DOCMASTER (UPPER(C14ALIAS)); CREATE INDEX IX_DCMSTR_UPC15ALIAS ON MHGROUP.DOCMASTER (UPPER(C15ALIAS)); CREATE INDEX IX_DCMSTR_UPC16ALIAS ON MHGROUP.DOCMASTER (UPPER(C16ALIAS));
Next, in the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\
Create or set the following STRING value: Name: "Case Insensitive Oracle" Value: "Y"
Version Editing WorkSite Server 8.2 supports the ability to make older versions of documents read-only. When this option is enabled, users will be able to edit or modify the latest versions of documents, but
WorkSite Server Administrator’s guide
• • • 361 • • •
Appendix C: Server Configuration Options
all previous versions will be read-only, including the profile and security. (Administrative users are not subject to this restriction.) This feature may be enabled on a per database basis. NOTES
When the Version Editing feature is enabled, users who are working with an older WorkSite client may receive error messages if they attempt to modify an older version of a WorkSite document. Only the latest WorkSite client products are aware of the Version Editing feature and capable of adapting to it. The following WorkSite client products are aware of the Version Editing feature: WorkSite DeskSite 6.5 or later, WorkSite FileSite 4.0 or later, and WorkSite Web 4.3 or later. This feature should not be confused with the "Auto-Versioning" feature, which is available in the WorkSite client products. The Version Editing feature described here is independent of the client "Auto-Versioning" feature. Refer to the WorkSite Desktop Client Customization Guide for more information about the "Auto-Versioning" feature.
To enable this feature: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\Databases\ [ODBC Data Source Name]\
Create or set the following DWORD value: Name: "Version Editing" Value: 1
To disable this feature, set the value to 0 (zero).
Retain Only Latest Version on Worklist WorkSite Server 8.2 supports the ability to retain only the latest version of a document on the worklist, rather than all versions. This feature can be enabled on a per database basis. To enable this feature: In the following key in the registry on the WorkSite server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvs\Databases\ [ODBC Data Source Name]\
Create or set the following DWORD value: Name: "Worklist" Value: 1
• • • 362 • • •
WorkSite Server Administrator’s guide
Ignore Disabled Groups
To disable this feature, set the value to 0 (zero).
Ignore Disabled Groups WorkSite Server 8.2 can be configured to disregard groups that are disabled that may appear in an item's security access control list when attempting to resolve access rights for that object. For instance, if a user has access to a private document by virtue of membership in a group, that user would normally continue to have access to the document, even after the group is disabled, until the group is removed from the document's access control list. This configuration option causes the WorkSite Server to ignore disabled groups when determining the current user's access rights to a particular document or collaboration object. This feature can be enabled on a per database basis. To ignore disable groups when determining access rights: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\Databases\ [ODBC Data Source Name]\
Create or set the following STRING value: Name: "Include Disabled Groups" Value: "N"
Immutable E-mail By default, e-mail messages saved to WorkSite can be checked-out and edited in the same way as any other document. To prevent e-mail messages from being modified, you can configure e-mail to be read-only and declared as a record (that is, immutably read-only) by default by adding two registry key (one that defines what constitutes an e-mail by type and another that enables read only e-mail filing). To define e-mail messages by type: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE/Software/Interwoven/WorkSite/imDmsSvc/
Set the following STRING values: Name: Email Types Default Value: MIME,GW,NOTES
WorkSite Server Administrator’s guide
• • • 363 • • •
Appendix C: Server Configuration Options
NOTE
This registry key also defines what types are searched when searching for only e-mail in the search dialog. To declare e-mail messages as records: Set the following STRING values: Name: Import Emails As Declared Default Value: N (By default this option is not enabled.)
NOTE
The E-mail type is determined by the EMAIL TYPES registry key.
WorkList Filtering By default, e-mail messages saved to WorkSite are added to users' worklists like any other document. However, WorkSite Server 8.2 supports the ability to select whether e-mail messages saved to WorkSite should be added to users' worklists. To prevent e-mail messages from appearing on users' worklists: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc
Set the following STRING value: Name: "Add E-mails to Worklist" Value: "N"
NOTE
The E-mail type is determined by the EMAIL TYPES registry key.
Pessimistic Security By default, the WorkSite Server resolves conflicts between access grants when determining a user's effective access to any secured content using an optimistic security model. This means • • • 364 • • •
WorkSite Server Administrator’s guide
One-Way or Two-Way Document Relations
that if a user, Todd, is a member of a group, Managers, and a document is shared to Managers with ReadWrite access, and the document is also explicitly shared to Todd with Read-Only access, then Todd will get ReadWrite access. When optimistic security logic is used, the greatest of the several conflicting access grants is used. Conflicts between access grants can be conflicts between user and group assignments or between multiple group assignments, where the user is a member of multiple groups granted access to the secured content. WorkSite Server 8.2 can be configured to resolve conflicts between access grants using pessimistic security, rather than optimistic security. When the WorkSite Server is configured to use a pessimistic security model to resolve conflicts between access grants, the lowest of the several conflicting access grants that apply to the user is used. In the above example, if pessimistic security were enabled, Todd would get Read-Only access to the secured content. To configure optimistic or pessimistic security: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc
Set the following DWORD value: Name: "Security Model" Value: "0" for Optimistic Security (Default) "1" for Pessimistic Security
One-Way or Two-Way Document Relations WorkSite 8.2 client applications can be configured to treat document relations as one-way or two-way by configuring the following setting on the WorkSite Server. NOTE
This setting determines how document relations are created, not how existing document relations are handled. To configure one-way or two-way document relations: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc
Set the following DWORD value: Name: "Document Relation" Value: "0" for one-way document relations "1" for two-way document relations (Default)
WorkSite Server Administrator’s guide
• • • 365 • • •
Appendix C: Server Configuration Options
E-mail Duplicate Detection The WorkSite Communication Server and FileSite search for existing duplicate e-mail messages before importing a new e-mail message. By default, the scope of the search is restricted to the selected target folder or workspace. If an e-mail message is saved at the library level, then no search is performed. This behavior can be changed, so that a search is performed across the entire target library to detect duplicate e-mail messages before saving them to WorkSite. This option is configured on the WorkSite Server machine, not on the WorkSite Communication Server. To configure the WorkSite Communication Server and FileSite to search the entire target library, rather than just within the target folder or workspace, for duplicate e-mail messages: In the following key in the registry on the WorkSite Server machine (not on the WorkSite Communication Server): HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\
Set the following DWORD value: Name: "Duplicate Detection Type" Value: "0" - Search within target folder or workspace (Default) "1" - Search across entire target library
Enable/Disable User Edit of the Folder E-mail Address Field By default, users with full access to a WorkSite document folder can edit the folder's E-mail Address. The following configuration option, however, can be used to restrict access to folder e-mail addresses to NRTADMIN users. The e-mail address is viewable but not editable. To configure this option: In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\
Set the following DWORD value: Name: "DisableEditingOfFolderE-mailField" Value: 0 = Users with full access to folder can set/edit e-mail address 1 = Only NRTADMIN users can set/edit folder e-mail addresses
• • • 366 • • •
WorkSite Server Administrator’s guide
Unicast or Multicast Clustering Transport Options
Unicast or Multicast Clustering Transport Options When a client sends a request to a DMS Server or Cluster, the communication goes to all IP addresses at the UDP port specified, 2637. You can utilize either unicast or multicast communications between the client and the DMS Server or Cluster. The default option is multicast. To designate unicast or multicast communications on the WorkSite DMS Server or Cluster: In the following keys in the registry on the WorkSite Server or on each server in the WorkSite Server Cluster: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imFmaSvc
Set the following DWORD value: Name: "Clustering Transport" Value: 0 = multicast 1 = unicast
NOTE
If you are not using the default, you must also set these options on each client machine. See the WorkSite Desktop Client Customization Guide for details.
Default Minutes Between Synchronization Passes The default number of minutes between synchronization passes is 60 minutes. This option allows you to change the number of minutes between passes. To change the number of minutes between synchronization passes: In the following key in the registry: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDsSyncSvc
Create the following DWORD value:
WorkSite Server Administrator’s guide
• • • 367 • • •
Appendix C: Server Configuration Options
Name: "Cycle Minutes" Value: Number of minutes you want to elapse between synchronization passes
Kerberos Authentication on Trusted Login This section describes how to configure the WorkSite Server to support trusted login with Kerberos authentication. The configuration steps for Kerberos authentication are determined by the account used to start the WorkSite services:
Local system account
Domain user account (Windows Server 2003 or Windows 2000 Server)
Version Requirements Kerberos authentication on trusted login is supported for the following software versions and configurations:
Windows Active Directory-based Kerberos server implementations (Other configurations are not supported, such as Netware, Unix, and Windows NTLM.)
FileSite, DeskSite, OffSite, and any custom application based on WorkSite SDK must be version 8.2 SP1.
WorkSite Web must be version 8.2 SP1 Patch 1.
Using a Local System Account Running the WorkSite Server under a local system account does not have configuration dependencies for trusted login with Kerberos authentication. The computer account must be trusted to act as a delegate. (This setting is the default setting for computer system accounts.) NOTE
When the local system account is used to start the WorkSite Server service, the File Server Setup Properties must be configured with a user account that can access the document file share. 1. In the WorkSite Service Manager, select the WorkSite Server service. Open the Startup Properties dialog. 2. Select Local system account. 3. Start the WorkSite Server service. Confirm that the DmsLog.txt file does not contain any errors, such as “DsServerRegisterSpn failed; error = 0x54b.” • • • 368 • • •
WorkSite Server Administrator’s guide
Kerberos Authentication on Trusted Login
Using a Domain User Account The type of Windows Active Directory domain used by your system determines the steps required to configure Kerberos authentication. This section includes instructions for the following domains:
“Using a Domain User Account on Windows 2000 Server Domain” on page 369
“Using a Domain User Account on a Windows Server 2003 Domain” on page 370
Using a Domain User Account on Windows 2000 Server Domain Perform these steps using a Domain Administrator account. You will need the Windows Resource Kit and Support Tools to complete these steps. 1. Add the WorkSite Service Account to the Local Administrators Group on the WorkSite Server. 2. Add the WorkSite Service Account to the Act as a part of Operating System security policy on the WorkSite Server through the Local Security Policy snap-in. 3. From the Active Directory Console, select the WorkSite Service Account, and open the Properties dialog. 4. On the Account tab, confirm that the Account is sensitive and cannot be delegated checkbox is NOT selected. If it is selected, clear the check box, and click OK. 5. From the Active Directory Console, select the WorkSite Service Account, and open the Properties dialog. 6. On the Account tab, select the Account is trusted for delegation check box, and click OK. Complete Steps 7 and 8 to automatically create the SPNs. Otherwise, proceed to Step 9 to create the SPNs manually. 7. From the Active Directory Console, select the WorkSite Service Account, and open the Properties dialog. 8. On the Security tab, add the Worksite Service Account. Confirm that the Write Public Information checkbox is selected. If it is empty, select the check box, and click OK. NOTE
The previous step may require the use of ADSI Edit available in the Windows Resource Kit and Support Tools. 9. Create the required SPNs by running the following commands against a Local Domain Controller: setspn.exe -a imDmsSvc/WorkSiteServerName WorkSiteServiceAccount
WorkSite Server Administrator’s guide
• • • 369 • • •
Appendix C: Server Configuration Options
setspn.exe -a imDmsSvc/WorkSiteServerFQDN WorkSiteServiceAccount
where imDmsSvc is the WorkSite Server service name (Service Type/Service Class). WorkSiteServiceAccount is the account used to start the WorkSite Server service. WorkSiteServerName is the WorkSite Server name. WorkSiteServerFQDN is the WorkSite Server fully qualified domain name.
Example: setspn.exe -a imDmsSvc/iwovdms Interwoven\wsadmin setspn.exe -a imDmsSvc/iwovdms.Interwoven.com Interwoven\wsadmin
10. Start the WorkSite Server service. Confirm that the DmsLog.txt file does not contain any errors, such as “DsServerRegisterSpn failed; error = 0x54b.”
Using a Domain User Account on a Windows Server 2003 Domain Perform these steps using a Domain Administrator account. You will need the Windows Resource Kit and Support Tools to complete these steps. 1. Add the WorkSite Service Account to the Local Administrators Group on the WorkSite Server. 2. Add the WorkSite Service Account to the Act as a part of Operating System security policy on the WorkSite Server through the Local Security Policy snap-in. 3. From the Active Directory Console, select the WorkSite Service Account, and open the Properties dialog. 4. On the Account tab, confirm that the Account is sensitive and cannot be delegated checkbox is NOT selected. If it is selected, clear the check box, and click OK. Complete Steps 5 and 6 to automatically create the SPNs. Otherwise, proceed to Step 7 to create the SPNs manually. 5. From the Active Directory Console, select the WorkSite Service Account and open the Properties dialog. 6. On the Security tab, add the WorkSite Service Account. Confirm that the Write Public Information checkbox is selected. If it is empty, select the check box, and click OK. NOTE
The previous step may require the use of ADSI Edit available in the Windows Resource Kit and Support Tools. 7. Create the required SPNs by running the following commands against a Local Domain Controller: setspn.exe -a imDmsSvc/WorkSiteServerName WorkSiteServiceAccount • • • 370 • • •
WorkSite Server Administrator’s guide
Kerberos Authentication on Trusted Login
setspn.exe -a imDmsSvc/WorkSiteServerFQDN WorkSiteServiceAccount
where imDmsSvc is the WorkSite Server service name (Service Type/Service Class). WorkSiteServiceAccount is the account used to start the WorkSite Server service. WorkSiteServerName is the WorkSite Server name. WorkSiteServerFQDN is the WorkSite Server fully qualified domain name.
Example: setspn.exe -a imDmsSvc/iwovdms Interwoven\wsadmin setspn.exe -a imDmsSvc/iwovdms.Interwoven.com Interwoven\wsadmin
8. From the Active Directory Console, select the Worksite Service Account, and open the Properties dialog. 9. On the Delegation tab, select the options Trust this user for delegation to specified services only, and Use Kerberos only. NOTE
In Microsoft Windows 2003, the Delegation tab is visible only when the Microsoft Windows Domain is at Windows 2003 level. 10. Complete the following steps to add the WorkSite Server Service: a. On the Delegation tab, click the Add button. The Add Services dialog box appears. The available services list is initially empty. The following steps describe how to add services. b. On the Add Services dialog box, click the User or Computers button to add services. c. On Active Directory Object Picker box, type the name of the WorkSite Service Account. Click the Check Names button, and then click OK. d. On the Add Services dialog box, select the WorkSite Server Service for the appropriate WorkSite Server(s), and click OK. 11. Start the WorkSite Server service. Confirm that the DmsLog.txt file does not contain any errors, such as “DsServerRegisterSpn failed; error = 0x54b.”
Enforcing Kerberos Authentication on Trusted Login By default, the Enforce Kerberos Authentication registry key on the WorkSite Server is disabled. This setting allows older clients to connect to the upgraded server, and to use trusted login without Kerberos authentication. It also permits a phased deployment, since older clients configured for trusted login can continue to connect to the server until all client updates are deployed. The Enforce Kerberos Authentication registry key should only be enabled after all clients that connect to the WorkSite Server have been updated to version 8.2 SP1. With registry
WorkSite Server Administrator’s guide
• • • 371 • • •
Appendix C: Server Configuration Options
key enabled, clients prior to 8.2 SP1 are unable to connect to the WorkSite Server using trusted login. These older clients can connect to the server using explicit login. NOTE
Configuration of a client-side registry key is required when the WorkSite Server uses Kerberos authentication. On the 8.2 SP1 clients, the registry key called Authentication Method must be set to Kerberos. When this key is set to the alternative mode called Classic, the 8.2 SP1 clients will be prevented from connecting to a WorkSite Server configured only for Kerberos authentication. See the WorkSite Desktop Client Customization Guide, or the DeskSite, FileSite, and OffSite Release Notes 8.2 Service Pack 1 for information about the Authentication Method registry key. In the following location on the WorkSite Server machine: [HKEY_LOCAL_MACHINE\SOFTWARE\Interwoven\WorkSite\imDmsSvc]
Set the following DWORD value (hexadecimal): Name: "Enforce Kerberos Authentication" Value: 0x01 - Enforces the use of Kerberos authentication 0x00 - Enables Trusted Login for older clients (default) NOTE
On the WorkSite Server Properties dialog, you must also select Accept Trusted Authentication.
Support for Unknown File Types In some firms, documents of a well known file type (for example, Excel) are given a unique extension (for example, .xyz) which is mapped to a custom application. Previously, WorkSite would identify the document on import as an Excel file type and drop the unique file extension .xyz. Then during export or checkout, the document would be associated with the Excel application instead of the custom application, and it would be opened in Excel. You can now configure WorkSite Server to store file extensions of all documents as an additional property on the document. This ensures that the original file extensions of documents are retained in the WorkSite system. When opening, checking out, exporting, or synchronizing the document, the stored file extension is retrieved and used to associate the document with the correct application. File extensions are NOT stored in the case of E-mail types, which are determined by an existing registry key called E-mail Types (String).
• • • 372 • • •
WorkSite Server Administrator’s guide
Support for Unknown File Types
To enable support for unknown file types, you must store information in the following keys in the registry on the server machine. CAUTION
Autonomy is not responsible for loss of data due to improper use of the Registry Editor or failure to backup the registry.
Retain Extension for ANSI Types Registry Key When this option is enabled through the registry, the application extension is preserved for all unknown file types that WorkSite detects as ANSI. These documents are saved as ANSI document type. The original extension is preserved and can be mapped to the appropriate application. This allows users to open the documents in the proper application. From a client perspective, requests for the document extension return the original document's extension if a document is of type ANSI and the extension is non-empty. For example, when WorkSite encounters an ANSI file with the extension .xyz, it will create a new document type for any unknown files and assign a doc type alias based on the file extension and a unique identifier (for example XYZ4001). As a best practice, you should populate the document type and application setup tables (using DBAdmin) manually for any custom applications in your organization. This enables you to specify the properties for each document type that best suits your organization’s needs, as opposed to having WorkSite automatically assign an alias and other properties. This option can be used without adding unacceptable overhead if the number of documents with unknown file types is relatively small. Enabling Retain Extension for ANSI Types is recommended for firms in the legal vertical and other firms that do not use a large number of file types that are not recognized by WorkSite. In the following location in the registry on the server: [HKEY_LOCAL_MACHINE\SOFTWARE\Interwoven\WorkSite\imDmsSvc]
Set the following DWORD value (hexadecimal): Name:“Retain extension for ANSI types” Value:0x01 – Enables retention in the database of extensions of ANSI types 0x00 – Disables retention in the database of extensions of ANSI types (default)
WorkSite Server Administrator’s guide
• • • 373 • • •
Appendix C: Server Configuration Options
Retain Extension for Non-E-mail Types Registry Key NOTE
This key is only effective if the Retain extension for ANSI types key is set. This option applies to all non-E-mail document types. When this option is enabled, the application extension is preserved for all unknown file types that are not e-mail. When a user imports a file with an extension which WorkSite Server does not have listed in its document type table, a new document type is created for this file type. During Open, Export, or Checkout of this document, the original extension is preserved. For example, importing an Excel file named filename.xyz will set the type to Excel and the file extension to xyz, and the file will open in the custom application. When this setting is enabled, WorkSite will automatically create a new document type for any unknown files and assign a doc type alias based on the file extension and a unique identifier (for example XYZ4001). As a best practice, you should populate the document type and application setup tables (using DBAdmin) manually for any custom applications in your organization. This enables you to specify the properties for each document type that best suits your organization’s needs, as opposed to having WorkSite automatically assign the alias and other properties. In the following location in the registry on the server: [HKEY_LOCAL_MACHINE\SOFTWARE\Interwoven\WorkSite\imDmsSvc]
Set the following DWORD value (hexadecimal): Name:"Retain extension for non-E-mail types" Value:0x01 – Enables retention in the database of all non-E-mail extensions 0x00 – Disables retention in the database of all non-E-mail extensions (default) The following table describes whether extensions will be retained when the registry keys are enabled or disabled. Please note that the E-mail Types registry key is always required. WorkSite will save extensions only for non-E-mail document types. Table 46 Comparison of two types of support for unknown file types Retain Extension
• • • 374 • • •
Retain ANSI Key
Retain Non-E-mail Key
ANSI Types
Other (non-E-mail) Types
Off
Off
No
No
Off
Off
No
No
On
On
Yes
Yes
On
Off
Yes
No
WorkSite Server Administrator’s guide
Server Side Email Filing
As indicated by the highlighted row, when both registry keys are enabled the extension will be saved for all non-E-mail document types.
Server Side Email Filing This key indicates whether server-side filing functionality is enabled. This key must be set on the WorkSite Server. It is set to False by default. This key must be set to true to indicate to clients that server-side filing functionality is available, in the following key in the registry: Server side setting-In the following key in the registry on the WorkSite Server: HKEY_LOCAL_MACHINE\Software\Interwoven\WorkSite\imDmsSvc\
Set the following string value: Name: "Server Side Email Filing" Value: "Y" There is also a client-side key that allows for a given user to opt-out of server-side filing, when it is enabled. For more information on this key, see chapter 4 of the E-mail Management for Outlook Installation and User’s Guide.
Allow Folder Creation in Public Workspaces This registry setting impacts workspace security in relation to folder manipulation in workspaces. The Allow folder creation in public workspaces registry key allows users to create folders in public Workspaces. Normally this can only be done by users with full access to the workspace (through ACL, ownership, or through being supervisor). In the following location in the registry on the server: HKLM\Software\Interwoven\WorkSite\imDmsSvc\Databases\[DatabaseName]
Create the following string value: Name: "Allow folder creation in public workspaces" Value: "Y" This registry key allows the user to create folders directly under public Workspaces, only if :
There isn’t any non-security related feature preventing a user from creating a folder under a workspace, AND
WorkSite Server Administrator’s guide
• • • 375 • • •
Appendix C: Server Configuration Options
• • • 376 • • •
There are no limiting ACLs for the user granting him less that read / write access, AND
The workspace has public default security.
WorkSite Server Administrator’s guide
Index
A Active Users 216 Adding Database Users 67 Adding LDAP Users 75 App Setup 125 Application Integration App Setup table 125 Archived Documents Restoring 248 Archiving Documents 240 Autodetect document types 166
C Class 139 Client/Matter 151 clload.exe 333 Cluster Manager 279 How it works 279 Cluster Manager Startup dialog 282 Command Line Loading Utility 333 Configuring the WorkSite Server with Caching 321, 332 Custom classes 147 Custom Fields 173 Custom Table Loading Utility 333 Custom3 through Custom12 tables 148
D Database Administration Program 45 Adding Users 67
WorkSite Server Administrator’s guide
App Setup 125 Client/Matter tables 151 Creating user groups 85 Database Options 53 Document class 139 Error messages 63 Find 61 Groups 84 Lookup Bar 62 PC Locations 144 Practice/subpractice tables 151 Registering Databases 51 Roles 110 Searching in the database tables 62 Setting Max Lookup Entries 63 Subclass 139 Synchronizing user information 83 Toolbar Activitating/Deactivating 49 Understanding Information Tables 49 User Table 65 Database groups 84 Database Migration Tool Preferred 329 Database Users Adding 67 Synchronizing 83 Default role 110 Deleting Documents 227 Displaying Active Users 216 Document Archiving 240 Document Class 139 Document File Servers 103 Adding 103 Document Security Changing while migrating 235 Document Types Default 131 Documents • • • 377 • • •
Index
Archiving 240 Deleting 227 Expired 242 Marking for archiving 242 Moving Between Databases 229 Reassigning by author/operator 239 Releasing (Unlocking) 227 Restoring (from archive) 248 Searching for 222 Dynamic profile information 168
E errata 22 Error messages in the Database Administration Program 63 Exclude and Include Lists 174 Expired Documents 242 Extensions Specifying in profile fields 170
Log Files WorkSite Server Service 343 Lookup Bar 62 Lookup Entries, Maximum 63
M Marking Documents for Archiving 242 Maximum Lookup Entries 63 Migrating Documents Between Databases 229 Migration Tool Database 329 Moving Documents Between Databases 229
N NIC numbers 144 NRTADMIN Group 85
F
O
Filenames Specifying in profile fields 170 Find Searching in Database Administration Program 61
Output window 212
G Groups 84 Adding to database 85
I Import Profile Template Creating 163 Loading 176 Include and Exclude Lists 174
L LDAP Search Filter 80 LDAP Users Adding 75 • • • 378 • • •
P PC Locations 144 Practice/Subpractice 151 Preferred Database Migration Performing 332 Preferred Database Migration Tool How it works 330 Preferred Databases 100 Primary Applications 130 Profile field commands 168 Profiles Combining commands 169 Default command 171 Filenames and extensions 170 Subdirectories 171
R Reassigning documents
WorkSite Server Administrator’s guide
By author/operator 239 Registering Databases Database Administration Program 51 Releasing (Unlocking) Documents 227 Relocating Documents Between Databases 229 Rename Function 121 Restoring archived documents 248 Roles 110 Default role 110 Membership 115 Rules Engine Server Setup 258
U
S
Wildcard characters in Monitor program 221 WorkSite Advanced Server configuring 325 WorkSite Dialog Editor 181 WorkSite Monitor Desktop 208 WorkSite Server Displaying active users 216 WorkSite Server Service Configuring Connections to File Servers 41 WorkSite Service Manager Finding Servers 31 Unregistering Servers 32
Search Results in Monitor program 214 Searching for busy or checked out documents 222 Searching for Documents in Monitor program 222 Searching in the database tables 62 Server Workspace window 210 Set Max Lookup Entries 63 Subclass 139 Subclassifications 147 Viewing tables of 158 Subdirectories Specifying in profile fields 171 Synchronizing Database users 83
Understanding Information Tables 49 Unlocking (Releasing) Documents 227 User Table Database users 65 User Table Loading Utility 338
V Viewing the User History 57
W
T Table Loading Utility 333 Toolbar Activitating/Deactivating Database Administration Program 49 Database Administration Program 49 Trusted Logon 36
WorkSite Server Administrator’s guide
• • • 379 • • •
Index
• • • 380 • • •
WorkSite Server Administrator’s guide
