iManage WorkSite
Server Administrator’s guide
Version 8.5
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]
Contents
About This Book
19
Intended Audience. . . 19
Notation Conventions . . . 19
Manual Organization . . . 20
Additional Product Documentation . . . 21
Revision History . . . 21
Documentation Updates . . . 22
Chapter 1:
Introduction
23
Components of the WorkSite Server . . . 23WorkSite Library . . . 24
WorkSite Server Services . . . 24
WorkSite Indexer . . . 24
Client Applications. . . 25
Administrative Tools or Utilities . . . 25
Chapter 2:
Using the WorkSite Service Manager
27
Overview . . . 27About WorkSite Service Manager . . . 27
WorkSite Services . . . 28
Getting Started with WorkSite Service Manager . . . 28
Understanding the Table View . . . 29
Using the Toolbar . . . 30
Finding WorkSite Servers. . . 30
Registering and Unregistering Servers . . . 31
Registering a WorkSite Server . . . 31
Automatic Login. . . 32
Unregistering a Server . . . 32
Starting and Stopping a Service. . . 33
Configure Startup Properties for the Service . . . 33
Configuring WorkSite Server Service Properties. . . 34
Configuring WorkSite Server Service Database Properties . . . 38
Configure Connections from WorkSite Server to File Servers . . . 41
Troubleshooting Startup Errors . . . 43
Chapter 3:
Using the Database Administration Tool
45
Overview . . . 45
About Database Administration. . . 45
Starting and Stopping the DBAdmin . . . 46
DBAdmin Desktop . . . 46
Tree Frame . . . 46
Table Frame . . . 47
Searching the Table Frame . . . 48
Right-click Menus . . . 48
Toolbar . . . 49
Information Tables and Subtables. . . 49
Registering WorkSite Databases . . . 51
Automatic Login Feature. . . 53
Login Failures and the Reconnect button . . . 53
Configuring WorkSite Database Options. . . 53
Viewing the User History . . . 57
Database Information . . . 57
Synchronization Options . . . 58
Common Functions . . . 59
Adding Items to an Information Table . . . 60
Editing Items in an Information Table . . . 60
Searching in a Table or List View. . . 61
Using the Lookup Bar . . . 62
Setting Max Lookup Entries. . . 63
Error Messages . . . 63
Chapter 4:
Administering Users, Groups, and Security
65
Overview . . . 65Managing Users. . . 65
Purpose of the User Table. . . 66
Adding Users . . . 67
Adding Virtual Users. . . 67
Adding Microsoft Windows OS Domain Users. . . 69
Adding Novell Bindery Users . . . 71
Adding Novell NDS Users . . . 73
Adding LDAP Directory Users . . . 75
Changing the Default Password . . . 82
Editing User Information . . . 82
Synchronize Users . . . 83
Managing Groups . . . 84
NRTADMIN Group . . . 85
Adding Virtual Groups . . . 85
Adding Microsoft Windows Domain Groups . . . 87
Adding a Novell Bindery Group. . . 88
Adding Novell NDS Groups. . . 90
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
125
Overview . . . 125Defining Application Formats . . . 125
Customizing the App Setup List. . . 126
Adding an Application Setup Entry. . . 126
Editing an Existing Application Record . . . 127
Mapping Multiple Document Types to the Same Application. . . 130
Managing Document Types . . . 131
Default Document Types . . . 131
Autodetect Document Types. . . 132
NonAutodetect Document Types . . . 133
File Type Mapping . . . 133
Mapping WorkSite Document Types to File Types . . . 134
Adding a Document Type to a Database . . . 136
Editing Document Types . . . 138
Managing Document Class and Subclass . . . 139
Document Classes . . . 139
Adding a New Document Class. . . 140
Editing Document Class Information . . . 141
Deleting a Document Class . . . 142
Document Subclasses . . . 143
Adding a Subclass . . . 143
Editing Subclass Settings . . . 144
Managing PC Locations . . . 144
Adding a PC Location . . . 145
Deleting a PC Location . . . 145
Importing PC Locations from an ANSI Text File . . . 145
Managing Custom Tables and Subtables . . . 147
Common Usage for Custom Tables . . . 148
Administering Custom3 to Custom12 Tables . . . 148
Adding Entries to Custom3 to 12 Tables. . . 149
Modifying Entries in Custom3 to Custom12 Tables . . . 150
Deleting Entries in Custom3 to Custom12 Tables . . . 150
Modifying the Custom3 to Custom12 Table Headings . . . 150
Importing Custom3 to Custom12 Table Entries . . . 150
Administering Custom1/Custom2 and Custom29/Custom30 Tables . . . 151
Introduction to Custom1/Custom2 Tables . . . 151
Adding and Editing Custom1 and Custom29 Items. . . 153
Deleting a Custom1 or Custom29 Item . . . 153
Adding and Editing Custom2 and Custom30 items . . . 153
Importing Custom1/Custom2 and Custom29/Custom30 Table Entries . . . . 155
Using the Subtable Window . . . 158
Chapter 6:
Using the Document Import Tool
159
Overview . . . 159About Document Import . . . 159
Features and Options . . . 160
Document Import Process . . . 160
Starting and Stopping the Document Import Tool . . . 161
Log into a WorkSite Server . . . 162
Logging Off from a WorkSite Server . . . 163
Creating a New Profile Template. . . 163
Selecting a Document Type . . . 165
Autodetect and Nonautodetect Document Types. . . 166
Using Selection Boxes. . . 167
Dynamic Profile Information . . . 168
Where to Use Dynamic Profile Field Commands . . . 169
Combining Profile Commands . . . 169
Contents
Subdirectory and Subdirectory Substring Extraction. . . 171
Default Profile Entry Command . . . 171
Assigning Security . . . 172
Additional Custom Fields . . . 172
Types of Custom Fields. . . 173
Creating an Exclude and Include List. . . 174
Saving a Template . . . 176
Deleting a Template . . . 176
Loading an Import Template . . . 176
Importing Documents . . . 177
Viewing Log Files . . . 178
Purging the Log File . . . 180
Error Messages . . . 180
Chapter 7:
Using the Dialog Editor Tool
181
Overview . . . 181About Dialog Editor . . . 181
Getting Started. . . 182
Logging into a Server . . . 183
Logging Off a Server . . . 183
Selecting or Deselecting Database(s) . . . 184
Dialog Editor Desktop . . . 184
Dialog Editor Left Pane . . . 185
File Toolbar . . . 185 Align Toolbar . . . 186 Elements Toolbar . . . 186 Captions. . . 186 Form Management. . . 187 Opening a Form . . . 188 Exporting Forms. . . 188 Importing Forms. . . 188
Reloading Forms from the Database . . . 189
Saving a Form . . . 190
Deleting a Form . . . 190
Closing a Form . . . 190
Form Design . . . 191
Controls . . . 192
Adding Controls to a Form . . . 192
Adding Controls . . . 194
Adding a Canvas Control . . . 195
Adding a Logo Control . . . 197
Adding the External User Control . . . 197
Required Controls. . . 198
Control-Specific Dependencies . . . 199
Aligning Spacing and Resizing Controls . . . 199
Moving and Deleting Controls . . . 201
Importing and Exporting Controls . . . 201
Importing Controls . . . 201
Exporting Controls . . . 201
Testing and Analyzing a Form Design . . . 202
Setting Tab Order . . . 202
Chapter 8:
Using the Monitor Tool
205
Overview . . . 205About WorkSite Monitor . . . 205
Starting WorkSite Monitor. . . 206
Registering and Unregistering WorkSite Servers. . . 206
The WorkSite Monitor Desktop. . . 208
Keyboard Shortcuts and Toolbar Buttons . . . 209
Server WorkSpace Window . . . 210
Icons in the Server WorkSpace Window . . . 211
Information Window . . . 212
Results WorkSpaces . . . 213
Statistics Tab . . . 213
Document Search Results Tab. . . 214
Document History Search Results Tab . . . 215
Active Users Tab . . . 216
Results Tab Right-click Menu Options . . . 216
Setting Search Results Display Options . . . 217
Using Support Dialogs . . . 220
Selection Dialog Box (Lookup Tables) . . . 221
Setup Additional Custom Fields Dialog Box. . . 221
Setting Up Custom Fields . . . 221
Using WorkSite Monitor . . . 222
Searching for Documents . . . 222
Searching the Document History . . . 224
Deleting Entries in the Document History Table. . . 226
Redisplaying Search Parameters . . . 226
Printing Reports . . . 226
Setting Printer Options . . . 226
Print Preview . . . 226
Unlocking Documents . . . 227
Deleting Documents . . . 227
Relocating Documents between Databases. . . 229
Relocating Documents. . . 231
Changing Document Security . . . 235
Bulk Profile Edit. . . 237
Reassigning Documents by Author or Operator . . . 239
Document Archiving . . . 240
Marking Documents for Archiving . . . 241
Contents
Viewing Marked Documents . . . 246
Archiving. . . 246
Restoring Archived Documents . . . 248
Restoring Archived Documents from User Requests . . . 249
Restoring Archived Documents from Archive Sets. . . 250
Set Priority . . . 254
Create a Custom Toolbar . . . 254
Log Files. . . 255
Using the Find Dialog . . . 255
Chapter 9:
Configuring the Rules Engine
257
Overview . . . 257Requirements. . . 257
Preparing for the Rules Engine Server Installation . . . 258
Installing Rules Engine . . . 258
Configuring Rules Engine Service Properties . . . 261
Configuring Rules Engine Database Properties . . . 261
Configuring Rules Engine Service File Server Properties . . . 262
Configuring Rules Engine Service Properties . . . 264
Starting the Rules Engine Service . . . 265
Test SMTP Connectivity . . . 265
Configuring SMTP Service to Allow Forwarding to Remote Domains. . . 267
Associating Events with a Rule . . . 270
Setting Up an E-mail Host. . . 271
Chapter 10: WorkSite Cluster Manager Service
273
Overview . . . 273Introduction to Clustering . . . 273
Using Server Clustering . . . 274
Advantages of Clustering . . . 274
How Does Clustering Work? . . . 275
Features of Clustering . . . 275
Automatic Load Balancing . . . 276
Automatic Client Redirection . . . 277
Setting up a WorkSite Server Cluster . . . 278
Prerequisites . . . 278
Phase 1 . . . 278
Phase 2 . . . 279
Phase 3 . . . 279
Phase 4 . . . 279
Using the Cluster Manager . . . 279
UDP Port Requirements for Clustering Transport . . . 280
UDP Reply Port . . . 280
Installing Cluster Manager Service . . . 281
Configuring WorkSite Server Service . . . 283
Database Properties . . . 285
WorkSite Server Cluster Example . . . 286
Chapter 11:
Directory Service Synchronization Service
287
Overview . . . 287How Directory Service Synchronization Service Works . . . 288
Requirements . . . 288
Installing DSS Service. . . 289
Configuring the DSS Service. . . 291
Setting the DSS Schedule . . . 291
Creating Connections to DSS Services. . . 292
Specifying External Users and Groups . . . 297
Mapping Directory Service Attributes to WorkSite. . . 298
Running the DSS Service . . . 299
Chapter 12: Symantec Enterprise Vault Integration
301
About Symantec Enterprise Vault . . . 301SEV Integration for WorkSite Server . . . 301
Supported Versions and Packaging . . . 302
Upgrading the Database Schema . . . 302
Test the DbUpgrade Utility on a Database Copy . . . 303
Using the DbUpgrade Utility . . . 304
Installing Vault Admin Console. . . 304
Installing Microsoft Exchange Server MAPI Client and CDO . . . 305
User Account Information . . . 305
Adding User Account to Windows Registry . . . 305
Integrating Symantec Enterprise Vault with WorkSite Server . . . 308
Understanding DMS Log File Information . . . 313
EMAIL_ATTRS Table and Status Codes . . . 313
Fatal and Non-Fatal SEV Errors. . . 314
Heartbeat Statistics . . . 314
Chapter 13: WorkSite Server with Caching
317
Overview . . . 317About WorkSite Server with Caching . . . 317
Caching Server Technology. . . 318
Cache Fileserver . . . 319
Preloading the Cache . . . 320
Configuring the WorkSite Server for File Caching. . . 321
Purging the Cache Fileserver . . . 323
Overview of Proxying Capabilities . . . 323
Setting up Library Connections . . . 325
Chapter 14: Tools and Utilities
329
Overview . . . 329Migrating Users to a Different Database . . . 329
Contents
Working of User’s Preferred Database Migration Tool . . . 330
Stage 1: Initialization . . . 330
Stage 2: Copy . . . 331
Stage 3: Finalization . . . 331
Stage 4: Deletion . . . 332
Performing a Preferred Database Migration . . . 332
Populating Custom Tables . . . 333
Prerequisites . . . 333
The clload Command . . . 333
Required Format for the ANSI Text File . . . 334
Command Line Parameters. . . 334
Skipping the Description Field . . . 337
Loading Multiple Child Table Entries . . . 337
Examples of Valid Command Line Entries . . . 338
Populating User Tables . . . 338
Prerequisites . . . 339
The userload command. . . 339
Required Format for the ANSI Text File . . . 339
Command Line Parameters. . . 339
Appendix A: Reading the WorkSite Server Log File
343
Overview . . . 343Abbreviations . . . 343
Common DMSLog.txt File Entries . . . 344
Appendix B: Database Schema
349
Overview . . . 349Appendix C: Server Configuration Options
355
Allowing Description Fulltext Search . . . 356OCR-TIFF Replacement . . . 357
UTC Date Storage . . . 357
Search Results Sorting. . . 358
Restrict Data Sizes. . . 360
Case Insensitive Searches in Oracle Databases . . . 361
Version Editing . . . 361
Retain Only Latest Version on Worklist . . . 362
Ignore Disabled Groups. . . 363
Immutable E-mail . . . 363
WorkList Filtering . . . 364
Pessimistic Security. . . 364
One-Way or Two-Way Document Relations . . . 365
E-mail Duplicate Detection . . . 366
Enable/Disable User Edit of the Folder E-mail Address Field. . . 366
Unicast or Multicast Clustering Transport Options . . . 367
Default Minutes Between Synchronization Passes . . . 367
Using a Local System Account. . . 368
Using a Domain User Account . . . 369
Using a Domain User Account on Windows 2000 Server Domain . . . 369
Using a Domain User Account on a Windows Server 2003 Domain. . . 370
Enforcing Kerberos Authentication on Trusted Login . . . 371
Support for Unknown File Types. . . 372
Retain Extension for ANSI Types Registry Key . . . 373
Retain Extension for Non-E-mail Types Registry Key . . . 374
Server Side Email Filing . . . 375
Allow Folder Creation in Public Workspaces . . . 375
•
Figures
Figure 1 Components of the WorkSite Server ... 23
Figure 2 WorkSite Service Manager with Registered Servers ... 29
Figure 3 WorkSite Servers Search status box ... 31
Figure 4 Select Server dialog box ... 32
Figure 5 WorkSite Server Startup Dialog ... 33
Figure 6 WorkSite Server Properties Dialog ... 35
Figure 7 WorkSite Server Database Setup Dialog... 38
Figure 8 Database Properties Dialog ... 39
Figure 9 Advanced Properties dialog box ... 40
Figure 10 File Server Connections Dialog, Windows tab... 42
Figure 11 File Server Connections Dialog, NetWare Tab ... 43
Figure 12 Configuration Error Message ... 43
Figure 13 About WorkSite Service Manager Dialog... 44
Figure 14 DBAdmin Main Program Window ... 47
Figure 15 Right-click menu for the table frame ... 48
Figure 16 Floating toolbar ... 49
Figure 17 Register/Unregister Databases Dialog... 52
Figure 18 Set Database Options Dialog... 54
Figure 19 Information window for the Database ... 58
Figure 20 Synchronization Options dialog box... 59
Figure 21 Edit Jurisdiction Dialog... 61
Figure 22 Find Dialog... 61
Figure 23 Lookup Bar in DBAdmin... 62
Figure 24 Edit Max Lookup Entries Dialog... 63
Figure 25 Sample error message... 64
Figure 26 User accounts and their function ... 66
Figure 27 Add New Users dialog box, Virtual User tab... 68
Figure 28 Add New Users Dialog, Microsoft Windows OS Domain Users Tab ... 70
Figure 29 Add New Users dialog box, Novell Bindery Users tab ... 72
Figure 30 Add New Users dialog box, Novell NDS Users tab... 74
Figure 31 LDAP Directory Users Tab... 76
Figure 32 LDAP Authentication Dialog... 77
Figure 33 LDAP Attribute Mapping (User) Dialog ... 78
Figure 34 Add New Users Dialog, LDAP Directory Users Tab ... 79
Figure 35 Too many directory objects warning ... 80
Figure 36 LDAP Directory Search Filter... 81
Figure 37 Edit User Information Dialog ... 83
Figure 39 Add New Groups Dialog, Microsoft Windows OS Domain Groups Tab... 88
Figure 40 Add New Groups Dialog, Novell Bindery Groups Tab ... 89
Figure 41 Add New Groups Dialog, Novell NDS Groups Tab... 91
Figure 42 LDAP Directory Groups Tab ... 93
Figure 43 LDAP Authentication Dialog... 94
Figure 44 LDAP Attribute Mapping (Group) dialog box... 95
Figure 45 Add New Groups Dialog, LDAP Directory Groups Tab... 96
Figure 46 Too many directory objects warning ... 97
Figure 47 LDAP Directory Groups, LDAP Directory Search Filter ... 97
Figure 48 Group Management Dialog... 99
Figure 49 Add Databases Dialog ... 101
Figure 50 Preferred Database Management Dialog ... 102
Figure 51 Add File Servers Wizard, Select File Server Container ... 104
Figure 52 Add File Servers Wizard, File Server Name ... 105
Figure 53 File Server Assignment dialog box ... 106
Figure 54 Role Setup Dialog, Privileges Tab ... 111
Figure 55 Role Setup Dialog, Edit/Create Profile Tab... 114
Figure 56 Role Setup dialog box, Membership Assignment tab ... 116
Figure 57 Role Management Dialog ... 117
Figure 58 Add Security Templates Dialog... 119
Figure 59 Security Template Assignment Dialog ... 120
Figure 60 Add App Setup Entry dialog box ... 127
Figure 61 Document Type Mapping Management dialog box ... 135
Figure 62 Add Type Dialog ... 136
Figure 63 Add Class dialog box ... 140
Figure 64 The Add New Node dialog box ... 145
Figure 65 The Import From File dialog box ... 146
Figure 66 Custom1-Custom 2 tables in parent-child relationships... 152
Figure 67 Add New Item in Custom2 Dialog ... 154
Figure 68 Edit Custom2 dialog box ... 154
Figure 69 Import from File (Custom1 and Custom2) dialog box ... 156
Figure 70 Custom2 subtable window ... 158
Figure 71 WorkSite Document Import... 161
Figure 72 Connect Servers ... 162
Figure 73 Document Import Profile Template dialog box... 164
Figure 74 Select Type dialog box... 167
Figure 75 Setup Additional Custom Fields... 173
Figure 76 Include and Exclude File List dialog box... 175
Figure 77 Import Documents dialog box ... 177
Figure 78 Log File, Sample output ... 179
Figure 79 Dialog Editor Left Pane ... 185
Figure 80 File Toolbar ... 186
Figure 81 Align Toolbar... 186
Figure 82 Elements Toolbar... 186
Figure 83 Set Captions dialog box ... 187
Figure 84 Dialog Editor Left Pane ... 188
Figure 85 Sample Form with all the Controls ... 191
Figure 86 Elements toolbar ... 192
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 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
Tables
Table 1 Notation Conventions... 19
Table 2 Revision History ... 21
Table 3 Toolbar buttons and menu options ... 30
Table 4 WorkSite Server Properties Dialog Options... 35
Table 5 Information Tables in the tree frame ... 49
Table 6 Database icon color ... 52
Table 7 Document Tab, Document History Options ... 55
Table 8 User tab, Information ... 56
Table 9 Document management tasks associated with roles... 108
Table 10 Using Roles to Manage Document Searches ... 109
Table 11 Examples of Roles ... 109
Table 12 Options on the Privileges Tab... 112
Table 14 Application Setup Properties... 128
Table 15 Default Document Types ... 131
Table 16 Document Type Dialog Properties ... 136
Table 17 Changes to NRT.INI file ... 137
Table 18 Information Fields in the Add and Edit Class dialog boxes... 140
Table 19 Sample PC Location Records... 144
Table 20 Common Uses for Custom Tables... 148
Table 21 Sample Custom Table entries... 149
Table 22 Dynamic Profile Field Commands... 169
Table 23 Dialog boxes that can be customized ... 181
Table 24 Types of Forms ... 187
Table 25 Valid formats for the Custom fields ... 191
Table 26 Restrictions on controls... 192
Table 27 Elements toolbar Icons ... 192
Table 28 Required Controls for Each Form Type ... 198
Table 29 Align Controls... 199
Table 30 Keyboard Shortcuts and Toolbar Buttons ... 209
Table 31 Icons in the Server WorkSpace window ... 211
Table 32 Column Headings on the Statistics tab ... 213
Table 33 Status Icons ... 215
Table 36 ... 230
Table 37 Options Available for Changing Security Settings ... 235
Table 38 Setting the Frequency with which the Statistics window is updated ... 254
Table 39 Events to Associate with Rules... 270
Table 40 Abbreviations used in the DMS log file ... 315
Table 42 Mode action on current user values... 340
Table 43 Format Criteria ... 341
Table 44 Abbreviations used in the DMSLog.txt file ... 343
Table 45 Database Table Functions ... 349
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
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
“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 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.
Table 1 Notation Conventions
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
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.
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.
Table 2 Revision History
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 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.
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.”
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:
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.
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.
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.
Finding WorkSite Servers
The WorkSite Service Manager can automatically search the network for all servers that are running WorkSite services.
Table 3 Toolbar buttons and menu options
Button Menu option Keyboard Shortcut Function
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.
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.
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.
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
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.
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 in the toolbar or from the Properties menu, select
Service Properties.
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.
Configuring WorkSite Server Service Properties
Figure 6 WorkSite Server Properties Dialog
Table 4 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.
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 dedicated TCP/IP port numbers assigned to the WorkSite Server Service The values entered in the Service Port and File Port text-entry fields are 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 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.
Table 4 WorkSite Server Properties Dialog Options
Configuring WorkSite Server Service Properties
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.
Table 4 WorkSite Server Properties Dialog Options
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 WorkSite Server Database Setup Dialog
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. Table 4 WorkSite Server Properties Dialog Options
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
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 Advanced Properties dialog box
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.
• 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.
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\ <Database Name>\
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.
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 File Server Setup icon. The File Server Connections dialog opens.
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 File Server Setup icon. The File Server Connections dialog opens.
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.
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.
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
