eDOCS DM 5.3 Installation Guide

Transcription

eDOCS DM 5.3 Installation Guide
Open Text® Document
Management, eDOCS Edition™
eDOCS DM Installation Guide
eDOCS DM 5.3
Open Text Document Management, eDOCS Edition
eDOCS DM Installation Guide
Rev.: November 2010
This documentation has been created for software version 5.3.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at: https://knowledge.opentext.com.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
E-mail: [email protected]
FTP: ftp://ftp.opentext.com
For more information, visit: http://www.opentext.com
Copyright © by Open Text Corporation, Open Text Inc.
Open Text Corporation is the owner of the trademarks Open Text, The Content Experts, Open Text ECM Suite, Open Text
eDOCS, eDOCS, Open Text FirstClass, FirstClass, Open Text Exceed, Open Text HostExplorer, Open Text Exceed
OnDemand, Open Text Exceed 3D, Open Text Exceed Freedom, Open Text Exceed PowerSuite, Open Text Exceed XDK,
Open Text NFS Solo, Open Text NFS Client, Open Text NFS Server, Open Text NFS Gateway, Open Text Everywhere, Open
Text Real Time, Open Text Eloquent Media Server, Open Text Integrated Document Management, Open Text IDM, Open
Text DocuLink, Livelink, Livelink ECM, Artesia, RedDot, RightFax, RKYV, DOMEA, Alchemy, Vignette, Vizible, Nstein,
LegalKEY, Picdar, Hummingbird, IXOS, Alis Gist-in-Time, Eurocortex, Gauss, Captaris, Spicer, Genio, Vista Plus,
Burntsand, New Generation Consulting, Momentum Systems, DOKuStar, and RecoStar among others. This list is not
exhaustive.
All other products or company names are used for identification purposes only, and are trademarks of their respective
owners. All rights reserved.
Contents
Setting Up eDOCS DM 1
What You’ll Need to Get Started 2
Notes on the First-Time Installation Process 2
Install and Prepare SQL Servers 2
Install SQL Client on DM Servers 3
Create DM Server Service Account 3
Install DM Server and Generate Library 3
Install DM Web Server 4
Populate Library with Your Organization’s Data 4
Install Security Service on Document Server and Import Existing
Documents 5
Set Properties in DM Server Manager 6
Create SearchServer Indexes 6
Using Transforms to Include DM-Related Items 6
Specifying Features on a Command Line for Scripted Installs 7
MSI Install Options 7
DM Extensions Examples 10
eDOCS DM MSI Silent Install Samples 11
Services 11
Configuring Windows Server 2008 Firewall to Allow NetTCP Connection
11
Installing eDOCS DM Components 13
Using the eDOCS Suite Installer 14
What’s Installed with DM Server 15
Installation Prerequisites 16
Installation Steps for DM Server 17
Configuring the DM Server 19
The DM Server Administration Tools 22
iii
Installing DM Web Server 23
Installation Prerequisites 23
Installation Steps for DM Web Server 24
27
Generating a Library 29
Before Generating a Library 30
The Internal User 30
Consistency of Library Names 31
Maximum Number of Documents in a Library 31
Updating a Library 31
Steps in Library Generation 32
Using Mixed and Windows Authentication for SQL Server
Authentication 65
Changing Database Access from Trusted Connection 65
Creating an Index 69
Running the Wizard 70
Installing DM WorkFlow 81
Before You Begin 82
Installation Prerequisites 82
Configuration Choices 83
DM WorkFlow Server Components Overview 84
Installing DM WorkFlow Server Components 86
Synchronizing Users 88
Post-installation Information 90
DM WorkFlow Administration 90
Setting Up a DSSS Document Server 91
NOS-Level Security for Document Files 92
Implementing DSSS 92
Installing the DSSS Software 93
Configuring DSSS to Run Under Domain Account 94
Creating Windows Groups and Adding Them to the DM Library 94
Adding a Global Group to a DM Library 96
Adding a Local Group to a DM Library 97
iv
Multiple Domain Aliases 97
Creating a Windows Share and Granting Users Access 99
Configuring the Document Server 104
Starting and Stopping DSSS 105
On Windows Server 105
Troubleshooting DSSS 106
Setting Up a DSSA Document Server 107
About DSSA 108
Understanding How DSSA Works 108
DSSA System Requirements 109
Prerequisites for Installing DSSA 109
Installing the DSSA Service 110
Creating a Windows Share and Granting Users Access 112
Configuring a DSSA Document Server 115
Viewing the Audit Trail 116
Installing RM 119
Related Manuals 120
Installing RM 120
Installing RM on DM Server 120
Installing RM on DM Web Server 121
Prerequisites for Installing RM Administration Tool 122
Installing RM Administration Tool 122
RM.INI and PCDOCS.INI File Locations 124
Additional RM Installation Information 124
Assigning RM Forms 124
Enable Logging 125
Configure a Client for RM Custom Reports 125
Uninstalling RM Administration Tool 126
Installing DM Extensions 127
Before You Begin 128
Installation Prerequisites 128
Install DM Extensions 128
Removing DM Extensions 131
v
Installing the eDOCS DM API 133
Installing eDOCS DM API 134
Removing DM API 134
Configuring eDOCS Imaging 135
Installing the IIDS 136
Configure Internet Imaging Document Server 136
Important Workstation Configuration 138
Set Internet Explorer Security Options 139
Enable Plugin in DM Webtop 139
Pointing a Component to a Different DM Server 141
Running the DM Connection Wizard 142
Setting Up the DM Server
Service Account 145
About the DM Server Service Account 146
Setting Up Accounts on Windows Servers 146
Creating the Account 147
Adding the Account to the Local Administrators Group 147
Applying Rights to the Account 147
Special Considerations for Microsoft SQL Server Libraries 149
Installation Impact on Regular Operations 150
Dedicated SQL Server Machine 150
Windows Service Accounts 150
Support for Microsoft SQL Server 2005 151
Database and Document Servers 151
Document Servers 151
Database Servers 151
Configuring SQL Servers and Databases 152
LAN Environments 152
WAN Environments 153
Disk Space Requirements 153
SQL Server and System Files 153
DM Database 154
Memory Requirements 158
vi
User Connections 159
Worksheets 162
Server Configuration Worksheet 162
SQL Server Installation Worksheet 163
Database Configuration Worksheet 164
Installation Worksheet 165
Special Considerations for Oracle Libraries 167
DM Requirement for Oracle Databases 168
Multiple Libraries on a Single Oracle Instance 168
Owner Accounts 168
Tablespace Names 168
Rollback Segments 169
Mixed-Case Data and Case-Insensitive Searches 169
Selecting Mixed-Case Storage During Library Generation 170
INIT.ORA Modifications for Mixed-Case Data 170
Removing Indexes to Improve Performance 170
DM WorkFlow Oracle Tablespaces 173
The PCDOCS.INI File 175
Location 176
Settings 176
Troubleshooting 179
Accessing Our Knowledge Base 180
Check the Setup of the DM Server Service Account 180
Problems Locating DM Server 182
NetWare Connectivity 183
Miscellaneous Issues 183
Problems with the Microsoft SQL Client Software 185
Microsoft SQL Server Errors 185
Error #1105 185
Error #9002 186
Error #10004 187
Decreased Performance or High Server Utilization 187
vii
Problems with the Oracle Client Software 188
Index
viii
Chapter
1
Setting Up eDOCS DM
In This Chapter
This chapter contains the following information:
•
What You’ll Need to Get Started
•
Notes on the First-Time Installation Process
•
Using Transforms to Include DM-Related Items
•
Specifying Features on a Command Line for Scripted
Installs
•
Services
•
Configuring Windows Server 2008 Firewall to Allow
NetTCP Connection
1
What You’ll Need to Get Started
To install and configure eDOCS DM, you will need the following:
Software
•
SQL Database server installation software and
documentation
•
Internet Information Services (IIS) Web server software
•
Web browser software
•
eDOCS DM installation files, serial numbers and
documentation
Computers — The number of computers required depends on
your repository size.
• SQL Database Server
• DM Server
• DM Web Server
• DM Indexer
Network Resources
• Network share(s) to store documents
NOTE: See the Release Notes for specific hardware and software
requirements..
Notes on the First-Time Installation Process
Install and Prepare
SQL Servers
Before installing DM, install your SQL database engine and prepare the
SQL server for the database that will hold the DM library. All DM
libraries must be accessible to the machine(s) where the DM Server
components of DM are installed. Libraries should not be installed on
the DM Server machine.
The DM library holds detailed information about each document. It
also describes:
2
CHAPTER 1
•
The users and groups who have access to documents.
•
The names and locations of document servers.
•
New or recently edited documents that need full-text
indexing.
•
Archival data.
•
Other information pertaining to management of
documents and the DM system itself.
For specific details on supported SQL databases, see the Release Notes.
NOTE: For instructions on setting up a SQL database, see the appendix for
your SQL implementation and your database vendor’s documentation.
Install SQL Client
on DM Servers
The SQL client software, which allows a user account to connect to the
database, must be installed on all DM Servers.
For instructions on installing the SQL client, see your database vendor’s
documentation.
Create DM Server
Service Account
The DM Server software must be run under an administrator account,
such as DMADMIN. The account must exist before you install the DM
Server software. See Setting Up the DM Server Service Account for
information on the rights and abilities required for the DM Server
service account.
Install DM Server
and Generate
Library
The DM Server software includes DM Server, the Server Admin Tools,
SearchServer, the Hummingbird Core Services (HCS) Authentication
Client, and the user-interface forms that display and accept data from
DM client users.
Installation of the DM Server software also installs the user-interface
forms. The default location for the forms is \Program Files\Open
Text\DM Server\DOCSObjects. If you move the forms, remember that
they must be accessible to DM Server and all DM client users. Be sure
to specify the new location on the Preferences tab of the DM Server
Manager. See the DM Administration Guide for more information.
After the installation, the DM Server Configuration Wizard will run to
help you set up the DM Server. The wizard will also run Library
Generator to create the DM tables in the SQL database. The library
generation process populates the SQL database with standard
information for all DM libraries. It also gives you the option of
synchronizing network users with DM users, copying network users
and groups into the library so you need not add each one manually.
NOTES ON THE FIRST-TIME INSTALLATION PROCESS
3
It is important that first-time installations run Library Generator
during the configuration of DM Server and to create at least one library.
To create additional libraries, you can run Library Generator repeatedly
from the DM Server Configuration Wizard or later from the Start
menu.
See “Installation Steps for DM Server” on page 17 for installation
instructions. Generating a Library explains the library-generation
process.
Depending on the needs of your organization, you may need to set up
multiple DM Servers. See the DM Administration Guide for
instructions on managing multiple DM Servers.
Install DM Web
Server
The DM Web Server software should be installed on a server machine
that is accessible to the DM Server(s). DM Web Server runs the DM
Webtop and is also used for administration of the library,
customization of the DM Webtop.
Prior to installing DM Web Server, Microsoft Internet Information
Services (IIS) must be installed on the machine. Consult the Release
Notes for the supported versions of IIS.
End users will need to know the DM Web Server’s URL to access DM
from their browsers.
Populate Library
with Your
Organization’s
Data
Once a library is generated, these additional steps should be performed
to get the library ready for users:
•
Select feature, utility, and version-control options for all
users. See the DM Administration Guide for instructions.
•
Add Document Types. See the DM Administration Guide for
instructions.
To import Document Types from an ASCII text file, use the
Database Import tool. To use this tool, on the DM Server,
click Start>Programs>Open Text>DM Server>Server Admin
Tools>Database Import. See the tool’s Help system for
instructions.
•
Add users and groups. There are several methods for adding
users:

4
CHAPTER 1
Synchronize users and groups in the library with
network users and groups. See page 60for instructions.
•
Install Security
Service on
Document Server
and Import
Existing
Documents

Add users manually with Library Maintenance>People.
See the DM Administration Guide for instructions.

Import users from an ASCII text file with the Database
Import tool. To use this tool, click Start>Programs>Open
Text>DM Server>Server Admin Tools>Database Import. See
the tool’s Help system for instructions.
Create groups of users that require the same rights and
features. All users are members of the group DOCS_USERS.
There are two methods for adding groups to the library:

Synchronize with network groups. See page 60 for
instructions.

Add groups manually with Library
Maintenance>Groups. See the DM Administration
Guide for instructions.
•
Set up remote libraries. See the DM Administration Guide
for instructions.
•
Customize forms and database tables. Refer to the DM
Designer Guide for more information.
A document server is an area designated for storage of documents. All
electronic documents in your library will be stored on one or more
document servers. The DM Administration Guide explains how to set
up document servers.
If your document servers are Window Server machines, and depending
on the security needs of your organization, you may want to install one
of the DM security services —DSSS or DSSA—on the document server.
See the chapter titled Document Access and Security in the DM
Administration Guide for a explanation of what these security services
can offer. For installation instructions, see Setting Up a DSSS
Document Server (for DSSS) and Setting Up a DSSA Document Server
(for DSSA).
After installing the security service (if applicable), you should then
identify the document server to the library via Library Maintenance,
either from DM Server or the DM Admin tab of DM Webtop. Once a
document server has been identified, you can import existing
electronic documents into it using the Document Import tool. During
the import process, DM creates a Document Profile in the library for
each imported document. To use the Document Import tool, on the
NOTES ON THE FIRST-TIME INSTALLATION PROCESS
5
DM Server click Start>Programs>Open Text>DM Server>Server
Admin Tools>Document Import. See the tool’s Help system for
instructions.
All document servers must be accessible to the machine(s) where DM
Server is installed.
Set Properties in
DM Server
Manager
DM Server Manager is a program controlling a number of server
properties. It is also the place where you can start and stop the DM
Server. See the DM Administration Guide for information on the Server
Manager properties.
Create
SearchServer
Indexes
You have the option of giving users the ability to do full-text searches of
documents and profile data in the DM repository. This means users can
search for documents by specifying a word or phrase contained in the
contents of documents. To provide this capability, you must set up the
indexing of documents by DM Indexer using SearchServer.
See Creating an Index for instructions on creating an index.
Using Transforms to Include DM-Related Items
Because MSI installations are included in eDOCS DM, you can include
any DM-related item (such as previous hot fixes, Interceptor settings,
XML configuration files, and custom macros) in a deployment
package, either by modifying the product's MSIs, or by applying a
"transform" when installing the MSI.
Transforms are patches to installations that can be used to change
properties, add components and registry settings, disable features and
generally, make any other changes desired.
To learn about Microsoft Windows Installer Transforms, consult the
MSDN web site at the following location:
http://msdn.microsoft.com/en-us/library/aa367447(VS.85).aspx
6
CHAPTER 1
Specifying Features on a Command Line for Scripted
Installs
The MSI installer can be launched from a command line or batch file
with feature selection done through properties passed to
MSIEXEC.EXE. The Features are DMServerFeature, RMServerFeature
and ContentCacheFeature. The serialnumbers for each feature can be
specified using OT_SERIALNUMBER_##="<password>" where ## is
replaced by 17 for the DM Server, 37 for the RM Server and 42 for
Content Caching. The passwords are specified using OT_PASSWORD_##
with the same number substitution.
Below is a sample install script to install everything except the RM
Server; it includes the serial numbers and passwords for the DM Server
and Content Caching passed in on the command line.
ADDLOCAL="ALL" starts with all features selected.
Msiexec.exe /q /i DMServer.msi ADDLOCAL="ALL"
REMOVE="RMServerFeature" OT_SERIALNUMBER_17="17XXXX-XXX-XXXXXXXX" OT_PASSWORD_17="xxxxxxxx"
OT_SERIALNUMBER_42="42-XXXX-XXX-XXXXXXXX"
OT_PASSWORD_42="xxxxxxxx"
The same features could be selected by specifying only the desired
features on the command line, such as the following:
Msiexec.exe /q /i DMServer.msi
ADDLOCAL="DMServerFeature,ContentCacheFeature"
OT_SERIALNUMBER_17="17-XXXX-XXX-XXXXXXXX"
OT_PASSWORD_17="xxxxxxxx"
OT_SERIALNUMBER_42="42-XXXX-XXX-XXXXXXXX"
OT_PASSWORD_42="xxxxxxxx"
The /q switch causes the install to run without an user interface in
"quiet" mode. The /i switch specifies the MSI to install.
MSI Install Options
The following are MSI install options; consult the MSI documentation
for more information.
Install Options
</package | /i> <Product.msi> —Installs or configures a
product
SPECIFYING FEATURES ON A COMMAND LINE FOR SCRIPTED INSTALLS
7
/a <Product.msi> — Administrative install - Installs a product on
the network
/j<u|m> <Product.msi> [/t <Transform List>] [/g
<Language ID>] — Advertises a product - m to all users, u to current
user
</uninstall | /x> <Product.msi | ProductCode> —
Uninstalls the product
Display Options
/quiet — Quiet mode, no user interaction
/passive — Unattended mode - progress bar only
/q[n|b|r|f] — Sets user interface level
n — No UI
b — Basic UI
r — Reduced UI
f — Full UI (default)
/help — Help information
Restart Options
/norestart — Do not restart after the installation is complete
/promptrestart — Prompts the user for restart if necessary
/forcerestart — Always restart the computer after installation
Logging Options
When the *.msi for the install is invoked using MSIEXEC.EXE, you can
use the -l logging option to create a log of the install.
If you use the Open Text eDOCS Suite Installer, you can configure
logging during the installation.
/l[i|w|e|a|r|u|c|m|o|p|v|x|+|!|*] <LogFile>
i — Status messages
w — Nonfatal warnings
e — All error messages
8
CHAPTER 1
a — Start up of actions
r — Action-specific records
u — User requests
c — Initial UI parameters
m — Out-of-memory or fatal exit information
o — Out-of-disk-space messages
p — Terminal properties
v — Verbose output
x — Extra debugging information
+ — Append to existing log file
! — Flush each line to the log
* — Log all information, except for v and x options
/log <LogFile> — Equivalent of /l* <LogFile>
Update Options
/update <Update1.msp>[;Update2.msp] — Applies update(s)
/uninstall <PatchCodeGuid>[;Update2.msp] /package
<Product.msi | ProductCode> — Remove update(s) for a product
Repair Options
/f[p|e|c|m|s|o|d|a|u|v] <Product.msi | ProductCode> —
Repairs a product
p — only if file is missing
o — if file is missing or an older version is installed (default)
e — if file is missing or an equal or older version is installed
d — if file is missing or a different version is installed
c — if file is missing or checksum does not match the calculated value
a — forces all files to be reinstalled
u — all required user-specific registry entries (default)
SPECIFYING FEATURES ON A COMMAND LINE FOR SCRIPTED INSTALLS
9
m — all required computer-specific registry entries (default)
s — all existing shortcuts (default)
v — runs from source and recaches local package
Setting Public Properties
[PROPERTY=PropertyValue]
DM Extensions
Examples
The DM Extensions MSI takes the licensed product's serial number/
password on the command line, to support the silent install.
OT_SERIALNUMBER_28
OT_PASSWORD_28
OT_SERIALNUMBER_32
OT_PASSWORD_32
Here are some examples:
Non-Silent Install
msiexec /l*v "%TEMP%\dmext.log" /i "C:\ eDOCS DM 5.3
Extensions (x86).msi" (non-silent install)
Silent Install with Selected Features and Imaging
msiexec /l*v "%TEMP%\dmext.log" /i "C:\ eDOCS DM 5.3 Extensions
(x64).msi" /q
ADDLOCAL=DynamicViewsFeature,Microsoft.Word.2003,DMViewe
r,CDU,ImagingExt OT_SERIALNUMBER_28=28-0100-00100000000 OT_PASSWORD_28=1234abcd
Non-Silent Install with RM and Imaging License Information
The following example is for a non-silent installation with RM and
Imaging license information, so that when they are selected in the
feature tree, the license information dialog box will not be displayed.
msiexec /l*v "%TEMP%\dmext.log" /i "C:\ eDOCS DM 5.3 Extensions
(x86).msi" OT_SERIALNUMBER_32=28-0100-001-00000000
OT_PASSWORD_32=1234abcd RM_SN=32-0100-001-00000000
RM_PW=abcd1234
10
CHAPTER 1
eDOCS DM MSI
Silent Install
Samples
To obtain additional information on the scripting and configuration
options and samples, consult the eDOCS DM MSI Silent Install Samples
Application Note in the Knowledge Center at the following location:
https://knowledge.opentext.com/knowledge/cs.dll/Open/18813090
Services
The following shows the eDOCS DM services that are installed:
•
Open Text eDOCS DM Remote Indexer - Indexer Service
(was the DOCSFusionSS Server in previous DM versions).
•
Open Text eDOCS Remote Indexer Manager - Indexer
Service Manager (was the DOCSFusionSS Server Manager
in previous DM versions).
•
Open Text eDOCS DM Server - service for DM Server (was
DOCSFusion in previous DM versions).
•
Open Text eDOCS DM Server WCF Host - allows DM
Server to accept HTTP and NetTCP connections.
•
Open Text eDOCS WebAdmin Host - uses DM Extensions
API so therefore DM Admin in DM Webtop and RM Admin
use it.
•
Open Text eDOCS Search Server FTMF Service - (Ful/Text
Multi-Format) Text reader service which indexes the
documents.
Configuring Windows Server 2008 Firewall to Allow
NetTCP Connection
By default, Windows Server 2008 has its firewall enabled; this will
completely block DCOM communication, and NetTCP must be
manually enabled on the firewall. HTTP is allowed by the firewall by
default.
SERVICES
11
To configure Windows Server 2008 firewall to allow NetTCP
connection:
1. On the Windows 2008 Server, click Start>Administrative
Tools>Windows Firewall with Advanced Security.
2. In the left pane, right click Inbound Rules and select New Rule.
3. The first dialog asks what type of rule you want to create.
Select Port and click Next.
4. By default, the DM client set to NetTCP will use port 808, so
type 808 and click Next.
5. Select the Allow the connection option.
6. Select Domain and click Next.
7. Give the rule a name and click Finish.
Your DM client machines will now be able to connect to a Windows
2008 Server with the firewall still active.
12
CHAPTER 1
Chapter
2
Installing eDOCS DM
Components
In This Chapter
This chapter explains how to install DM Server, DM Web Server, DM
Extensions, and the components of other products that can be installed
with them.
We recommend you read the eDOCS DM Release Notes before installing the
software. The release notes contain important information that might not be
included in the documentation. The release notes also contain the supported
platforms and applications.
13
Using the eDOCS Suite Installer
The eDOCS Suite Installer (eDOCSSuiteInstall.exe) allows you to
install all eDOCS DM components from an installation “wrapper.”
Although you can install DM components from the individual MSIs,
this installer sorts the components in the order in which they should be
installed. You can easily install these components from the eDOCS
Suite installer, which executes each of the individual MSIs.
To use the eDOCS Suite Installer:
1. Locate and double-click the eDOCSSuiteInstall.exe file.
2. The eDOCS Suite Install dialog box opens.
The components to install are:
• eDOCS DM Server
• eDOCS DM Web Server
• eDOCS DM Workflow Web Server
• eDOCS DM Security Service
• eDOCS DM Document Sentry Agent
• eDOCS RM Administration Tool
14
CHAPTER 2
• eDOCS DM Extensions
• eDOCS DM Documentation
You must install DM Server first. Select eDOCS DM Server and
then click Next.
3. The Options for eDOCS DM 5.3 <component name>
dialog box appears. The Commandline field shows the
parameters set for installing the product, such as the
location of the product’s MSI.
If you want an installation log file created, select the Create a
log file check box. Notice that the location and file name of
the log file appear in the Commandline field. The default log
file location is C:\DMLogs\.
The log file name has the following naming convention:
<Component name>_<date>-<time>.log. For example,
DMServer_1101-1159.log, which indicates the DM Server
installation started on November 1 at 11:59 a.m. The 24hour time is used.
4. The Option parameter(s) field is for advanced users only. You
can specify additional parameters to be added to the
Commandline field.
5. Click Install.
6. The Welcome to the Open Text eDOCS DM 5.3 <component
name> Setup Wizard appears.
See Installation Steps for DM Server to complete the
installation.
7. When the component installation is finished, go back to the
eDOCS Suite Installer and repeat the above steps for each
component you want to install.
When you select the eDOCS DM Documentation component, all of the
documentation PDFs are copied to the \Program Files\Open
Text\Documentation directory.
What’s Installed
with DM Server
DM Server
\Program Files\Open Text\DM Server
SearchServer
\Program Files\Open Text\DM Server\SSK
DM Server Manager
\Program Files\Open Text\DM Server
USING THE EDOCS SUITE INSTALLER
15
Installation
Prerequisites
Content Cache
A separately licensed feature installed as
part of DM Server Manager in \Program
Files\Open Text\DM Server if license
provided during DM Server install.
DM Server Administration
Tools
\Program Files\Open Text\DM
Server\Program
Forms to Display
Information to DM Client
Users
\Program Files\Open Text\DM
Server\DOCSObjects
DM API
\Program Files\Open Text\DM API
Folder for Full-Text
Indexes
\Open Text\DM Indexes
PCDOCS.INI
Created in \Program Files\Open Text\DM
Server\Program or copied there from
existing location during installation
RM Server
\Program Files\Open Text\DM Server
(separate license required)
The SQL engine must be installed in a location accessible to the
machine where you are about to install DM Server and a SQL client
must be installed on the DM Server. See the appendix for your SQL
engine for additional prerequisites that may be required prior to
installation of the DM software.
You must create or know the DM Server service account. See Setting Up
the DM Server Service Account for information on this account.
We recommend that the DM Server be a member node in your
Windows network, not a Primary Domain Controller (PDC) or
Backup Domain Controller (BDC).
Although the software may appear to install successfully on a PDC, we
do not recommend it because PDCs have no local accounts. To ensure
a successful installation, DM Server must be installed under a local
administrator account with certain local rights.
Installation of the DM Server software will fail on BDCs. Temporarily
promoting a BDC to a PDC for the purpose of installing DM Server can
cause later security problems that will require extensive rebuilding of
user accounts and file-level security.
16
CHAPTER 2
The Event Log service process must be running for DM Server to start.
We strongly recommend that you set your Event Logs to overwrite as
needed. This is both for DCOM messages when the DM Server is
stopped and for SearchServer indexing messages.
Exit any programs that are currently running on the server machine.
Installation Steps
for DM Server
1. On the server where you are installing DM Server, log on
under a local Windows Administrator account with the
advanced right “Act as part of the operating system.” It is not
required that the account be the DM Server Service account.
2. Execute the eDOCS DM 5.3 Server.msi Windows Installer
Package. The Windows Installer will prepare to install.
3. The Welcome to the Open Text eDOCS DM Server 5.3
Setup Wizard dialog box appears. Click Next.
4. The End-User License Agreement dialog box appears. Select
the I agree the terms in the License Agreement check box and
then click Next.
5. The Custom Setup dialog box appears with the following
installation options:
•
DM Server — This component includes DM Server,
SearchServer, DM Server Manager, and the eDOCS DM
Server Admin Tools.
•
RM Server — This is the required server component for
RM.
•
Content Caching — This optional DM Server component
allows documents to be cached locally, substantially
decreasing access time.
•
Archiving for eDOCS — This optional component enables
DM made read-only documents to be moved to an
Enterprise Library read-only server.
USING THE EDOCS SUITE INSTALLER
17
Click the drop-down menu to select the options to install.
You can click the Disk Usage button to view each available
drive with their Disk Size and Available space.
Click Next.
6. The Choose Products for Licensing dialog box appears.
Enter the Serial Number and Password and then click Next.
Continue this step for each product you selected to install.
7. The Destination Folder dialog box appears. The default
installation is C:\Program Files\Open Text\DM Server.
Click the Change button to select a different directory, or
click Next.
8. The Ready to install dialog box appears. Click Install to begin
the installation.
9. The Installing Open Text eDOCS DM Server 5.3 dialog box
appears with a Status bar indicating the progress.
10. When the installation is finished, the Completed the Open
Text eDOCS DM Server 5.3 Setup Wizard dialog box
appears. Click Finish.
18
CHAPTER 2
11. After you click Finish, the DM Server Configuration Wizard
starts. See the next section, Configuring the DM Server, for
instructions.
Configuring the
DM Server
The DM Server Configuration Wizard assists you in setting up the DM
Server.
Most of the options you set here can be changed later in the DM Server
Manager. The only exception is the specification of the DM Server
service account. To specify a different account, you must run the
Configuration Wizard again.
To set up the DM server:
1. The DM Server Configuration Wizard begins with the Set
Up DM Service Account dialog box.
This step sets up the required rights for the DM Server
service account, which is the account under which the DM
Server service runs. The account should be created prior to
installing DM Server.
USING THE EDOCS SUITE INSTALLER
19
Enter the Domain Name, the Account Name, and the Password
of the DM Server service account. (See the appendix Setting
Up the DM Server Service Account if you have questions
about the service account.) Click Next.
2. The next dialog box that appears is the Specify
PCDOCS.INI Location, which defines the libraries used by
DM Server. If this is a new install and you do not have a
PCDOCS.INI file, leave the field blank; this file will be
created when you create a new DM library. You can click the
Browse button to locate an existing PCDOCS.INI file.
The default location of this file is C:\Program Files\Open
Text\DM Server\program.
Click Next.
3. The Create and Upgrade DM Library dialog box appears.
If you are installing DM for the first time, no libraries are
displayed, so just click Create Library to launch Library
Generator.
Existing libraries will appear here. If you are upgrading,
select the library’s check box and click Upgrade Library.
20
CHAPTER 2
Otherwise, click Next, and continue with step 19.
4. If you clicked Create Library, the Library Generator dialog box
appears, which states: “This program will initialize a
database and also update a database created for earlier
versions. Is this what you want to do?”
Click Yes.
5. The Industry-specific Customization dialog box appears.
Select one of the following industry types to install sample
customizations for your profession. If you do not want any
customization, select Default:
• Default
• Financial
• Government
• Legal
Click OK.
6. The Library Generation dialog box appears, where you
indicate the library name and brand of SQL software. If a
library already exists, select the Library Name from the dropdown menu; otherwise, type the library name. In the SQL
Vendor section select either MS SQL Server or Oracle, and then
click OK.
7. The SQL Server Selection dialog box appears. Select the SQL
Server Name from the drop-down list (or type it) and click
OK.
8. The Database Selection dialog box appears. You can select
an Existing Database or click Create New. If you select an
existing database, click OK.
9. The Database Owner Name and Password dialog box
appears. Enter the DOCSADM Password. Click OK.
10. The Select Primary Document Server dialog box appears. In
the Physical Location field, type the drive where your
document files will be stored.
Click the Operating System drop-down menu and select the
type.
Click OK.
11. The Updating Database Structure dialog box appears, which
shows the database tables being built.
USING THE EDOCS SUITE INSTALLER
21
12. The Library Generator dialog box appears and prompts,
“Do you want to allow duplicate document names?” Click Yes
or No.
13. The Common SQL Login dialog box appears. Enter the SQL
login name and password to be used.
Or, select the Use Trusted Connection check box to allow users
to authenticate using either the common logon or through
Windows authentication.
14. The Application Integration dialog box appears. Select any
applications you want to appear on the eDOCS desktop and
then click OK.
15. The Library Generator dialog box appears, which starts the
User Synchronization process. Click OK.
16. The User Synchronization dialog box appears. Expand the
network resource, select the user name, and then click Add
Alias. When you are finished, click Close.
17. The Library Generator Information window appears stating
the library generation is complete. Click OK.
18. You are returned to the Create and Upgrade Library dialog
box. Click Next.
19. The Select Libraries Used by DM Server dialog box appears.
Select the library’s check boxes for DM Server to connect to.
Click Next.
20. The Identify Default Library dialog box appears. Select the
library that users will connect to if they don’t specify a
library when logging on to DM Webtop. Click Next.
21. The Start DM Server Service dialog box appears. Click
Finish.
The DM Server
Administration
Tools
22
CHAPTER 2
The DM Server Administration Tools are installed automatically when
you install DM Server. Access these tools through Start>Programs>Open
Text>DM Server>Server Admin Tools. Consult the tools’ Help systems for
instructions.
Installing DM Web Server
Installation
Prerequisites
The DM Web Server software should be installed on a Windows server
machine that is accessible to the DM Server(s). For optimal
performance, we highly recommend that DM Web Server be installed
on a different machine from DM Server. See the Release Notes for
specific system requirements (processor, memory, etc.) for the DM
Web Server machine.
Notes: If DM Web Server is installed on a Windows server with the NetShield
virus scanner, ensure that the file GLOBAL.ASA is excluded.
The name of the computer where you are installing DM Web Server should not
contain non-DNS characters such as underscores.
Microsoft recommends, and we strongly concur, that the Maximize Throughput
for File Sharing option be disabled to avoid thrashing on Windows server when
working with large files.
Microsoft Internet Information Services (IIS) must be installed on the
machine. Consult the release notes for supported versions.
•
To access DM Web Server for administration purposes, you
will need a workstation with a browser compatible with the
Web server installed.
•
End-user requirements (these are not actually requirements
for installation of DM Web Server, but they must be met in
order for end users to access DM):

For access to DM, user workstations must have
Internet Explorer Web browsers with both JavaScript
and Java support enabled.

Users must have the Java Virtual Machine from either
Microsoft or the Sun Microsystems installed on their
workstations.
Note: Windows XP does not ship with Microsoft Java Virtual Machine, so
users of this operating system should either upgrade to Windows XP SP1 or
download the Java Virtual Machine from the Microsoft or Sun Microsystems
Web site.

Users must have a network domain account or an
Attache account with a password. They cannot log on
to DM Server with a null password.
INSTALLING DM WEB SERVER
23

Advise end users of the DM Web Server’s URL so they
can access DM from their browsers. The default URL
name is:
http://<DM Web Server machine name>/
CyberDOCS/
Installation Steps
for DM Web Server
24
CHAPTER 2
To install DM Web Server:
1. From the Open Text eDOCS Suite Installer, select eDOCS DM
Web Server and click Next. See the Using the eDOCS Suite
Installer section for more information.
Or, execute the eDOCS DM 5.3 Web Server.msi Windows
Installer Package. The Windows Installer will prepare to
install.
2. The Welcome to the Open Text eDOCS DM Web Server
Setup Wizard dialog box appears. Click Next.
3. The End-User License Agreement dialog box appears. Select
the I agree the terms in the License Agreement check box and
then click Next.
If you do not have Internet Information Server (IIS)
installed, the installation will prompt you to install IIS. You
will need to exit the setup program, install the IIS Web
server software, and rerun the setup.
4. The Custom Setup dialog box appears with the following
installation options:
•
DM Client — This component includes DM Webtop,
application integration support, DM Web Admin, and
the Smart Check In/Check Out feature.
•
Imaging Client — This component is required for eDOCS
DM Imaging. It includes the Internet Imaging
Document Server (IIDS).
•
DM Workflow Client — This component enables DM
WorkFlow in DM Webtop. It is required for DM
WorkFlow. It has an optional component called
Backups, which is not required to run DM WorkFlow.
However, if you plan to customize your WorkFlow
forms, it's a good idea to install a backup of the form
set used by your organization.
Backups — This component will install a backup of the
form set.
•
RM Client — This component is required for RM. It
enables RM in DM Webtop and it contains RM
Extensions. .
INSTALLING DM WEB SERVER
25
Click the drop-down menu to select the options to install.
You can click the Disk Usage button to view each available
drive with their Disk Size and Available space.
Click Next.
5. The Please Select Form Type dialog box appears. Select the
default form type for your organization.
•
Dynamically interpreted forms—This style uses the
definitions in your DM library to create Java applets that
closely resemble the forms as they appear in DM
Designer.
•
Uncustomized default HTML forms—Standard HTML files
that can be used as-is with default DM libraries or used
as a starting point for customizations. Some users may
prefer these forms because they tend to load faster than
the Java applets provided in the dynamically interpreted
set.
•
Legal HTML forms—HTML files designed for use in legal
firms’ libraries.
•
Government HTML forms—HTML files designed for
governmental organizations.
•
Financial HTML forms—HTML files for financial
enterprises.
Note: For the easiest accessibility by users, especially those
using voice-recognition software, we recommend using HTML
forms.
6. The Connection Information dialog box appears. Enter the
machine name of the DM Server and then click Next.
NOTE: If you are installing DM Workflow Client, you must
also enter the name of the machine where the DM Workflow
Engine is installed.
7. The Collect Required Information dialog box apperas. Enter
the credentials under which the virtual directory will run. If
the DM Server is a standalone server, enter the computer
name in the Domain Name field.
Enter the Domain Name, Account Name, and Password and then
click Next.
26
CHAPTER 2
8. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open Text\DM
Web Server. Click the Change button to select a different
location; otherwise, click Next.
9. The Ready to install dialog box appears. Click Install.
10. When the Completed the Open Text eDOCS DM Web
Server Setup Wizard dialog box appears, click Finish.
.
)
27
Chapter
3
Generating a Library
In This Chapter
This chapter explains how to run Library Generator to create or update
a DM library.
29
Before Generating a Library
Library generation adds the DM tables to a database created on your
SQL server. Prior to running Library Generator, you must:
•
Install the SQL server engine and create a SQL database.
Your SQL vendor’s documentation provides instructions on
installing the SQL engine and creating a database.
See one of the following appendices in this manual for
specific considerations for your SQL type:

Special Considerations for Microsoft SQL Server
Libraries


Special Considerations for Oracle Libraries
•
Install and configure the SQL client files on all DM Server
machines, including dedicated indexing servers. (The DM
Web Server and user workstation do not need the SQL
client.) See your SQL documentation for instructions on
installing the SQL client software.
•
Add supporting settings to the INIT.ORA file and restart the
Oracle instance if you are creating or regenerating an Oracle
database and you want to take advantage of the mixed-casedata capability. See INIT.ORA Modifications for MixedCase Data for more information.
The Internal User
During generation of a new library, Library Generator creates a library
user account with these attributes:
USER_ID:
INTERNAL
FULL_NAME:
Internal User
PRIMARY_GROUP:
DOCS_SUPERVISORS
The account has no network alias and is a member of only one library
group: DOCS_SUPERVISORS.
The internal user is the default account used for reading documents to
create a full-text index of document contents and for generation of
30
CHAPTER 3
document previews. You may use the INTERNAL account created
during library generation or you may create another account for this
purpose. See the chapter on indexing in the DM Administration Guide
for more information on the internal user account.
Consistency of Library Names
In a multiple-library organization, library names must be consistent
across all libraries. Keep this in mind when generating a new library
and when defining a library’s remote libraries.
All libraries should be set up as remote libraries to all other libraries in
the organization’s repository. See the DM Administration Guide for
instructions on defining remote libraries.
Maximum Number of Documents in a Library
The maximum number of documents that can be held in a single DM/
RM library is 2,147,483,647. This relieves you from having to spread a
large repository over multiple libraries at the same location.
Updating a Library
Library Generator will need to access your PCDOCS.INI file to locate
your existing library(ies). During installation of DM Server, you are
asked where this file resides; the setup program will then copy it to the
DM Server\Program folder (by default, C:\Program Files \Open
Text\DM Server\Program).
Before running Library Generator, rename your PEOPLE form, so the
new People form will be added to the library:
UPDATE DOCSADM.FORMS SET FORM_NAME='PEOPLE_OLD' ,
FORM_TITLE='PEOPLE_OLD' WHERE FORM_NAME='PEOPLE’
After running Library Generator, you will need to delete the
PEOPLE_OLD form from the FORMS table. Otherwise, you will see
two different “People” entries in Library Maintenance.
CONSISTENCY OF LIBRARY NAMES
31
If your organization uses customized versions of other default forms ,
we recommend you also consider renaming your existing default
forms:
DEF_PROF
DEF_QBE
GROUP_DEF
prior to running Library Generator. This will result in the current
versions of these forms being created in the library without overwriting
your customizations. After library generation, you can then apply the
customizations to the new forms using DM Designer.
To rename the forms, use a SQL query tool to run the following update
statements:
update DOCSADM.FORMS set FORM_NAME =
‘DEF_PROF_OLD’ where FORM_NAME = ‘DEF_PROF’
update DOCSADM.FORMS set FORM_NAME =
‘DEF_QBE_OLD’ where FORM_NAME = ‘DEF_QBE’
update DOCSADM.FORMS set FORM_NAME =
‘GROUP_DEF_OLD’ where FORM_NAME = ‘GROUP_DEF’
Before making any modifications to the new forms, be sure to make a
backup copy of them.
Steps in Library Generation
This section explains how to generate a DM library on a SQL database.
Library Generator runs automatically as part of the DM Server
installation program, and you have the option of generating or
updating one library during the installation itself.
If you are installing DM for the first time, you must generate a library
before proceeding with the installation of DM Server. You can generate
additional libraries after the installation.
32
CHAPTER 3
Sites upgrading from earlier releases of DM need not update a library
during installation, but all existing libraries must be updated with the
current version of Library Generator before they can be used with DM.
To create or update libraries after installing DM Server, run Library
Generator from the Start menu (Programs>Open Text>DM Server>Server
Admin Tools>Library Generator). The behavior of Library Generator is the
same, whether you start it this way or run it during the DM Server
installation.
STEPS IN LIBRARY GENERATION
33
To generate a DM library:
1. The first dialog box asks you to verify that you want to
generate or upgrade a library. Click Yes.
2. On the Industry-specific Customization dialog box, select
an industry type for your organization. Custom tables and
forms are automatically created for the industry you choose.
34
CHAPTER 3
The following industry customizations are available:
Industry
Custom Tables
Default
None
Financial
Department and Accounts
Government
Organization and Department
Legal
Client and Matter (hierarchically related)
Note: If you want to create your own custom tables and forms or modify the
industry-specific tables and forms provided, use DM Designer. Refer to the
manuals DM Designer Guide and DM/RM Data Dictionary for more information.
3. On the Library Generation dialog box, enter a name for the
library. If your SQL engine is Microsoft SQL Server, we
recommend that the library name be the same as the
database name. If you are an Oracle site, the library name
need not be the same as the database instance name; in fact,
duplicate names may be inadvisable since it is possible to
create multiple DM libraries on a single Oracle instance.
If you are creating a new library, the name can be up to 20
characters long. Spaces are not allowed. Here are some
examples of valid library names: Documents, Phoenix, and
Accounting.
STEPS IN LIBRARY GENERATION
35
If you are regenerating an existing library, select the library
name from the list.
Note: If you are moving from DOCS Open and the name of
an existing library is not shown in the list, it is because
Library Generator is not looking at the PCDOCS.INI file
where the existing library is listed. To rectify this, click Cancel
to exit Library Generator. Copy the PCDOCS.INI file to the
DM Server \Program directory and run Library Generator
from the Start menu. See page 31 for information on the
expected location of PCDOCS.INI file.
In the SQL Vendor field, select the option matching your SQL
vendor.
If you are generating or regenerating an Oracle library, skip
to step 10 on page 40.
4. Microsoft SQL Server libraries only. On the MS SQL Server
Selection dialog box, select the name given to your SQL
server during installation of the SQL server engine.
If you are running Microsoft SQL Server and are using
multiple instances, enter the instance name with the SQL
server name, using in the format:
<SQL server name>\<instance name>
Note: The SQL system administrator password is needed only for the initial
connection to the database. The password is not retained by DM.
36
CHAPTER 3
5. On the Login dialog box, enter the SQL system
administrator account name and password. This account
will be used to create a SQL Server user account that will be
the library owner.
6. Select the Trusted Connection check box to allow your users to
authenticate using either the common logon or through
Windows Authentication.
7. On the Database Selection dialog box, select the SQL
database where you want to create or update the library. To
update an existing library, select its database from the list,
click OK, and skip to step 32 on page 57.
With Microsoft SQL Server, there are two ways to create a
database: with Library Generator or with SQL Enterprise
Manager prior to running Library Generator. If you have
already created the database with Enterprise Manager, the
database name appears in the Existing Databases list.
STEPS IN LIBRARY GENERATION
37
To create a new database, click Create New.
8. Microsoft SQL Server libraries only. On the Create a Database
dialog box, enter a name for the new database .
38
CHAPTER 3
In the Imported Documents field, enter the number of
documents to be imported into the database. This allows
Library Generator to calculate the display, in the File Size
field, the recommended size for the database file. You can
modify this value if you like. The default value for the File
Size field is 15 Mb. Note that the log file size is computed to
be one third the size of the database file. Click OK to
continue.
The Database Selection dialog box returns with the new
database name in the Existing Databases list. Make sure the
name is highlighted and then click OK.
STEPS IN LIBRARY GENERATION
39
9. Microsoft SQL Server libraries only. On the Login dialog box,
enter a password for the DOCSADM account, which is a
SQL user account that is the owner of all library objects and
has administrative privileges on the database. The
DOCSADM account is created the first time you run
Library Generator on a SQL server. Then, whenever a user
initiates an activity with the potential to change database
structures, such as regenerating a library or adding a table,
DM asks for the DOCSADM password.
Microsoft SQL Server libraries:
•
If you are creating a library, skip to step 31 on page 56.
•
If you are updating a library, skip to step 32 on page 57.
10. Oracle libraries only. On the Oracle Server Selection dialog
box, enter the name of your Oracle instance. Click OK.
40
CHAPTER 3
11. Oracle libraries only. On the Login dialog box, enter the SQL
system administrator account name and password. Click OK.
Note: The SQL system administrator password is needed only to initially
connect to the database. The password is not retained by DM.
12. Oracle libraries only. Multiple DM libraries may be created
on a single Oracle instance. Each library on the instance
must have a unique owner; that is, an account that owns the
library’s tables and data. On the Database Owner Name and
Password dialog box, enter the account name and password
of the owner of the library.
By default, the owner name is DOCSADM; however only
one library on an instance may be owned by DOCSADM, so
if DOCSADM is already taken, enter another name.
STEPS IN LIBRARY GENERATION
41
If a DM library already exists on the Oracle instance and you
enter a new owner name, adialog box appears asking if you
want to create another library on this instance. Click Yes to
create the new library.
13. Oracle libraries only. A Question dialog box appears only if
you added the settings supporting functioned-based indexes
to INIT.ORA and restarted the instance before running
Library Generator. (See “INIT.ORA Modifications for
Mixed-Case Data” on page 168. for more details if you
haven’t modified INIT.ORA.)
Click Yes to have Library Generator create uppercase indexes
for the searchable text fields on the Profile form; see
“Mixed-Case Data and Case-Insensitive Searches” on page
167. for more about this feature.
42
CHAPTER 3
Oracle libraries only. If you are generating a new Oracle
library, an Information dialog box is displayed, informing
you that, unless you are told otherwise, tablespaces are
created in the Oracle default directory and tablespaces
should be on different disk drives, if possible. If you will
have multiple Oracle instances, you will need to specify the
complete path for the tablespace names in order to avoid
naming conflicts. Click OK.
14. Oracle libraries only. On the Oracle Install Selection dialog
box, select a method for library generation.
STEPS IN LIBRARY GENERATION
43
Express: Allows you to enter general tablespace size
requirements and then proceeds with library generation.
This option uses standard tablespace names in the default
location specified by your operating system and version of
Oracle. If you select Express, go to step 15 below.
Custom: Allows you to specify the size, file name, and
location of your tablespaces. This option also lets you edit
table sizes, define rollback segments, and create a temporary
tablespace of any size. Choose the Custom option when you
need to control specific aspects of your database tables.
If the block size for your Oracle instance is larger than 4 KB,
you must select the Custom option. Then, when Library
Generator prompts you to enter the number of rollback
segments to create, enter zero. You must create any
additional rollback segments manually.
If you select Custom, go to step 16 on page 45.
15. Oracle libraries only. If you select the Express option, you are
asked to provide an estimate of the number of documents
and users you expect to have.
44
CHAPTER 3
•
Enter the approximate initial number of documents to
be imported.
•
Enter an approximate number of documents to be added
in the next year.
•
Enter an approximate number of people who will be
accessing the library database.
•
If you selected an industry type other than default, enter
the appropriate information as requested.
The numbers need not be precise, but your database will
perform better the more exact your estimations. When you
have made your estimates, the disk space requirements are
displayed at the bottom of the dialog box. Click OK.
Now skip to step 31. Note that steps 16 through 30 apply
only to users selecting the Custom option.
16. Oracle libraries only. If you select Custom, the Oracle Custom
Install dialog box is displayed.
STEPS IN LIBRARY GENERATION
45
17. Enter the initial number of documents to be imported.
18. Enter the number of documents to be added in the next
year.
19. Enter the number of people who will be accessing the
library.
20. Enter the number of groups you will define in Library
Maintenance.
21. Enter the number of document types you will define in
Library Maintenance.
22. If you selected the Financial, Government, or Legal industry
type, you must also enter the required information for any
industry-specific tables created.
23. Enter the approximate space required for tables you will add
to the database.
The numbers you enter should be as precise as possible
because initial database tablespace sizing is determined
from these values. Space for user-defined tables and total
disk space requirements are displayed at the bottom of the
dialog box. Click OK.
24. Oracle libraries only. On the Oracle Tablespace Selection
dialog box, three tablespaces are listed with default values
based on your entries in the Oracle Custom Install dialog
box. You can accept these tablespaces, modify them, or
create and use your own tablespaces. You can also edit the
table information for any of these tablespaces. (For
instructions on creating a new tablespace, go to step 27 on
page 51.)
We suggest that you divide the database over the following
three tablespaces:
•
for the Document Profiles
•
for tables used in verifying profiling information
•
to hold indexes
Unless you assign your own tablespace names, the default
tablespace names assigned during library generation are
incremented for each new library on an instance. For the
first library, the default tablespace names are DOCSPROF,
DOCSVAL, DOCSIND, and DOCSTMP. For the second
46
CHAPTER 3
library, they increment to DOCSPROF2, DOCSVAL2,
DOCSIND2, DOCSTMP2. In the example below, the
tablespaces are being created for the eighth library on the
instance. Up to 100 libraries can be created using the default
tablespace names.
Profile Info Tablespace: Profile tables are located here. The
default tablespace is DOCSPROF. To modify the storage
parameters for its tables, click Edit Table Info. For instructions
on editing these parameters, go to step 25. To modify the
size or location of the DOCSPROF tablespace, go to step 26
on page 50.
Validation Tablespace: Validation tables are located here. The
default tablespace is DOCSVAL. To modify the storage
parameters for its tables, click Edit Table Info. For
instructions on editing these parameters, go to step 25. To
modify the size or location of the DOCSVAL tablespace, go
to step 26.
STEPS IN LIBRARY GENERATION
47
Indexes Tablespace: Indexes are located here. The default
tablespace is DOCSIND. To modify the size or location of
the DOCSIND tablespace, go to step 26.
Unless you assign your own tablespace names, the default
tablespace names assigned during library generation are
incremented for each new library on an instance. For
example, for the second library, the default tablespace
names are DOCSPROF2, DOCSVAL2, DOCSIND2,
DOCSTMP2. Up to 100 libraries can be created using the
default tablespace names.
25. Oracle libraries only. To edit the storage parameters for the
profile or validation tablespace tables, click Edit Table Info. (If
you do not want to modify the parameters, skip this step.)
Note: The index tablespace storage parameters cannot be
edited because they are optimized for DM indexes.
25.1 On the Edit Table Information dialog box, highlight
the table you want to edit and click Edit.
48
CHAPTER 3
25.2 On the Table Information Maintenance dialog box,
modify the table’s storage parameters as necessary.
Row Size: The size of an average row in bytes for this
table. If you plan to add columns to this table you may
want to change the row size, depending on the length
(in bytes) of your added column(s).
Initial Rows: The number of rows you will initially
create or import for this table.
Rows Next Year: The approximate number of rows you
will add in the next year.
Initial Extent: The size (in kilobytes) of the first extent
that Oracle will reserve for this table at creation time.
Next Extent: The size (in kilobytes) of the next extent
that Oracle will reserve for this table when the initial
extent has reached its capacity.
% Increase: The percentage that each new extent will
increase in size after the first Next Extent is created.
This should usually be set to zero. If % Increase is set to
zero, then each additional extent will be the size of the
current extent. If % Increase is set to 100, then each
additional extent will be twice the size of the previous
extent.
% Free: The percentage of space in a table that will be
left free for future updates to a row. % Free is set in
conjunction with % Used. The sum of % Free and %
Used is always less than 100%.
STEPS IN LIBRARY GENERATION
49
% Used: The minimum percentage of used space in a
table’s data block. A data block will become available
for data insertion when % Used falls below the
specified value. % Used is set in conjunction with the
% Free variable. The sum of % Free and % Used is
always less than 100%.
25.3 Click OK to return to the Edit Table Information dialog
box.
To print the table information, click Print.
When you have finished editing all tables, click OK to
save your changes and return to the Oracle Tablespace
Selection dialog box.
Follow these same instructions to edit table
information for the validation tablespace.
26. Oracle libraries only. On the Oracle Tablespace Selection
dialog box, you can choose to modify any of the default
tablespaces or newly defined tablespaces. (If you do not
want to modify a tablespace, skip this step.)
To modify a default tablespace:
50
CHAPTER 3
26.1 Highlight the tablespace you want to edit and click
Edit.
26.2 On the Tablespace Maintenance dialog box, modify the
tablespace information as necessary.
Tablespace Name: The logical name of the tablespace is
displayed. This field is not editable.
File Name: The file name, including the path, of the
tablespace’s data file. If you do not specify a path, the
file is created in the Oracle default directory.
File Size: The size of the tablespace in megabytes (MB).
Library Generator has determined the appropriate size
of the tablespace according to the information you
entered earlier. If you want to change this size, enter the
new information.
Click OK to save your changes and return to the Oracle
Tablespace Selection dialog box.
27. Oracle libraries only. To create a tablespace, click New on the
Oracle Tablespace Selection dialog box. (Skip this step if you
do not want to create a new tablespace.) Only tablespaces
assigned as one of the DOCS tablespaces will be created.
STEPS IN LIBRARY GENERATION
51
27.1 On the Tablespace Maintenance dialog box, enter the
Tablespace Name, File Name, and File Size.
Tablespace Name: Type the logical name of the
tablespace to be created. Be sure that this name is
unique for this library.
File Name: Type a fully qualified tablespace name. This
will be the name of the physical file on your SQL server.
If you do not fully qualify the path, Oracle places the
file in a default directory.
File Size: You can choose an initial file size at this time
or, if you choose this tablespace as the profile,
validation, or index tablespace, Library Generator will
determine an appropriate size when this tablespace is
selected for use. If you set the size now, Library
Generator will not compute a size at that time.
27.2 When you have completed the fields, click OK. You are
returned to the Oracle Tablespace Selection dialog box.
The new tablespace appears in the list with the default
tablespaces.
52
CHAPTER 3
28. Oracle libraries only. When you have finished editing the
table and tablespace information on the Oracle Tablespace
Selection dialog box, click OK to bring up the Oracle
Temporary Tablespace Creation dialog box. DM requires
you to define a temporary tablespace.
Temporary Tablespace Name: The logical name of the
temporary tablespace. The default is DOCSTEMP. Accept
the default or enter a new name.
File Name: The name of the tablespace’s data file. The default
is DOCSTEMP.DBF. If no path is specified for the file, it will
be created in the Oracle default directory, so you should
enter a path here. The full path and file name must be
unique on the server.
File Size: The default of 20 MB is appropriate for most
installations. Although we do not recommend making the
temporary tablespace smaller than 20 MB, you can make it
larger. A larger temporary tablespace will improve
performance if your installation issues an above-average
number of queries.
When you have finished making your changes, click OK.
STEPS IN LIBRARY GENERATION
53
29. Oracle 8i libraries and Oracle 9i libraries with
undo_management set to MANUAL only. These Oracle
libraries require the creation of a tablespace containing
rollback segments. This number is based on the number of
expected active Oracle users.
Number of Oracle Users: Type the number of users you expect
to have on the library. The number you enter here will affect
the number of rollback segments.
Number of Rollback Segments: A rollback segment is used for
recording uncommitted transactions. You can type a value
here or let Library Generator define the number of rollback
segments necessary based on what you entered in the
Number of Oracle Users field. You should have at least four
rollback segments and no more than 50. Dividing the
number of Oracle users by four will give you the
approximate number of rollback segments you should have.
Tablespace File Name: Type a fully qualified tablespace name.
This will be the name of the physical file on your SQL server.
If you do not fully qualify the path, Oracle will place the file
in a default directory.
54
CHAPTER 3
Note: If the block size for your Oracle instance is larger than
4 KB, enter zero for the number of rollback segments.You
must create any additional rollback segments manually.
30. Oracle libraries only. On the Create Redo Log Files dialog
box, specify the number of additional redo log files to be
created for your database.
Current number of redo log files: The number of redo log files
currently available for the database.
Maximum number of redo log files allowed: The maximum
number of redo log files allowed by your operating system.
Additional redo log files to be created: The number of
additional redo log files to create for this database.
Directory name: The full path where the redo log files should
be created. You must enter a path here.
STEPS IN LIBRARY GENERATION
55
31. On the Select Primary Document Server dialog box, enter
information about the library’s primary document server, as
described below. (This dialog box does not appear if you are
regenerating a library.)
Physical Location: Enter the server and volume name where
documents will be located. (Note that a volume name, not a
directory/folder name is required here.) If you are using a
Microsoft server cluster, the Windows server name should
be the name of the cluster’s virtual server.
Operating System: Select the document server’s operating
system from the list.
The selection called Generic should be used for a Unix
document server or a Windows share—either NTFS or
FAT—with no network-operating-system (NOS) level
security provided by the Document Server Security Service
(DSSS) or the Document Server Sentry Agent (DSSA). If the
document server is a Windows NTFS machine and you do
not want to create user accounts, select Generic.
56
CHAPTER 3
To implement NOS-level security on a Windows document
server, you must run either the Document Server Security
Service (DSSS) or the Document Server Sentry Agent
(DSSA). Both security services are provided with DM. For
DSSS installation and setup instructions, see Setting Up a
DSSS Document Server. For DSSA installation and setup
instructions, see Setting Up a DSSA Document Server.
To define a document server of operating system type DSSA
on Windows , you must be a member of the domain
ADMINS.
We do not recommend the use of standalone document
servers for sites implementing failover and load balancing,
because the drive letter may indicate a different drive to each
server in the cluster.
32. Library Generator begins creating or updating the library’s
tables, columns, views, and indexes.
33. During this process, you are asked if you want to allow
duplicate document names in the library.
If you answer Yes, users may give multiple documents the
same document name. If you answer No, the library requires
unique document names. If you are regenerating the library
and duplicate document names are already permitted, this
question is not asked.
STEPS IN LIBRARY GENERATION
57
34. On the Common SQL Login dialog box, enter the name and
password of a SQL user account that will be used for all enduser transactions against the library. Note that this account
should not have privileges that would permit changes to the
library. (This dialog box does not appear if you are
regenerating a library and have previously designated a
common SQL login.)
35. Select the Use Trusted Connection check box to allow your
users to authenticate using either the common logon or
through Windows Authentication.
Note: If you click Cancel at the Common SQL Login dialog box, the common
login scheme is used with DOCSADM as the login account.
58
CHAPTER 3
36. On the Application Integration dialog box, the applications
you select determine what applications are shown in endusers’ displays, provided that the selected applications have
been integrated with DM.
In DM Webtop. when creating a new document, the
available applications will be listed on the Applications tab.
In DM Extension for Windows Explorer and DM Extension
for Microsoft Outlook, the icons for the selected
applications are displayed in the Applications node.
STEPS IN LIBRARY GENERATION
59
37. Click OK when the Information dialog box about adding
users appears. (The dialog boxes pertaining to user
synchronization are not shown for library upgrades.)
38. The User Synchronization dialog lets you add users to the
library. You can add users now, or later—using the Library
Maintenance tool on the Start menu or via the User tab in
DM Admin on the DM Webtop. We recommend you add
users later and that you click Close now and skip to step 40
on page 64.
60
CHAPTER 3
If you prefer to add users now:
38.1 To import users contained in any of the network
objects displayed, highlight the item in the Network
Resources list and click Import Users.
Network Resources: The Network Resources list displays
all available networks. Double-click a network to
display domains, servers, countries, or organizations—
depending on the network selected. In hierarchical
networks, such as NetWare, you can display the entire
network tree. To display the users in a particular object,
double-click the object to expand the list.
Library Users: The Library Users list displays the current
users of the library and their network aliases. If this is a
new library, the only valid library user is the user
executing Library Generator. Double-click a user to
display his or her associated network aliases.
STEPS IN LIBRARY GENERATION
61
38.2 On the Synchronization Defaults for New Users dialog
box, select the defaults for new users imported into the
library. You can enter the user defaults or leave the
dialog box empty; then click OK. For more information
on user defaults, see the People Maintenance section of
Library Maintenance.
38.3 When synchronization is complete, the Library Users list
on the User Synchronization dialog box contains an
entry for each network login in the selected resource.
You can continue to import users from multiple
network resources.
38.4 You can also associate an alias from each available
network to each library user. Select a network ID from
the Network Resources list and a user from the Library
Users list. Click Add Alias to associate the network ID
with the library user.
62
CHAPTER 3
38.5 To remove a network alias, highlight the alias in the
Library Users list and click Remove Alias. The selected
network ID is no longer associated with a user in the
library.
38.6 When you have completed user synchronizations, click
Close.
39. Oracle libraries only. We strongly recommend you click Print
on the Important Notice dialog box to print the list of
rollback segments created for Oracle. After library
generation is complete, you will need to add these segments
to INIT.ORA so that the segments will come back online
should the Oracle instance ever be restarted. When the print
job is finished, click OK.
Note: This dialog box does not appear for Oracle 9i databases whose
undo_management setting in INIT.ORA is set to AUTO.
STEPS IN LIBRARY GENERATION
63
40. When library generation is complete, an Information
dialog box appears. Click OK to exit Library Generator.
From this point, you need to take the following steps to prepare the
library for production use:
•
Oracle libraries only. Using the list of rollback segments
you printed in step 39, add the new segments to the
ROLLBACK_SEGMENTS line in INIT.ORA. This is
required so the rollback segments will come back online if
the instance is ever restarted.
•
Populate the library with any existing data your
organization has. Use the Database Import and Library
Maintenance tools for this activity. Instructions on using
these tools can be found in their respective help systems.
•
Set up library parameters using Library Maintenance.
•
Set up a document server using Library Maintenance.
Existing documents can be imported into the library with
the Document Import tool. For information on
Document Import, see the tool’s Help system.
•
Grant users access to the library using Library
Maintenance. See the People Maintenance section of
Library Maintenance for instructions.
Using Mixed and Windows Authentication for SQL
Server Authentication
You can select the Use Trusted Connection check box on the Common
SQL Login or the Trusted Connection check box on the DB administrator
Login dialog box, which allows your users to authenticate using either
the common logon or through the new trusted connection. Doing so
replaces the username and password entries in the [DM Library] section of
the pcdocs.ini file.
This changes the SQL server connection from using the mixed mode
common logon (DOCSADM or DOCSUSER) to use the current
logged on Windows user (DOMAIN\FusionAdmin).
You must add the network user accounts to the SQL server to allow
the domain users to connect to the SQL server. The domain user
logons are not added to the SQL server by using the DM Admin tools.
If user accounts have not been added to the SQL server, a ***TRUSTED***
line appears in the logon dialog box for the Windows Administration
tools when users try to connect; entering a valid common logon such
as DOCSADM will not allow a connection to the database.
Although rerunning Library Generator on the library will reinsert the
USERNAME and PASSWORD sections in the pcdocs.ini file, the DM server
will continue to connect through Windows authentication when the
TrustedConnection setting is enabled. After running Library Generator,
you must reset this pcdocs.ini file setting.
You can configure each library to run either mixed mode (common
logon) or to use Windows authentication, so it is possable to run both
connection types to different libraries from the same DM server.
Changing Database
Access from Trusted
Connection
When you create a database, you can select the Trusted Connection check
box when you generate the DM library in Library Generator.
However, there is no configuration user interface to revert to the other
database login method. When you create a library you must supply
USING MIXED AND WINDOWS AUTHENTICATION FOR SQL SERVER AUTHENTICATION
65
the DM Admin user name so that the database objects can be created
and an operational login (Common SQL Login), which is used by
DM Server and the Server Admin Tools to access the newly created
database; this information is stored in the pcdocs.ini file.
The following procedure is for altering the operational login in the
pcdocs.ini file because the DM Admin user is only used once for the
creation of database objects.
The user DOCSUSER can be replaced with a database user of your
choice.
In Microsoft SQL Server:
1. Create the new user login if it doesn't already exist. You
can run this command if it already exists:
CREATE LOGIN [DOCSUSER] WITH
PASSWORD='your password'
GO
2. Add the DOCS_USERS role if it doesn't already exist. You
can run this command if it already exists
USE [librarydbname]
GO
sp_addrole [DOCS_USERS]
3. Add the DOCSUSER to the database.
USE [librarydbname]
GO
sp_adduser DOCSUSER,DOCUSER,DOCS_USERS
GO
sp_grantdbaccess DOCSUSER
GO
Grant all to DOCSUSER
GO
4. Edit the pcdocs.ini file (run as Administrator rights
required). For example:
[Library Trusted]
Vendor=3
Database=Trusted
Owner=
Location=localhost
66
CHAPTER 3
TrustedConnection=yes
Remove or comment out Trusted Connection=yes
and add UserName=DOCSUSER (or DOCSADM). See the
example below.
[Library Trusted]
Vendor=3
Database=Trusted
Owner=
Location=localhost
;TrustedConnection=yes
UserName=DOCSUSER
5. Change the Primary Library to your library name (if it
isn't already).
6. Save the pcdocs.ini file.
7. Start Library Maintenance. When the message appears
stating that the login failed, press OK.
8. You are prompted to enter the DOCSUSER password;
enter the password and press OK.
9. Edit the pcdocs.ini file again and copy the encrypted
password into your copy/paste buffer.
10. Update the REMOTE_LIBRARIES table with the new user
name and password.
Use [LibraryDBName]
GO
UPDATE DOCSADM.REMOTE_LIBRARIES SET
LIB_LOGIN_NAME='DOCSUSER',
SQL_PASSWORD='paste in your ENCRYPTED
password here' WHERE SYSTEM_ID = 0
USING MIXED AND WINDOWS AUTHENTICATION FOR SQL SERVER AUTHENTICATION
67
Chapter
4
Creating an Index
In This Chapter
This chapter explains how to run the DM Indexer Configuration
Wizard to:
•
Specify an account that the DM Indexer/SearchServer uses
to access documents for indexing.
•
List the indexes created for each library.
•
Create a full-text index for a repository.
•
Start the index.
•
Make the index available to users.
All settings established through the wizard may be modified later in the
DM Server Manager or the wizard. See the chapter entitled Using the
69
DM Indexer in the DM Administration Guide for more information on
full-text indexing.
Running the Wizard
To run the DM Indexer Configuration Wizard:
1. From the Start menu, click Programs>Open Text\DM
Server>DM Indexer Configuration Wizard.
2. The Specify Internal User Account dialog box appears. To
index a document for full-text searching by users, the DM
Indexer and SearchServer open the document and read its
contents. To do this, SearchServer must first log on to DM
Server with a DM library user ID that has universal read
access (the rights to read all documents in the repository).
See the DM Administration Guide for more information on
setting up the Indexer user account.
Note: If you do not designate an internal user, the default
internal user will be used for indexing and preview
generation. The user name of the default internal account is
INTERNAL.
No domain is specified for this account to allow indexing
across multiple domains. If the Indexer is accessing
document servers in multiple domains, this account must
exist, with the same user name and password, in each
domain.
If you later decide to change this account, you can do it on
the Internal User tab in the DM Server Manager or you can
run the wizard again from the Program menu.
On the Specify Internal User Account dialog box, enter a
user ID and password; then click Next.
3. The Available SearchServer Indexes dialog box appears. If
SearchServer indexes exist for your libraries, they are
displayed on this page. For each index, the state is displayed.
Possible states are:
Initialized. An entry for the index has been created in the
library, but documents have not been indexed yet, so the
index is not available for searching.
70
CHAPTER 4
Started. The index is available for searching and for
indexing of new and revised documents.
Stopped. The index is available for searching but is not
available for indexing of new and revised documents.
Paused. The index is available for searching, but it is not
available for indexing of new and revised documents
because the DM Indexer is paused for system maintenance.
When the DM Indexer resumes operation, the index will be
available for indexing.
4. To create a new index, select the check box Create new index
and click Next. Then follow the instructions on the Create
Indexes page. If you don't want to create an index, clear the
check box and click Next.
If you do not want to create a new index now, clear the
check box and click Next. Then skip to step 7.
5. The left pane of the Create Indexes dialog box shows the
libraries you have selected to be available to DM users. Click
to insert a check mark next to the library you want to create
an index for and click Add.
RUNNING THE WIZARD
71
The index name is added to the right pane as <library
name> Index.
Note: If your library does not appear in the Add Indexes
Libraries list, it is not a selected logon library for your DM
Server, which is required for indexing. Libraries that appear
at the top tree level on the Libraries tab in Server Manager
or the Select Libraries dialog in DM Server Configuration
Wizard are valid for logon and have a Library section in the
PCDOCS.INI specified for use by the DM Server.
6. On the Create Indexes dialog box, highlight the new index
name and click Properties.
Note: The Remove button lets you delete the database entry
for indexes you have created but not yet initialized. It cannot
be used to delete indexes that contain data.
Specify the index properties as described below. Then click
OK.
6.1 Location & Sharing tab:
72
CHAPTER 4
Index Name: If you want to change the default index
name, modify the name in this field.
Data Source Name: By default, DM Server assigns an
index a data source name in the format <library
name>_<number>.
Path—Default: Select Default to store the index in the
default location, a location which was specified when
you installed the DM Server software on the Indexer
server. (By default, this location is C:\Documents and
Settings\All Users\Application Data\Open Text\DM
Indexes. .) To store the index in a different location,
clear the Default check box and enter the Path.
Remote—Shared: The option you select here depends
on whether you are running Server Manager from the
Indexer server or from a DM Server that handles
requests from DM Webtop users.
Select Shared if the Indexer server is the local machine
and users will be accessing the index via other DM
Servers or KM. Then select the appropriate Network
Protocol and Port so that users accessing the local
server can locate the index. The port cannot be used by
other indexes on the server or by other software using
the network. For Named Pipes, the port is the name of
the pipe (for example, ftnet). For TCP/IP, the port is
the TCP port number (for example, 3048). The TCP\IP
port number cannot be in use on the local system. (To
determine the port numbers in use, run NETSTAT at a
command-line prompt.) Normally, anything higher
than 5000 is a usable port number.
Note: Once a port number has been assigned to an
index, it cannot be used again until you run
\SSK\BIN\FTSVCADM.EXE to remove unused port
numbers. (Do not remove port number 16547; it is
used by DM Server.) After removing the ports, restart
the DM Server service. At this point, you can then add
a new index with the previously used port number.
The Remote option is automatically selected if you
create a shared index on one server and are viewing the
properties of that index on another server.
RUNNING THE WIZARD
73
Note: A single library cannot have more than one
shared index on an Indexer server.
6.2 Index Properties tab:
Language: Select the language of your documents and
profiles. If your documents are in a language other
than the choices listed here or you are not sure what to
choose, select Other.
The Unicode option is a language option. This option
lets you create an index containing information for
documents of various languages instead of targeting a
specific language. The Unicode option defaults to a
character set value of UTF8. The advanced linguistics
properties available for other languages are not
supported by the Unicode option.
74
CHAPTER 4
Advanced: This button invokes the Advanced Index
Properties dialog box. When you select a language,
most of the advanced properties are modified to the
defaults for the language. A description of the
advanced index properties can be found in the chapter
on indexing in the DM Administration Guide.
Compress Index: When a new document is created or
a document is changed, SearchServer indexes the new
data in a temporary file called <index name>.DYX.
User searches are performed against both the index and
the DYX file until the DYX file is merged into the
index. The Compress Index option performs the merge
operation.
To schedule a regular weekly compression of the index,
enter a day and time in the fields provided. To
compress the index every day, select the option Daily
and enter a time. The Indexer will automatically be
stopped while the index is undergoing compression, so
no new documents will be indexed. But users will be
able to search against the index during that time.
See the DM Administration Guide for more about
compressing indexes and for instructions on manually
compressing an index.
Schedule Backup: This option lets you schedule a time
when the Indexer pauses for system backups or
regularly scheduled maintenance. While the Indexer is
paused, documents are not indexed, but users can
continue searching against indexes. You can schedule
the pause on a daily basis (Daily) or on a specific day of
the week. In the At field, select the time when you want
the Indexer to pause. Note that if the Indexer is
indexing a batch of documents or compressing the
index, it will complete these operations before pausing
for the backup. So we recommend you schedule the
pause approximately 30 minutes prior to the backup,
to give the Indexer time to finish.
RUNNING THE WIZARD
75
In the Backup Duration field, select the number of
hours—between 1 and 24—to pause the Indexer. It is
important to allow sufficient time for backups to
finish. We recommend you monitor the time required
for backups and adjust the Backup Duration value as
necessary so the Indexer does not resume processing
while the backup is still running.
If you don't want to pause the Indexer during backups,
select Never in the Schedule Backup field.
Startup Type
By default, Startup Type is set to Manual, which means
that indexing for this index must be started manually
by the DM administrator.
Manual: Indexing must be started manually by the
DM administrator by selecting the index on the
SearchServer Indexes tab and clicking Start.
Automatic: Indexing starts automatically when the
DM Server service starts.
Enable Periodic Mode Indexing: The periodic-mode
indexing feature allows SearchServer to switch to
periodic mode for more efficient indexing of large
numbers of documents. When Enable Periodic Mode
Indexing is selected, the indexer automatically goes
into periodic mode when a large number of
documents—100 or more—is in the indexing queue.
This primarily occurs when the index is being
initialized or reindexed. By default, Enable PeriodicMode Indexing is turned on. To turn it off, clear the
check box. (See the section titled “The Indexing
Process” in chapter 2 of the DM Administration Guide
for more information on periodic-mode indexing.)
Click Apply to have any changes you made take effect.
76
CHAPTER 4
6.3 Log File tab:
The index log contains a record of indexing activities,
including:
Times when the index was started and stopped.
Times when the index paused for a backup and when it
resumed indexing after the backup.
Times when the index was compressed.
A list of the documents being indexed by document
number.
Any errors that occurred during indexing.
To disable index logging or to locate it elsewhere, go to
the SearchServer Indexes tab, select the index, and click
Properties. On the Index Properties dialog box, click
the Log File tab. On this tab, you can also open the log
file for editing by clicking Open with Notepad. And
you can obtain the latest indexing information by
clicking Refresh.
RUNNING THE WIZARD
77
Log Enabled: By default, logging of index activities is
selected. To turn off logging, clear this check box.
Log File: By default, the log file is located in the folder
C:\Open Text\DM Indexes\<library name>\<index
system ID>\<index name>.xlg. To locate it elsewhere,
enter the path name here.
Open with Notepad: Allows you to open the log file
for editing.
Refresh: Allows you to refresh the log file to obtain the
latest indexing information.
Click Apply to have any changes you made take effect.
7. When the Start Indexes dialog box returns, you have the
option of initializing the new index, which fills the index
with data from your documents. This is a process that can
take some time if your document library is large and
complex, so if you want to skip initialization for now, click
Finish. Note that users will not be able to search against the
new index until it has been initialized. To start initializing
the new index, highlight the index name and click Next.
8. Indexes whose startup method is Started are automatically
available for searching and indexing when the DM Server is
running. If an index's status is Initialized or Stopped, you
can start the index manually by highlighting the index and
clicking Next.
9. To start multiple indexes, depress the Ctrl key and left-click
each index name.
10. Once the new index has been initialized, you can select it as
the one users of the library will use by highlighting the
library, clicking Add, and selecting the new index.
On the Select Indexes for User Searches dialog box, the
index or indexes that are available for searching by DM
Webtop users are displayed in the Indexes Available to
Clients pane. The list changes when you highlight a different
library in the Libraries pane.
If you have multiple indexes for a library, you can select up
to 10 SearchServer indexes for user access.
When employing multiple indexes, you have two options:
78
CHAPTER 4
Use All Indexes in Sequence. Using all the indexes in a
round-robin fashion to improve search performance. In this
mode, the first search request goes to the first index in the
list, the second request to the second index, and so on, until
the end of the index list is reached, and the first server
accepts another request.
Use Next Index in List Only When Current Index Fails.
Using a single index as the primary index and the others as
backups in case the first index is not available. In this mode,
when the primary index fails, search requests go to the next
index in the list until the primary index returns to service.
To see all indexes for a library—including those that are not
selected for user searching—highlight the library name and
click Add. To make another index available for searching,
highlight the index name and click OK. The index is added
to the Indexes Available to DM Webtop Users list.
To change the order of an index in the list, highlight the
index and click the Up or Down key. The Remove key
deletes an index from the list.
11. Click Finish to exit the wizard.
RUNNING THE WIZARD
79
Chapter
5
Installing DM WorkFlow
In This Chapter
This chapter explains how to install the server components for DM
WorkFlow.
Question to Reviewers: Do we want to keep the part about upgrading from DOCSFusion
Routing
81
Before You Begin
Installation
Prerequisites
•
The SQL engine must be installed in a location accessible to
the machine where you are about to install DM WorkFlow
Server Components and a SQL client must be installed on
the DM WorkFlow Server Components.
•
You must create or know the DM WorkFlow (Routing
Agent) service account. See Setting Up the DM WorkFlow
(Routing Agent) Service Account for information on this
account.
•
On the server where you are installing DM WorkFlow Server
Components, you must be logged on under a local
Windows Administrator account with the advanced rights
of “Act as part of the operating system”, “Log on as a batch
job”, and “Log on as a service” enabled.
•
Exit any programs that are currently running on the server
machine.
•
Refer to “Configuration Choices” on page 83 for
recommended multi-machine configuration information
that is in addition to the prerequisites listed above.
•
If you are using an Oracle SQL server, we recommend you
create additional tablespaces for DM WorkFlow tables to
avoid adding DM WorkFlow information to Oracle default
tablespaces and to make it easier to administer the Oracle
server. See “DM WorkFlow Oracle Tablespaces” on page 173
for instructions.
Setting Up the DM WorkFlow (Routing Agent) Service Account
This section describes the requirements for the DM WorkFlow service
account under which DM WorkFlow Server runs. Please see Creating
the Account for the information how to set up the account on Windows
servers.
About the DM WorkFlow (Routing Agent )Account
The DM WorkFlow service requires network access, so it must be run
under an account that has the following privileges and abilities:
82
CHAPTER 5
•
Access to the network and to all document servers, libraries,
and SQL databases. The DM WorkFlow service account is
not required to be a domain account, but we strongly
recommend that you make it a domain account because it
must typically access data on other network resources.
•
"Act as a part of the operating system" rights.
•
"Log on as a service" rights.
•
"Log on as a batch job" rights.
•
Membership in the local administrator group on the local
machine. The account need not be a member of the Domain
Admins group.
Oracle Users
During the first time install of DM WorkFlow Server Components, the
DM WorkFlow Database Generator by default suggests using Oracle
SYSTEM tablespace for USER tables and TEMP for Temporary ones.
See “DM WorkFlow Oracle Tablespaces” on page 173 for more
information.
Configuration
Choices
One-machine configuration:
Server: DM WorkFlow Server Components and DM WorkFlow
are installed on the same computer with DM, DM API, and a
supported Web server.
Clients: A supported Web browser or DM WorkFlow Extension.
Two-machine configuration:
Machine 1: DM WorkFlow Server Components with DM API and
a supported SQL client.
Machine 2: DM WorkFlow with DM API, DM, and a supported
Web server.
Clients: A supported Web browser or DM WorkFlow Extension.
If you install DM WorkFlow Server Components and DM
WorkFlow on two different computers, you must replace the IIS
Anonymous User account with the special domain account or add
the first as a local account on the computer where WorkFlow
BEFORE YOU BEGIN
83
Engine runs. The account must have the launch and access
permissions for the DM WorkFlow application in the DCOM
settings.
DM WorkFlow Server Components Overview
The DM WorkFlow Server Components include the following:
•
DM WorkFlow Engine This is a COM server component.
•
DM WorkFlow Administrative Utilities These are the
tools to view and modify data within the WorkFlow system.
•
DM WorkFlow Agent This is a Windows service that
performs the following tasks: data replication, time-out
operations, mail notifications, automatic user
synchronization, lock/unlock, and restoring rights on
documents.
You should set a Routing Agent Account to allow the WorkFlow Engine
to run on behalf of this account without logging on.
Note: If you want to enable mail notification you must have a mail client with a
valid user profile installed on the machine with the WorkFlow Engine.
• This profile should be identified on the mail server.
• The account you specify must have rights (to at least send mail) on the
mail profile you use for mail notification.
Be aware of the following:
84
CHAPTER 5
•
DM WorkFlow Server Components: the WorkFlow Engine,
WorkFlow Agent, and WorkFlow Administrative Utilities
should be installed on the DM Server machine or another
Windows Server machine.
•
The WorkFlow Agent can be installed only on Windows
Server or Windows Advanced Server machines. WorkFlow
Administrative Utilities can be installed on any client
computer.
•
Only one WorkFlow Engine can be used by clients on a
single library. In multi-library environments, each
WorkFlow library must have its own WorkFlow Engine.
•
To allow users from several DM libraries to use one DM
WorkFlow library, define one of the libraries as a primary
and the others as remote libraries. During the user
synchronization of the installation process, remember to
select the remote libraries and synchronize those users.
Note: At synchronization between several DM WorkFlow sites, the users at
each site must be synchronized with their own site’s library: do not select the
same DM library for two DM WorkFlow sites.
•
If DM WorkFlow Server Components and the SQL server
are installed on different computers, specify the same
Regional Settings with the “Set as System Default Locale”
option selected.
The common files will be copied into the following directories:
C:\Program Files\Common Files\PCD Shared\Logger
C:\Program Files\Common Files\PCD Shared\WorkFlow
After installing WorkFlow Agent, you must restart the computer. You
will also be asked to restart the computer if you are installing a
component where the one it is replacing is currently loaded in memory.
DM WORKFLOW SERVER COMPONENTS OVERVIEW
85
Installing DM WorkFlow Server Components
After ensuring that you have completed the installation and
configuration of DM Server and creation of a library, proceed with the
installation of DM WorkFlow Server Components.
To install DM Workflow Server:
1. Execute the eDOCS DM Workflow Server.msi Windows Installer
Package.
2. The Welcome to the Open Text eDOCS DM Workflow
Server Setup Wizard appears. Click Next.
3. The End-User License Agreement dialog box appears. Select
the I accept the terms in the License Agreement check box and
click Next.
4. The Custom Setup dialog box appears. Select which
components to install and click Next to continue.
• DM WorkFlow Engine
DM WorkFlow Engine is the COM server component of
DM WorkFlow. Only one WorkFlow Engine can be run
per DM library. In multiple-library environments, each
DM WorkFlow library must have its own WorkFlow
Engine. This components is required to run DM
WorkFlow.
•
DM WorkFlow Agent
DM WorkFlow Agent is a Windows service that
performs data replication, time-out operations, mail
notifications, automatic user synchronization, lock/
unlock operations, and restoration of rights on
documents. This component is required to run DM
WorkFlow.
•
DM WorkFlow Administration Tool
This component consists of the DM WorkFlow
Administration Tool, DM WorkFlow Site and User
Synchronization Utility, DM WorkFlow Replication
Administrator, and DM WorkFlow Migration Utility.
These components must be installed to properly
configure DM WorkFlow.
86
CHAPTER 5
5. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open Text\DM
Workflow Server. Click the Change button to locate a
different location, if needed; otherwise, click Next.
6. The DM Server specification dialog box appears. Type the
machine name of the DM Server to which users will initially
log on and click Next.
7. The Workflow Credentials dialog box appears. Specify the
network logon credentials of the account under which the
DM Workflow service will run. See About the DM
WorkFlow (Routing Agent )Account for more information.
Click Next.
8. The Ready to install dialog box appears. Click Install.
9. After the installation begins, the Select Database Type dialog
box appears. DM Workflow requires a database for the DM
Workflow tables. Click the drop-down menu and select
Microsoft SQL Server or Oracle. Click Next.
10. The Server Name dialog box appears. Type the SQL Server
name and then click Next.
11. The Login information dialog box appears. Enter the login
credentials for the SQL administrator. Click Next.
12. The Select Databases dialog box appears. Select the library
to work with and then click Next.
13. The DM Workflow Administrator Account dialog box
appears. Type the password you want for the WFADM
account and then click Next.
14. The DM Workflow Table Generation dialog box appears
prompting, “This will remove any previously generated DM
Workflow tables. Are you sure you want to continue?” Click
Yes.
15. When the Creating Tables dialog box shows “Completed
successfully,” click Finish.
16. The Select Database Type dialog box appears. DM Workflow
requires a database for the DM Workflow tables. Click the
drop-down menu and select Microsoft SQL Server or Oracle.
Click Next.
17. Enter the SQL Server name and click Next.
INSTALLING DM WORKFLOW SERVER COMPONENTS
87
18. The Login information dialog box appears. Enter the login
credentials for the SQL administrator. Click Next.
19. The Existing Databases dialog box appears. Select the library
to work with and click Next.
20. The Login as DM Workflow Administrator dialog box
appears. Archiving tables will be created using the DM
Workflow Administrator (WFADM) account. Enter the
password for the DM Workflow Administrator and click
Next.
21. The DM Workflow Archiving Table Generation dialog box
appears prompting, “This will remove any previously
generated archiving tables. Are you sure you want to
continue?” Click Yes.
22. When the Creating Tables dialog box shows “Completed
successfully,” click Finish.
23. The Completed the eDOCS DM Workflow Server Setup
Wizard appears. Click Finish.
Synchronizing Users
To synchronize users:
1. Select Start>Programs>Open Text>DM Workflow>DM Workflow
Site and User Synchronization.
2. On the Site and User Synchronization dialog box, select
one of the following options:
88
CHAPTER 5
•
Synchronize DM Users to DM WorkFlow users: Allows you to
synchronize DM users to the users working with
WorkFlow. You should select this option if this is for
initial installation, or to update DM Workflow users to
correspond with your DM library.
•
Synchronize Users between DM WorkFlow Sites: Allows you
to synchronize users from one site to users who are
working on other sites. Select this option to synchronize
users between two Workflow Engines.
3. The DM Workflow Site and User Synchronization dialog
box appears with the Connection parameters to Current Site and
DM Library details for Remote Site fields. (This example
illustrates a Microsoft SQL Server database: other
database types will have different fields.)
The Connection parameters appear completed; however,
you must enter the Server Name, Database Name, Password,
and Remote Server Name fields in the DM Library details
section. Click Next.
4. On the Libraries Synchronization dialog box, you can
synchronize users from several DM libraries who are remote
to your primary routing library by moving the libraries
from Available DM Libraries to DM Libraries To Synchronize. (If
you have no remote users, there will be no entries in the
Available DM Libraries field). Click Next.
5. The User Synchronization dialog box contains the tree of
DM Users and list of selected users from all available
libraries. Choose Individual users or the Synchronize all users
option and click Next.
6. On the WorkFlow Engine properties dialog box, set the
Working Hours and Time Zone for all synchronized users and
click OK.
SYNCHRONIZING USERS
89
7. The program is ready to start user synchronization for the
library. On the Complete Synchronization dialog box, click
Finish.
8. When user synchronization finishes, the Synchronization
dialog box appears. Click OK.
1 (this example illustrates a Microsoft SQL Server database: other
database types will have different fields)
Post-installation Information
DM WorkFlow
Administration
90
CHAPTER 5
To perform the additional setup necessary for DM WorkFlow, refer to
the DM WorkFlow Administration Guide. This guide includes
information about setting up mail notification, DM WorkFlow Agent
settings and using other administrative utilities.
Chapter
6
Setting Up a DSSS Document
Server
In This Chapter
This chapter explains how to install Open Text’s Document Server
Security Service (DSSS), formerly known as the NT Security Service
(NTSS). It also explains how to set up a Windows document server that
uses DSSS to implement network operating system (NOS)-level
security for document files.
91
NOS-Level Security for Document Files
NOS-level security means that when a document is secured in DM, the
rights assigned to the document apply regardless of whether the
document is accessed from within DM or outside DM via an operating
system mechanism such as Windows Explorer.
Network operating system (NOS)-level security for NTFS volumes on
Windows Server, Windows Advanced Server, and Microsoft server
clusters running those operating systems can be implemented via the
DSSS. This program is provided on the DM CD.
The Security Service applies NOS-level rights to documents according
to their access-control-list settings in the DM library. It does not apply
rights to documents that are unsecured in the library. At the NOS level,
access to unsecured documents is based on the user’s rights on the
directory.
When setting up a document server, it’s a good idea to have a basic
understanding of how DM security works. So we recommend you read
the chapter devoted to security in the DM Administration Guide before
proceeding with the activities described in this appendix.
Implementing DSSS
Implementing DSSS on a Windows document server involves the
following steps:
1. Install the DSSS software (page 93) on all servers that will be
used as document servers. If you are using a Microsoft
server cluster, you must install DSSS on each node (member
machine) in the cluster.
2. If you are using a Microsoft server cluster, configure DSSS
on each node to run under a domain account rather than
the local system account. The domain account should be the
same for all nodes.
If you are not using a server cluster, DSSS should run under
the local system account. This is automatically set when you
install DSSS.
92
CHAPTER 6
3. Create global groups in the domain for all groups that you
are using in DM (page 94). At a minimum, you must create
the following groups:
DOCS_USERS—All users who need access to the document
server must be a member of this group.
DOCS_SUPERVISORS—The DM Server service account
must be a member of this group.
If your organization does not support the management of
global groups, you can create DOCS_USERS and
DOCS_SUPERVISORS as Windows local groups. See
“Creating Windows Groups and Adding Them to the DM
Library” on page 94 for more information.
4. Create a shared directory and apply appropriate access
rights to the share. If you are using a server cluster, the
shared directory should be created on a physical disk drive
shared by the cluster.
5. Configure the document server in Library Maintenance
(page 104).
In addition, the DM Server service account must be a member of the
local administrator’s group on each document server where DSSS is
installed. See Setting Up the DM Server Service Account for more
information on the DM Server service account.
Installing the DSSS Software
To install the DM Security Service on a Windows machine:
1. Log on to the server as an administrator.
2. Execute the eDOCS DM Document Server Security Service.msi
Windows Installer package.
Or, select the eDOCS DM Document Server Security Service
component from the eDOCS Suite Installer.
3. The Welcome to the Open Text Document Server Security
Service Setup Wizard dialog box appears. Click Next.
4. The End-User License Agreement dialog box appears. Select
the I accept the terms in the License Agreement check box and
then click Next.
INSTALLING THE DSSS SOFTWARE
93
5. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open
Text\Document Server Security Service\. Click the Change
button to select a different location, if needed; otherwise,
click Next.
6. The Ready to install dialog box appears. Click Install.
7. When the Completed the Open Text Document Server
Security Service Setup Wizard dialog box appears, click
Finish.
Configuring DSSS
to Run Under
Domain Account
If you are using a Microsoft server cluster, configure DSSS to run under
a domain account rather than the local system account.
To change the account:
1. Open Services from the Control Panel>Administrative Tools or
Start>Programs>Administrative Tools.
2. Select Open Text Document Server Security Service, right-click
and select Properties.
3. On the Log On tab, select This Account and specify the domain
account logon credentials under which the Security Service
will run.
4. Click OK.
a
Install DSSS on the other nodes in the cluster and configure the service
on each node to run under the same domain account you specified in
step 10.c.
Creating Windows Groups and Adding Them to the DM
Library
Note: The information in this section also applies to Windows document
servers with the Document Server Sentry Agent (DSSA) installed. Setting Up a
DSSA Document Server describes the DSSA.
DM makes use of Windows group accounts to secure documents on
Windows document servers. To take advantage of this feature, you
should create groups that together include all network users who need
access to documents stored on the server. A Windows group should be
94
CHAPTER 6
created for each DM library group. You can then use Library
Maintenance>Group Maintenance>Group Aliases or DM Admin to associate a
DM library group—such as DOCS_USERS—with one or more
Windows groups by adding the group’s network alias.
The universal access defined in Library Maintenance for the DM library
group applies to all documents on the server. And, when an author
secures a document using a DM library group ID, the access rights he
or she assigns to the DM group apply at the network-operating-system
level.
The following Windows groups can be added to a DM library group:
•
Global groups. (A global group contains one or more user
accounts from a single domain.)
Global groups let you alias and maintain multiple users in a
single batch for each domain. Global groups can be used
across multiple document servers.
•
Local groups. (A local group may contain user accounts and
global groups from one or more domains.)
Local groups can be helpful to the DM administrator in a
multiple-domain network, particularly if the administrator
has no administrator rights beyond his or her own domain
or document server. The administrator can create a local
group that includes users or groups from other domains
and assign them access rights to the Windows document
server. Local groups must be created on each Windows
server employed as a DM document server.
When a new domain is added to the network, its users can
be given access to an existing document server by adding the
users or group to the existing local group and the
corresponding DM library group, thus avoiding the need to
run the security regeneration utility, which is required when
using multiple domain aliases.
•
A combination of the two. For example, you could include
multiple domain aliases in a single local group, alias some
groups to local groups and some to global groups, or use
multiple domain aliases for a DM library group where one is
a local group and one is a global group.
The members of a Windows group—whether global or local—must
match the members of its network alias in the DM library. If you use a
CREATING WINDOWS GROUPS AND ADDING THEM TO THE DM LIBRARY
95
local group, it must exist on all document servers, using the same name
on all servers.
See your Windows documentation for instructions on creating global
and local groups.
Adding a Global
Group to a DM
Library
When you run Library Generator, the DM groups DOCS_USERS and
DOCS_SUPERVISORS are created in the library database and aliased
to the Windows groups in the domain where you are running Library
Generator. If you want to access documents in other domains, you will
need to add the network aliases for those domains.
You can do this in DM Admin tab in DM Webtop or Library Maintenance.
DM Admin Instructions
1. In DM Webtop, click the DM Admin tab.
2. Click Users and Groups.
3. Click Groups.
4. Click the group you want to add the alias to.
5. Click Aliases.
6. Double-click the ADS, LDAP, Microsoft, or NetWare tree to
expand.
7. Highlight the Windows group(s) you want to add and click
the >> button. The alias appears under the Groups pane.
Library Maintenance Instructions
1. In Library Maintenance, click the Groups icon.
2. Double-click the group name you want to add the alias to.
3. The Group Maintenance dialog box appears; click the
General tab.
4. Click Aliases.
5.
6. In the Network Resources pane, double-click the Microsoft
icon to expand.
7. Double-click the resource and then highlight the Windows
group(s) you want to add and click Add Alias. The alias(es) is
added to the Groups list of DM library groups.
96
CHAPTER 6
Adding a Local
Group to a DM
Library
Once you have created the local group on the network, take the
following steps to add the group’s network alias to the DM library:
1. In Library Maintenance, click the Groups icon.
2. Double-click the group name you want to add the alias to.
3. The Group Maintenance dialog box appears; click the
General tab.
4. Click Aliases.
2
5. In the Network Resources pane, double-click the Microsoft
icon to expand. Highlight << LOCAL GROUP >> and click Add
Alias.
6. On the Enter Local Group Alias dialog box, type the
Windows name of the local group and click OK.
The alias is added to the list of groups in the DM library.
Multiple Domain
Aliases
DM supports multiple Windows domain aliases for groups. This
allows you to associate a single DM library group with multiple
Windows groups in the library.
All existing DM library groups need to have an alias for each domain in
your environment.
The additional group aliases can be added through Group
Synchronization or Group Aliases in Library Maintenance.
To add multiple domain aliases:
1. In Library Maintenance, select Synchronize>Groups.
2. In the Network Resources pane, double-click Microsoft. A list
of all domains in your environment is displayed.
CREATING WINDOWS GROUPS AND ADDING THEM TO THE DM LIBRARY
97
3. Double-click the domain you want to alias. The users and
groups within that domain are displayed. Verify that the
group you are adding is highlighted in the right pane
(Groups).
4. In the left pane (Network Resources), highlight the group you
are adding and click Add Alias. You can double-click the new
group in the right pane to see the new domain.
98
CHAPTER 6
At the NOS level, the new aliased DM groups need to be
applied to the directory permissions in the same fashion as
the existing groups. Each new group should be added at the
last static directory in the document path template with
Special Access Permissions.
5. When applying groups at the NOS level, select Replace
Permissions on Directories and Replace Permissions on Existing
Files. This guarantees that directory permissions are added
to all documents in all directories. Click OK.
Warning: Until step 7 below is completed, DOCS_USERS in all domains have
rights to all documents. This step is required to restore the current access
control list (ACL) security to all documents.
6. If you are using a group other than the group EVERYONE at
the share level, the corresponding group must be added at
the share with Full Control.
7. If you are modifying groups for an existing library, run the
Security Regeneration utility on all documents. This utility
reapplies security to all previously secured documents. Until
you run the Security Regeneration utility, the ACL on
Document Profiles and NOS-level security are not
synchronized, so documents are not secured. See the DM
Administration Guide for instructions on running this
utility.
Creating a Windows Share and Granting Users Access
The next step is to create a share where documents can be stored on the
Windows server; then grant users access rights to the share. If you are
using a Microsoft shared cluster, the share should be created on a
physical hard disk shared by the cluster.
The network group DOCS_USERS and the account under which the
DSSS runs should have full-control access to the new share. If your
environment consists of DM users only, the group EVERYONE can be
added with full-control access to the share instead of DOCS_USERS.
CREATING A WINDOWS SHARE AND GRANTING USERS ACCESS
99
To create a share and grant the users access to it:
1. Using Windows Explorer, highlight the drive where you
want to create the share.
2. From the menu bar, select File>New Folder. Type a name for
the folder and press enter. For example, eDOCS.
3. Highlight the new share, right-click, and select Sharing and
Security to bring up the share's Properties dialog box.
4. On the Sharing tab, click Share this folder and give the share
the same name as the folder you created in step 2.
100
CHAPTER 6
5. Click Permissions to bring up the Share Permissions dialog
box.
CREATING A WINDOWS SHARE AND GRANTING USERS ACCESS
101
6. Click Add to bring up the Select Users or Groups dialog box.
In the Enter the object names to select field, type SYSTEM and
then click Check Names. Click OK.
102
CHAPTER 6
7. In the Permissions dialog box, highlight the SYSTEM account
and select Full Control.
8. Repeat the above steps for the DM Server service account
and the DOCS_USERS group.
9. At the Permissions dialog box, highlight the Everyone group
and click Remove to remove the Everyone account.
10. Click OK to return to the share's Properties dialog box.
11. You will also need to apply directory rights for SYSTEM, the
DM Server service account, and DOCS_USERS within the
share. At a minimum, the SYSTEM account should have Full
Control access and the DOCS_USERS account should have
Change access at the last static directory where documents
will be stored.
CREATING A WINDOWS SHARE AND GRANTING USERS ACCESS
103
You will need to create static directories according to your
document path template in Library Maintenance>System
Parameters before applying permissions. See the DM
Administration Guide for more information.
12. To apply directory rights, highlight the shared directory
from Windows Explorer, right-click and select Properties to
display the directory's Properties dialog box.
13. Click the Security tab to display the directory's security
settings.
14. Click Add and add SYSTEM, the DM Server service account,
and DOCS_USERS as accounts, giving SYSTEM and the
DM Server service account Full Control access and
DOCS_USERS Modify access. If other trustees appear in the
list, highlight each one and click Remove.
Note: If additional trustees are inherited from the parent object, click
Advanced and then clear “Allow inheritable permissions from parent to
propagate to this object” and select Remove at the Security warning dialog
box.
15. You may be asked if you want to replace the security
information on all existing subdirectories. Click Yes.
16. Click OK at the Properties dialog box to save changes.
Once you have completed the preceding steps, you need to configure
your document server in Library Maintenance.
Configuring the Document Server
One document server was added during your initial library generation.
To configure additional document servers, you must have supervisory
rights with access to Library Maintenance.
To configure a document server:
17. In Library Maintenance, click Document Servers. Click the
New
icon.
18. In the Document Servers dialog box, complete the following
fields:
Physical Location:\\<2000 server name>\<share name>
104
CHAPTER 6
If you are using a Microsoft server cluster, the 2000 server
name should be the name of the cluster’s virtual server.
Operating System:Server with NTFS
Media Type:Online
The other fields on the dialog box are optional.
Once these steps are successfully completed, users can begin storing
documents on the new document server.
Starting and Stopping DSSS
If you did not select the Automatic Startup option during installation
of the DSSS software, you will need to start the service manually to have
security applied when users are creating and retrieving documents on
the server.
There may be times when you need to stop or start the service, even if
you are operating in automatic startup mode. The following
instructions describe how to do this as well as how to change from
manual to automatic mode if you decide it’s preferable to start the
service automatically.
On Windows
Server
To start and stop DSSS on Windows Server:
1. Select Services from Start>Programs>Administrative Tools.
2. Highlight DM Document Server Security Service. To stop
the service, select Action>Stop from the menu. To start the
service, select Action>Start from the menu.
3. To change a startup option, double-click the highlighted
service, or select Action>Properties from the menu. This will
display the service's properties.
STARTING AND STOPPING DSSS
105
Troubleshooting DSSS
106
Error
Possible Cause
Action
No mapping between
account name and security
ID was done when security
check box is selected.
The users and groups are
not synchronized.
In Library Maintenance,
synchronize users and
groups. Verify that the
users and groups in the
PEOPLE table match the
users and groups in
Windows NT.
DM File Security Service
was not found on server
\\<server name>.
The client received a NOT
FOUND error when it tried
to connect to the service’s
named pipe.
This occurs when the
service is not installed or
has stopped responding.
DM File Security Service
was too busy to service a
request.
An unlikely condition that
occurs when use of server
resources is extremely
high.
Determine what process is
using excessive server
resources and adjust the
server load.
CHAPTER 6
Chapter
7
Setting Up a DSSA Document
Server
In This Chapter
This chapter explains how to set up the Document Server Sentry Agent
(DSSA) to provide document security on Windows document servers.
107
About DSSA
The Document Server Sentry Agent (DSSA) gives an extra measure of
security for DM documents stored on Windows document servers, and
Microsoft server clusters running those operating systems. This extra
protection is not apparent to users and requires no additional effort on
their part. On a DSSA document server, the usual security protocol
applies: only users with rights to a document can access that document
in DM.
The security provided by DSSA comes into play beyond the reach of
DM security. On a non-DSSA server, any user who has network rights
to a document can access that document outside DM—from Windows
Explorer, for example—even if he or she has no rights to the document
in the DM library. If the document is on a DSSA server, however, the
sole access to that document is through the DM library, where the
access rights set up by the author apply.
Understanding How DSSA Works
Documents on a DSSA document server are stored on a Windows share
just as they are in a normal Windows environment. The difference is
that the DSSA service has exclusive access to the documents. This
prevents a user who may have access to a document via a DM Webtop
application from accessing the document outside of DM.
When a document is placed on a DSSA document server, it is stored
along with two small accessory files: one file contains the document’s
access control list (ACL); the other contains the document’s audit trail
information.
What happens when a user accesses a document? DM Server connects
to the DSSA service and requests access to the document. Write access
is requested if the user is opening a document for editing. Read access
is requested if the user is printing or viewing the document.
The DSSA service receives the request for access to the document.
DSSA actually impersonates DM Server, making the request to prevent
any fraudulent connections. The user account and group membership
are compared to the DSSA-maintained ACL. If the user has sufficient
rights, DSSA temporarily grants the user access to the document.
108
CHAPTER 7
What happens when the user closes the document or the user’s
connection is terminated? DSSA removes the user’s access rights to the
document. It also appends a record to the document’s audit trail.
However, if the user saves the document as a new version, he or she will
still have access to the original document. Once the new document is
closed, the user’s access rights to the original document and the new
version are removed.
DSSA System Requirements
Operating
System
See the release notes for supported operating systems.
File System
You must use an NTFS volume for DSSA.
Hardware
DSSA runs on Intel x86 and Intel Pentium.
Memory
The DSSA document server is implemented as a Windows service. If
your document server is properly configured with the recommended
memory required for other services and the number of users on the
server, no additional memory is required for DSSA.
Disk Space
You need the disk space required for the documents to be stored on the
DSSA document server, plus an additional 4 to 8 KB per document.
DSSA stores two small files with each document: one for the accesscontrol list, the other for the audit-trail records.
Network
Protocol Support
Windows clients connect to DSSA document servers using the default
protocol in use by the Microsoft network. No additional software or
configuration is required to connect these clients to a DSSA server.
Prerequisites for Installing DSSA
Before DSSA can be installed:
•
The DSSA service must be installed on the same machine or
share as the document server(s). If you are using a Microsoft
server cluster, you must install DSSA on each node
(member machine) in the cluster.
DSSA SYSTEM REQUIREMENTS
109
•
To install DSSA, you will need to provide a serial number
and password.
•
The DM Server service account must be a member of the
local administrator’s group on each document server where
the DSSA is installed. See Setting Up the DM Server Service
Account for more information on the DM Server service
account.
•
The DSSA admin account—a domain user account—must
be created on the domain of the server where the DSSA
document server will reside. This user must be a member of
the domain administrators group. It will be the account
under which the DSSA service runs and which will own all
documents and their corresponding access control lists and
audit trails stored on the DSSA document server. If you are
using a Microsoft server cluster, the DSSA must run under
the same account on each node of the cluster.
•
The DOCS_USERS and DOCS_SUPERVISORS accounts
must be created on the network.
•
Global groups must be created in the domain for all groups
that you are using in DM. At a minimum, you must create
one group: DOCS_USERS. All users who need access to the
document server must be a member of this group.
If your organization does support the management of global
groups, you can create DOCS_USERS as a Windows local
group. See “Creating Windows Groups and Adding Them to
the DM Library” on page 94 for more information.
Installing the DSSA Service
The DSSA service must be installed on every Windows server that will
be used as a DSSA document server. If you are using a Microsoft server
cluster, you must install DSSA on each node (member machine) in the
cluster.
To install the DSSA service:
1. Log on to the server as an administrator.
2. Double-click the DM Document Server Sentry Agent.msi
Windows Installer Package.
110
CHAPTER 7
3. The Welcome to the Open Text Document Server Sentry
Agent Setup Wizard appears. Click Next.
4. The End-User License Agreement dialog box appears. Select
the I agree to the terms in the License Agreement check box
and then click Next.
5. The Choose Products for Licensing dialog box appears.
Type the Serial Number and Password and then click Next.
6. The Document Server sentry Agent Service Account dialog
box appears.
The Domain Account Name field refers to the DSSA admin
account under which the DSSA service logs on to the
Windows server. This account will own all documents and
their corresponding access control lists and audit trails
stored on the DSSA document server.
The account must be a domain account that is a member of
the domain administrators group. If you are using a
Microsoft server cluster, the DSSA must run under the same
account on each node of the cluster. If you are updating or
reinstalling DSSA, the previous DSSA admin account name
is displayed here.
You must enter the Domain Account Name in the following
format: domain\user name.
Note: The installation program verifies that the account is
valid on the network, but it does not confirm that it is a
domain account or is a member of the domain
administrators group.
Type the Domain Account Name, Password, Re-Enter Password,
and then click Next.
7. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open
Text\Document Server Sentry Agent. Click the Change
button to select a different location, if needed; otherwise,
click Next.
The DSSA should be installed on the same machine or share
as the document server. If you are using a Microsoft server
cluster, you must install DSSA on each node (member
machine) in the cluster.
8. The Ready to install dialog box appears. Click Install.
INSTALLING THE DSSA SERVICE
111
9. When the Completed the Open Text Document Server
Sentry Agent Setup Wizard appears, click Finish.
Creating a Windows Share and Granting Users Access
Before a DSSA document server can be put into production, you must
create a shared folder (share) and grant the proper permissions to that
folder. If you are using a server cluster, the shared directory should be
created on a physical disk drive shared by the cluster.
To create a new share for the DSSA document server on Windows
Server or Advanced Server:
1. Use Windows Explorer to create a folder where all DM
documents stored on this document server will be located.
2. From the Start menu or Control Panel, open Administrative
Tools>Computer Management.
3. Expand Shared Folders in the left pane.
4. Right-click Shares and select New File Share.
5. The Welcome to the Create A Shared Folder Wizard
appears. Click Next.
6. The Set Up A Shared Folder dialog box appears.
In the Folder to share field, click the Browse button to select
the folder you want to share, and then click OK.
In the Share name field, type the name users will use to
access the DSSA share.
The Share description field is optional; this is the description
displayed when users browse network resources.
Click Next.
112
CHAPTER 7
7. The Shared Folder Permissions dialog box appears.
Set the kind of permissions you want for the shared folder.
Select one of the following options:
• All users have read-only access
• Administrators have full access; other users have read-only
access
• Administrators have full access; other users have no access
• Customize permissions
Note that when you set custom permissions, you are setting
permissions for the folder itself; we suggest that you set
specific permissions on the folder items themselves, if
desired.
7.1 If you click Customize permissions the Custom button
becomes available. Click Custom.
7.2 The Custom Permissions dialog box appears. On the
Share Permissions tab, click Add.
CREATING A WINDOWS SHARE AND GRANTING USERS ACCESS
113
7.3 Add the following groups and users and then click OK.
DOCS_USERS
DM Server service account
DSSA Administrator account
7.4 Highlight the DOCS_USERS group; in the Permissions
pane, select the Full control check box under Allow.
Apply the same permissions for the DM Server service
account and DSSA Administrator account.
7.5 Now select the Everyone group and click Remove.
7.6 Click OK to close the Customize Permissions dialog
box.
8. On the Shared Folder Permissions dialog box, click Next.
9. The Completing the Create A Shared Folder Wizard
appearas. Click Finish.
To prevent members of DOCS_USERS from deleting files from the
share at the folder level:
1. Start Windows Explorer, right-click the shared folder and
select Properties.
2. On the Properties dialog box, click the Security tab.
3. Click Advanced.
4. In the Permissions tab, clear the check box Allow inheritable
permissions from the parent to propogate to this object and all
child objects. The following dialog box will appear:
114
CHAPTER 7
5. Click Remove to remove the inherited permissions and keep
only the permissions explicitly specified on the share. Notice
that the group Everyone is removed from the list on the
Security tab.
6. In the Properties dialog box, click Add and add the group
DOCS_USERS, the DSSA admin account, and the DM
Server service account. Then click OK.
7. On the Properties dialog box, give the following permissions
to the newly added names:
DSSA admin account:Full Control
DM Server service account:Full Control
DOCS_USERS group:Modify
8. Note that when you select Modify, the boxes below Modify in
the Allow column are automatically selected.To verify that
the permission to delete files is denied to DOCS_USERS,
click Advanced; then highlight DOCS_USERS and click Edit.
The following check boxes should be cleared:
•
Delete Subfolders and Files
•
Change Permissions
•
Take Ownership
All other check boxes should be selected.
Configuring a DSSA Document Server
Once you have created a share and granted the proper permissions, the
next step is to configure a new document server in your library.
Note: To configure a DSSA document server in Library Maintenance, you must
be a member of the Domain Admins group on the server to which the DSSA
document server belongs.
To set up a DSSA document server:
1. From the Start menu, select Programs>Open Text>DM
Server>Server Admin Tools>Library Maintenance. Click Document
Servers to display a list of the available document servers in
the right pane.
2. Do one of the following:
CONFIGURING A DSSA DOCUMENT SERVER
115
•
Click the New icon to create a document server with a
new definition. A blank Document Servers dialog box is
displayed.
•
Highlight a document server name and click Copy. The
Document Servers dialog box appears with the copied
document server’s information filled in, except for the
Physical Location field.
Note: The Physical Location must be on an NTFS volume.
3. In the Operating System field, select DSSA on NTFS. Complete
the remaining fields. (For more information on these fields,
see the DM Administration Guide.)
3 Click OK.
Viewing the Audit Trail
An audit trail is maintained for each document stored on the DSSA
document server. The Audit Trail command lists all activity on the
document.
For DM users, all document access is by the DM Server service account.
116
CHAPTER 7
To view a document’s audit trail:
1. Select a document from the Quick Retrieve list.
2. From the Document menu, select Audit Trail. (If the Audit
Trail command does not appear, the selected document is
not stored on a DSSA document server.) A log of the activity
on the document appears.
3. When you are finished, click Close.
VIEWING THE AUDIT TRAIL
117
Chapter
8
Installing RM
In This Chapter
This chapter gives instructions for installing and upgrading to eDOCS
RM 5.3...
119
Related Manuals
In addition to this manual, you will find the following documents
helpful.
•
RM Administration Guide Instructions on using the RM
Administration Tool for the set up and administration of
RM.
•
Using RM Extensions Provides detailed instructions on
using RM.
•
DM Designer Guide. This guide explains how you can use
the Designer application to customize the DM database by
adding tables and columns for data you need. The guide also
shows how you can design DM forms to show all data about
your document objects using the “look and feel” your
organization wants.
•
DM/RM Data Dictionary Use this manual in conjunction
with the DM Designer Guide when modifying RM forms.
In addition to these printed and online documents, each RM
component has an extensive online Help system.
Installing RM
Installation of RM is a multiple-step process that includes installation
of components in several locations.
You will install different components of RM in the following places:
Installing RM on
DM Server
120
CHAPTER 8
•
DM Server: RM is a component during DM Server
installation. To install it, you must enter a valid serial
number and license key.
•
DM Web Server: RM is a component during DM Web
Server installation.
•
Records Managers: The RM Administration Tool can be
installed on any client computer that has the appropriate
SQL client and access to the DM Server.
You install the RM Server component as part of the DM Server
installation. This installation is described in “Installation Steps for DM
Server” on page 17, and you should refer to those instructions for full
details. In brief, however, the following steps are required to install the
RM Server component along with DM Server.
1. Uninstall any previous version of RM Server.
2. Execute the eDOCS DM 5.3 Server.msi Windows Installer
Package. The Windows Installer will prepare to install.
3. When asked to provide serial numbers and passwords ,
enter your RM Server Component serial number.
4. After the DM Server installation is complete, you must run
Library Generator against your existing libraries.
To locate your libraries, Library Generator must access your
PCDOCS.INI file. During installation, you will be asked for
this file’s location and it will be copied to the DM Server
\Program folder.
The RM.INI configuration file is also created in the default
location C:\Program Files\Open Text\DM Server\Program.
5. The DM Server Configuration Wizard will be launched
next. Proceed with “Configuring the DM Server” on
page 19.
After you complete installation and configuration of DM Server and
RM Server, proceed to installation of the DM Web Server, which also
includes a RM component.
Installing RM on
DM Web Server
DM Web Server includes a RM component that is installed as part of
the DM Web Server installation. The full installation of the DM Web
Server and its optional components is detailed in “Installing DM Web
Server” on page 23, and you should refer to those instructions for
complete details and prerequisites. In brief, however, the installation of
DM Web Server and the RM component proceeds as follows:.
1. Uninstall any previous version of RM.
2. Execute the eDOCS DM Web Server 5.3.msi Windows Installer
Package.
3. When the Custom Setup dialog box appears, select the RM
Client option.
4. Proceed with the DM Web Server installation wizard as
shown on page 24.
5. After installation is complete, you can install RM
Administration Tool.
INSTALLING RM
121
Prerequisites for Installing RM Administration Tool
•
The RM Administration Tool is used to set up and
administer a records management system for RM. The RM
Administration Tool can be installed on any computer with
an appropriate SQL client for your database and that has
access to your DM Server and your database.
•
For full functionality of RM Administration Tool, your
primary group must be DOCS_SUPERVISORS.
•
The computer on which you install RM Administration
Tool must have access to your DM Server and your database
server, and it must have the appropriate drivers for your
database.
If you are using an Oracle database, it is particularly
important that you use the database drivers from Oracle,
not the database drivers for Oracle that are supplied by
Microsoft with Windows. To install the Oracle drivers,
install the Oracle Management and Integration installation
package (the drivers are not included with the Oracle Client
installation package) or download the drivers from Oracle.
•
The DM Client API and the DM API must be installed on
the machine where you are installing RM Administration
Tool.
•
When RM Administration Tool starts, it attempts to find the
files RM.INI and PCDOCS.INI. If it tells you that it cannot
locate one or both of these files, obtain valid copies of these
files and place them in the folder where RM Administration
Tool is installed.
Installing RM Administration Tool
To install the RM Administration Tool:
1. Remove any previous version of RM Administration Tool.
2. Execute the eDOCS RM Administration Tool.msi Windows
Installer Package.
Or, select the eDOCS RM Administration Tool component from
the eDOCS Suite Installer.
122
CHAPTER 8
3. The Welcome to the Open Text eDOCS RM Admin Tool
Setup Wizard appears. Click Next.
4. The End-User License Agreement dialog box appears. Select
the I accept the terms in the License Agreement check box and
then click Next.
5. The Choose Products for Licensing dialog box appears.
Type the Serial Number and Password for RM Admin and then
click Next.
6. The Custom Setup dialog box appears.
Select the RMAdmin option to install the RM Administration
Tool. Select the RM Barcode Tools option if you want to install
the barcode tool. Click Next..
7. If you selected the RM Barcode Tools otpion, the RM
Barcode Spooler Service Account dialog box. Type the
Account Name, Password, and Re-Enter Password in the
appropriate fields.
INSTALLING RM ADMINISTRATION TOOL
123
8. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open Text\RM
Administration Tool\. Click the Change button if you want
to install to a different location. Then click Next.
9. The Ready to install dialog box appears. Click Install.
10. When the installation is finished, the Completed the Open
Text eDOCS RM Admin Tool Setup Wizard appears. Click
Finish.
Proceed with Assigning RM Forms.
RM.INI and
PCDOCS.INI File
Locations
When you first launch the RM Administration Tool, it will attempt to
locate valid copies of the RM.INI and PCDOCS.INI files. If it cannot
locate these files, you should copy these files from their current location
(by default, C:\Program Files\Open Text\DM Server\Program) and
place them in the RM Administration Tool directory (by default
C:\Program Files\Open Text\RM Administration Tool).
Additional RM Installation Information
Assigning RM
Forms
RM uses several forms that replace the default DM forms. Any time
after installation of DM Server is complete and you have run Library
Generator, assign the new RM forms to the Groups that will use them.
To assign forms:
1. Run Library Maintenance.
Or, you can use DM Admin in DM Webtop.
2. Go to Groups.
3. Open Group Maintenance for a group.
4. Click Forms.
5. Select the form type in the left side and assign the form
names shown below.
124
CHAPTER 8
Form Type
Form Name
Profile Entry>Paper
PD_PPROF
Profile Entry>Primary
PD_EPROF
Form Type
Form Name
Profile Entry>DOCSIMAGE
PD_EPROF_IMAGE
Profile Entry>MS OUTLOOK
PD_MPROF
Profile Search
PD_SEARCH
Quick Retrieve
PD_HITLIST
Repeat this process to assign the new forms for each group that is using
RM.
Enable Logging
RM servers and RM Administration Tool can log their own operations.
By examining this, you can locate configuration errors. The log file for
RM is saved into your Windows directory as RMLOG.TXT. If there is
an existing log file for RM Administration Tool, it is saved in your
Windows directory as RMADMINLOG.TXT. To enable logging, set the
following entry in RM.INI file:
[CMSSQL]
LogToFile=1
To disable logging, set LogToFile=0.
Configure a Client
for RM Custom
Reports
To configure a client for RM Custom Reports, follow these steps:
1. Install the latest version of the database manufacturer’s
ODBC software on the client.
Important: If you are using an Oracle database, you must use the database
drivers from Oracle, not the database drivers from Microsoft that are included
with Windows. To install the Oracle drivers, install the Oracle Management and
Integration installation package (not with the Oracle Client installation
package) or download the drivers from Oracle.
2. Create a Data Source and select the appropriate driver. The
name of this data source (DSN) should be the name of the
library and should differ from the name of any other ODBC
data sources you might be using, such as DM Reports.
3. Test the DSN you just created by using an ODBC test tool.
You should be able to connect to the database and return
data from the tables.
4. Alter the ODBCDataSource key in the Library section of the
RM.INI file as shown below:
[Library RMLibrary]
ADDITIONAL RM INSTALLATION INFORMATION
125
ODBCDataSource=RMLibrary
Where RMLibrary is the name of your Library. You should now be
able to run the custom reports from within RM.
Uninstalling RM Administration Tool
As an example of uninstalling components, the following procedure
describes how to uninstall RM Administration Tool.
Important: If you have installed RM Administration Tool on the same
computer as RM Server or RM Web Server, RM Administration Tool must be
uninstalled before uninstalling the RM server components.
1. From the Start menu, select Settings>Control Panel. The
Control Panel appears.
2. Double-click the Add or Remove Programs icon. The Add or
Remove Programs Properties dialog box appears.
3. Select Open Text RM Administration Tool and clickRemove.
4. You are asked to confirm your choice to remove the
program. Click Yes.,.
126
CHAPTER 8
Chapter
9
Installing DM Extensions
In This Chapter
This chapter provides instructions on installing DM Extensions on
client machines.
127
Before You Begin
Installation
Prerequisites
DM Server should be installed and configured before you install DM
Extensions on client machines.
Install DM Extensions
To install DM Extensions:
1. From the eDOCS Suite Installer, select DM Extensions and
click Next. This automatically starts the eDOCS DM
Extensions.msi, and determines which version to install (64bit or 32-bit).
Or, on the client machine, execute the eDOCS DM
Extensions.msi Windows Installer Package.
For 64-bit clients, use the eDOCS DM Extensions (x64).msi.
For 32-bit clients, use the eDOCS DM Extensions (x86).msi.
2. The Weclome to Open Text eDOCS DM 5.3 Extensions
(xXX) Setup Wizard starts. Click Next.
3. The License Agreement dialog box appears. Click the I accept
the terms in the License Agreement check box and click Next.
4. The Custom Setup dialog box appears. Select which features
will be installed. The available components are:
• Windows Explorer DM Extension
Dynamic Views
• Microsoft Word (version number)
• Microsoft Excel (version number)
• Microsoft PowerPoint (version number)
• Linking
Linking in Microsoft Word
Linking in Microsoft Excel
Linking in Microsoft PowerPoint
Support for all other Cross-Application Linking
• Integration Options for Other Applications
Interceptor
ODMA
128
CHAPTER 9
• Microsoft Outlook E-Mail Integration
Microsoft Outlook DM Extension
• DM Viewer
• Client Deployment Utility
• RM Extensions
• DM Imaging
Click Next.
5. When you select DM Imaging and/or RM Extensions, the
Add-Ons License Validation dialog box appears.
Type the Serial Number and Password, and then click Add for
each component requiring validation. The components will
appear in the Selected Licensed Add-on Product(s) pane.
Click Next.
INSTALL DM EXTENSIONS
129
6. If you selected any Microsoft Office applications, the
Integration Options dialog box appears.
Select one of the following integration options for each
active application listed:
• Active
• Active with Front-End Profiling (FEP)
• Active with FEP and Cost Recovery
• Passive
Click Next.
7. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open Text\DM
Extensions. Click the Change button to select a different
location, if needed; otherwise, click Next.
8. The Connection Information dialog box appears. Type the
name of the DM Server that the user will log on to when
starting DM Extensions. Click Next.
9. The Ready to install dialog box will appear. Click Install.
10. When the installation is finished the Completed the eDOCS
DM Extensions Setup Wizard will appear. Click Finish.
130
CHAPTER 9
Use Library Maintenance or DM Admin in DM Webtop to configure
application integration. See the DM Administration Guide for
instructions.
Removing DM Extensions
Remove DM Extensions through Control Panel’s Add or Remove
Programs.
REMOVING DM EXTENSIONS
131
Chapter
10
Installing the eDOCS DM API
In This Chapter
This chapter describes how to install the eDOCS DM Application
Programming Interface (API). This eDOCS DM API installation is for
third-party integrators. If you install DM Server, DM Web Server, and/
or DM Extensions, the DM API is automatically installed.
131
Installing eDOCS DM API
To install eDOCS DM API:
1. Execute the Open Text eDOCS DM API.msi Windows Installer
Package.
2. The Welcome to Open Text eDOCS DM API Setup Wizard
appears. Click Next.
3. The End-User License Agreement dialog box appears. Select
the I accept the terms in the License Agreement check box and
then click Next.
4. The Destination Folder dialog box appears. The default
installation location is C:\Program Files\Open Text\DM
API\. Click the Change button to select a different location, if
needed; otherwise, click Next.
5. The Ready to install dialog box appears. Click Install.
6. The Completed the Open Text eDOCS DM API Setup
Wizard appears. Click Finish.
Removing DM API
Remove DM API through Control Panel’s Add or Remove Programs.
132
CHAPTER 10
Chapter
11
Configuring eDOCS Imaging
In This Chapter
This chapter explains how to configure the Internet Imaging Document
Server (IIDS) after installation and how to install the Imaging client
software.
133
Installing the IIDS
The IIDS is installed as part of the DM Web Server software and should
be installed on each DM Web Server that will host Imaging clients. You
must provide a separate license number to install this software.
Once IIDS is installed, follow the instructions below to configure the
server.
Configure Internet Imaging Document Server
The configuration options for the Internet Imaging Server set the cache
location and purge watermark, the type of file compression used for
Internet transfers, and how detailed the thumbnails are.
To set the Internet Imaging Server options, run the Configuration
Manager from the Windows Start menu. Click Start>Programs>Open
Text>eDOCS DM Imaging IIDS 5.3>IIDS Configuration Manager.
134
CHAPTER 11
The following table describes the options available in the Configuration
Manager.
Option
Description
Location
Reports the currently assigned root directory for
the Internet Imaging Server’s cache. This
directory must exist before the server runs.
Click the Browse button to select another
directory for the cache.
Important: If you change the cache root after the
server has written files to the old location, the old
files will be orphaned and will not be used. You
can move the entire directory structure to the new
location or allow the server to rebuild the cache
through normal use.
Fill Percent
Specifies the maximum percentage to which the
cache drive can be filled before the server starts to
purge older documents. Documents cannot be
purged until after they are written to the DM
library.
Thumbnail Detail
Specifies the relative size and resolution of the
thumbnail images that are sent to Imaging.
Low creates the smallest, least detailed thumbnails.
The small thumbnail files are transferred most
quickly to Imaging.
Medium is a balance between transfer speed and
clarity of the resulting thumbnail.
High creates relatively high resolution thumbnails
that may be readable in the viewer, but that will
require the most time to download.
4 When you have set the options, click OK to close the TIFFServer
Configuration Manager and apply the changes.
CONFIGURE INTERNET IMAGING DOCUMENT SERVER
135
Important Workstation Configuration
After the Imaging client software is installed, we recommend that you
configure each workstation so that the client application can take
advantage of the file transfer and caching mechanisms in the Internet
Imaging Document Server (IIDS) which should already be installed on
the Web Server. This configuration is necessary because Imaging can
communicate with the DM Server using two different methods:
•
Through a browser plug-in that is installed with the
application
•
Through Application Integration
When Imaging is first installed, it defaults to using Application
Integration, which communicates directly with the DM Server and
does not communicate with the DM Web Server and the Internet
Imaging Document Server (IIDS). To enable communication with the
IIDS, each workstation must set certain security options in the browser
and enable the plugin. The following two sections describe these
settings.
Because Imaging can communicate through either the plug-in or
Application Integration, users will see some differences in dialogs and
communication with the library, depending upon how Imaging is
launched and how the user selects documents.
136
CHAPTER 11
•
If the user opens an image document from the Webtop,
Imaging then uses the plug-in to communicate with the
Web Server and to transfer the files. In this case, forms that
the user uses to communicate with the server (for example,
when changing the Profile of a document), will be presented
in the web browser.
•
If the user opens an image document from the Windowsintegrated DM Extensions (for example, DM Extension for
Windows Explorer or DM Extension for Microsoft
Outlook), Imaging will communicate through Application
Integration. In this case, forms that the user uses to
communicate with the server will be presented as the same
Windows dialog boxes used by the DM Extensions.
Set Internet
Explorer Security
Options
Perform the following steps to enable ActiveX controls and plug-ins in
Internet Explorer.
1. Run Internet Explorer.
2. Click Tools>Internet Options.
3. Go to the Security tab and click Custom Level.
4. Scroll down the list to find and enable these two entries:
•
Initialize and script ActiveX controls not marked as safe for
scripting
•
Run ActiveX controls and plug-ins
5. Click OK to accept the changes and return to the options
dialog box.
6. Click OK to close the options dialog box.
Enable Plugin in
DM Webtop
To enable the use of the browser plugin, you must enable it in the DM
Webtop.
1. Lauch your browser and log onto to DM Webtop.
2. Go to the My Options page.
3. Go to the Display Options tab.
4. Scroll down to find the eDOCS DM Plugins heading.
5. Select the eDOCS Imaging check box.
6. Click the Save your changes button on the toolbar.
After these two options are set, Imaging will communicate through the
plugin if it is launched by opening a document from the Webtop, and it
will communicate with the server through Application Integration if it
is launched directly from the Windows desktop or by opening a
document from DM Extensions.
IMPORTANT WORKSTATION CONFIGURATION
137
Chapter
12
Pointing a Component to a
Different DM Server
In This Chapter
This chapter describes how to run the DM Connection Wizard to
connect a DM Web Server or other DM client to a different DM Server.
(Note that the DM Server accessed by a DM Web Server can
alternatively be changed via DM Admin.
The DM API, which handles communications between servers and
clients, is required. The DM API is automatically installed when you
install DM Server and/or DM Web Server. If you do not install these
products, you can install the eDOCS DM 5.3 DM API.msi Windows Installer
Package.
139
Running the DM
Connection Wizard
The DM Connection Wizard guides you through selection of the DM
Server used by the specific DM component.
If your organization employs a multiple-server cluster for failover and
load-balancing (FOLB) purposes, the connection wizard also lets you
display the FOLB server list for the selected server. (See the DM
Administration Guide for more information on the FOLB facility.)
The wizard also allows you to remove a DM Server from an FOLB
server cluster to make it a dedicated Indexer server.
Note: If you have uninstalled DM Server from the machine where you want to
run the wizard, the wizard will fail, because shared files where removed during
the uninstall process. If this happens, reinstall DM Server.
140
CHAPTER 12
To run the wizard:
1. Select Start>Programs>Open Text>DM Connection
Wizard.
2. On the Specify DM Server page, enter the name of the server
machine that the component will initially log on to. DM
Servers that you have logged on to in the past are shown and
you can select one from the list.
5 The server list associated with the server you selected on the
previous page is displayed. The option Enable FOLB should be
selected. Click Finish to exit the wizard.
141
142
CHAPTER 12
APPENDIX
A
Setting Up the DM Server
Service Account
In This Appendix
This appendix describes the requirements for the DM Server service
account under which DM Server runs. It also explains how to set up the
account on Windows servers.
143
About the DM Server Service Account
The DM Server service requires network access, so it must be run under
an account that has the following privileges and abilities:
•
Access to the network and to all document servers,
libraries, and SQL databases. The DM Server service
account is not required to be a domain account, but we
strongly recommend that you make it a domain account
because it must typically access data on other network
resources.
•
"Act as a part of the operating system" rights. This privilege
is set up for the DM Server service account by the DM
Server Configuration Wizard.
•
"Log on as a service" rights. This privilege is set up for the
DM Server service account by the DM Server Configuration
Wizard.
•
Membership in the local administrator group on the local
machine. The account need not be a member of the Domain
Admins group.
•
Full Control rights to the document storage location on
each document server. Permissions should be applied at the
last static directory in the document path template.
•
Membership in the DOCS_SUPERVISORS group in every
DM library and at the NOS level. In the library, the
account’s Primary Group must be DOCS_SUPERVISORS.
The DM Server service account must be created prior to installing the
DM Server software. During installation, the DM Server Configuration
Wizard will grant the “Act as part of the operating system” and “Log on
as a service” rights, if the account does not already carry them.
Setting Up Accounts on Windows Servers
The following explains how to set up the DM Server service account on
Windows Server machines, add them to the required groups, and apply
the necessary rights. For instructions on setting up the account on
Windows Server machines, see page 144.
144
APPENDIX A
Creating the
Account
To set up the DM Server service account on a Windows 2000
Server machine:
1. Go to the Start menu and click Programs>Administrative
Tools>Computer Management.
2. In the tree, expand the Local Users and Groups node, rightclick Users, andthen select New User.
3. Enter the User name and Password of the account. Enter a
description, such as DM Server Service Account, if you like.
Then select the password option appropriate for your
organization. Click Create and then click Close. The new
account is shown in the user list in the Computer
Management windows.
Adding the
Account to the
Local
Administrators
Group
1. In the Computer Management windows’s tree, expand Local
Users and Groups. Then click Groups.
2. In the right pane, right-click Administrators and select Add to
Group.
3. In the Administrative Properties dialog box, click Add.
4. In the Enter the object names to select field, type SYSTEM, and
then click Check Names.Click OK to return to the
Administrator Properties dialog box. Click Apply and then
click OK.
Applying Rights to
the Account
1. Go to the Start menu and click Programs>Administrative
Tools>Local Security Policy.
2. In the Local Security Settings window’s tree, expand Local
Policies and then click User Rights Assignments.
3. In the right pane, highlight Act as part of the operating system,
right-click and select Properties.
4. In the Local Security Setting tab, click Add User or Group.
5. In the Select Users and Groups dialog box, type the DM
Server service account name and click Check Names. Then
click OK until you return to the Local Security Setting
window.
6. Repeat steps 2 through 5 to apply the Log on as a service
right.
SETTING UP ACCOUNTS ON WINDOWS SERVERS
145
APPENDIX
B
Special Considerations for
Microsoft SQL Server Libraries
In This Appendix
This appendix explains how to prepare for installation of Microsoft
SQL Server and creation of your DM libraries.
149
Installation Impact on Regular Operations
During installation you are required to stop and restart the system to
load certain programs that SQL Server installs. If you are installing SQL
Server on a system accessed by users during the daily operations of your
business, schedule the installation for a time when users are off the
system.
Dedicated SQL Server Machine
In environments of 20 or more users, we recommend you dedicate a
Windows server machine to SQL Server activities. Dedicating a server
to SQL Server can optimize performance and facilitate maintenance
and troubleshooting.
Typically, the machine should have multiple hard disks so that you can
store the following SQL-related files on separate disks:
•
SQL Server program files and system databases.
•
Your organization’s database(s).
•
SQL transaction log(s).
However, depending on your hardware setup, you may decide a
different configuration is more appropriate for your system.
Windows Service Accounts
Before installing SQL Server, you need to identify a Windows account
under which the two SQL Server services (SQL Server and SQL Server
Agent) will run. The account should have administrative privileges on
the server machine. It can be:
•
A domain account.
•
The local administrator account on the server.
•
The SYSTEM account.
It is possible to run the two SQL Server services under separate
accounts, but we recommend you use the same account.
150
APPENDIX B
Support for Microsoft SQL Server 2005
To enable support for Microsoft SQL Server 2005, you need to use a
complex password the first time you run Library Generator. A complex
password is a password that:
•
Does not contain the user’s account name, either in full or
in part.
•
Is at least six characters in length.
•
Contains characters from three of the following categories:

English uppercase characters (A through Z).

English lowercase characters (a through z).

Numbers (0 through 9).

Non-alphanumeric characters (for example: !, $, #, %).
After running Library Generator, you can disable password policy
enforcement. Refer to your SQL documentation for additional
information.
Database and Document Servers
There are two types of servers in DM: document servers and database
servers.
Document Servers
Database Servers
A document server is the location where documents are stored. A
document server consists of a file server and storage location. It does
not use SQL Server. DM supports several operating systems as
document servers. See the release notes for a list of the operating
systems supported for your installation.
SQL Server resides on the database server. A database server can
contain one or more SQL databases.
In DM, the SQL database contains the tables and columns that make up
a DM library. The library contains information about each document,
stored in a record called the Document Profile. The profiles contain
pointers to the physical documents, which are stored in their native
format on the document server(s).
SUPPORT FOR MICROSOFT SQL SERVER 2005
151
An organization can have multiple libraries and can customize its
library configuration according to the needs of its particular enterprise.
For example, companies or firms with more than one office typically
install SQL Server at each physical location and maintain one or more
libraries at each location. Different departments or business units
within an organization often have their own libraries. The optimum
configuration is one where users who share information don't have to
switch libraries to access the information they need on a frequent basis.
Database names must be unique on each SQL server. Although it is
possible to use the same database name on two different SQL servers,
we recommend that every database in your organization be assigned a
unique name to facilitate possible future changes (such as moving
databases to different servers or merging two servers' databases onto
one server.)
We recommend that you place databases on a physical drive other than
the drive where SQL Server is installed. In the event of a drive failure,
having the SQL server and database(s) on separate drives will make
recovery easier.
To improve I/O performance, place the database’s transaction log file
and the library data file(s) on different drives with different disk
controllers.
Configuring SQL Servers and Databases
How will you manage your organization’s documents with DM? If you
have decided that a single library is sufficient for all of your users, you
simply need to decide how users will connect to the server (SPX, TPC/
IP, Named Pipes, etc.). If you have decided to create multiple libraries,
there are additional considerations: How will you segment the users?
How much of an impact will users connecting to more than one library
have?
LAN Environments
152
APPENDIX B
If your installation requires multiple libraries, be aware that each SQL
server will need to provide sufficient user connections to permit access
by users from other SQL servers. Memory requirements for the SQL
server increase with the number of connected users. With Microsoft
SQL Server, you have the option of allocating memory dynamically,
based on demand, rather than setting a fixed amount. If you choose to
manage memory in this way—and we recommend you do—set the
number of user connections to zero (0). This will allow SQL Server to
create user connections on demand. By default, the number of user
connections is set to zero when you install SQL Server. See “User
Connections” on page 159 for more information.
WAN Environments
In a large organization with multiple locations, each physical site
should have its own database server(s). Having to connect to another
city to search for information about documents stored in the local city
would create heavy network traffic between the locations.
In smaller organizations, or those with few offsite users, a single
database server may be preferable, because a centralized setup may
reduce the time and cost of administration.
As in a LAN environment, you will need to provide sufficient memory
so that SQL Server can open user connections for users from other SQL
servers.
Disk Space Requirements
Space required for the SQL Server and it’s system files, as well as the DM
database, is described in the following paragraphs.
SQL Server and
System Files
The various SQL Server files and amount of space needed for each are
as follows:
•
SQL Server Program Files and System Databases: In
addition to the program files, SQL Server maintains four
system databases for each instance (master, model, msdb,
and tempdb), which expand automatically as needed.
Altogether, these files need a minimum of 100 MB of disk
space.
•
SQL Transaction Log: For the transaction log, you need to
reserve enough disk space to store the maximum amount of
transactions that can occur between backups. Typically,
providing space equivalent to 30 to 50 percent of the size of
the database is sufficient. If a transaction log runs out of
space, users will be unable to perform database transactions
until the log is dumped.
Note: The transaction log records database transactions as they are
DISK SPACE REQUIREMENTS
153
performed. Dumping the transaction log creates a list of transactions
performed since the last transaction log dump. In the event of a system failure,
you can recover the database by sequentially applying the transaction log
dumps that were created since the database was last backed up.
DM Database
To determine how much space you will need for a DM database,
calculate the amount of space necessary for information on existing
documents plus at least one year’s worth of growth. There are many
items for which you need to provide space in a database.
Records for Existing Documents
A single document (which is associated with one profile record, one
activity record, one version record, one component record, and one or
more security records) requires approximately 1 KB of space.
Use the following formula to determine the amount of space required
for information on existing documents:
N x 1KB = A
where N is the number of existing documents whose information will
be imported into your repository and A is the space required for
existing documents, in kilobytes.
So, for example, importing 1,000 documents into a repository requires
at least 1 MB (1,000 KB) of database space.
Records for New Documents
To estimate the number of new documents to be created in the coming
year, you can:
•
Determine how many documents were created last year and
use that number, factoring in your organization’s
anticipated rate of growth. For example, if you created 1,000
documents last year and expect to grow this year by 20
percent, you would need to provide growing room for 1,200
new documents.
or
154
APPENDIX B
•
Use a per-period estimate. Determine how many documents
are created each day, week, or month. Then multiply this
number by the associated number of periods per year. For
example, if you estimate that approximately 10 new
documents are created every day, and there are 260 work
days in a year, you could estimate that 2,600 documents
would be created in the coming year.
Once you develop a reasonable estimate of the number of documents
to be created in the next year, multiply the number by 1 KB to
determine the database space that many new documents will require.
You can use this formula:
N x 1KB = B
where N is the number of new documents and B is the space required
for the new documents in kilobytes.
Records for Activity on Documents
Each document record (whether imported or created) grows as the
document is edited and new versions are created. You should allocate
roughly the same amount of database space for activity on documents
as you provide for new documents.
Records for Validation Data
You also need to allocate space for the validation data associated with
each document. This data includes people, groups, and document
types. Use the following formulas to calculate the amount of space
needed for validation data:
•
People Records: Estimate the number of DM users you will
have in the library. Use the following formula to calculate
the space required:
P/2 = C
where P is the number of DM users and C is the space
required in kilobytes.
•
Group Records: Estimate the number of DM groups you
will have in the library. Use the following formula to
calculate the space required:
G/3 = D
where G is the number of DM groups and D is the space
required in kilobytes.
DISK SPACE REQUIREMENTS
155
•
Document Type Records: Estimate the number of DM
document types you will have in the library. Use the
following formula to calculate the space required:
T/10 = E
where T is the number of DM document types and E is the
space required in kilobytes.
Records for Industry-Specific Data
If you will select one of the industry types supplied during library
generation, you will want to estimate the amount of space required for
the industry-specific tables in the library. Use the following formulas to
calculate the amount of space needed for industry-specific data:
•
Legal Installations: Allocate space for clients and matters.
Estimate the number of clients and matters you will have in
the library and use the following formula to determine the
space required:
L + M/12 = F
where L is the number of clients and M is the number of
matters. F is the space required in kilobytes.
•
Government Installations: Allocate space for organizations
and departments. Estimate the number of organizations
and departments you will have in the library and use the
following formula to determine the space required:
O/13 + D/17 = F
where O is the number of organizations and D is the
number of departments. F is the space required in kilobytes.
•
Financial Installations: Allocate space for accounts and
departments. Estimate the number of accounts and
departments you will have in the library and use the
following formula to determine the space required:
A/13 + D/17 = F
where A is the number of accounts and D is the number of
departments. F is the space required in kilobytes.
Records for Custom Data
You can add your own information about documents to the library by
selecting one of the default industry types and/or by using DM
Designer to create your own tables. Each custom table consists of
156
APPENDIX B
character, date, and integer fields. Here’s how to estimate the space
required:
•
Character-type columns occupy 1 byte of space per
character. For each custom table, count the number of
character-type columns and add up their total length to
estimate the maximum amount of space the character
columns could occupy in each record.
•
Date-type columns occupy 8 bytes of space. For each
validation table, count the number of date-type columns
and multiply that number by 8 to determine the amount of
space all date columns will occupy in each record.
•
Integer-type columns occupy 4 bytes of space. For each
validation table, count the number of integer-type columns
and multiply that number by 4 to determine the amount of
space all integer columns will occupy in each record.
Note: Each table is assigned a SYSTEM_ID by DM. The
SYSTEM_ID is always an integer type. Any foreign key
associations are also integer types. For more information
about building custom tables, refer to the manual DM
Designer Guide.
For example, say you work in a research environment where it is
necessary to track information about multiple research grants. Each
document in the library is associated with a particular grant. A custom
table called GRANTS, illustrated below, records the source of the grant,
a description of the purpose of the grant, and the beginning and ending
dates of the grant. The account manager and primary researcher, whose
information is stored in the PEOPLE table, is also recorded in the table.
Grants Table
Column Name
Data Type
Space
SYSTEM_ID
Integer
4 bytes
SOURCE
Char(30)
Maximum of 30 bytes
PURPOSE
Char(200)
Maximum of 200 bytes
ACCT_MGR
Integer
4 bytes
PRIMARY
Integer
4 bytes
BEGIN_DATE
Date
8 bytes
DISK SPACE REQUIREMENTS
157
END_DATE
Date
8 bytes
The maximum amount of space occupied by all the fields is 258 bytes.
This means that approximately four grant records will occupy a
kilobyte of space.
To estimate how much space the table will occupy, you would first
determine the number of grants. Then divide the total number of
grants by the number of grants per kilobyte (in this case, four) to
determine the amount of space required in kilobytes.
Indexes for Custom Tables
If you create your own tables, you will all need to allocate space for the
tables’ indexes. An index is a structure that contains keys from one or
more columns in the table. By searching through the index keys rather
than the table itself, SQL Server can locate the associated row data
quickly and efficiently. For information on sizing indexes, see SQL
Server Books Online. At the time this manual was published,
informative topics on this subject included “'Estimating the Size of a
Table with a Clustered Index,” and “Estimating the Size of a Table
Without a Clustered Index.”
Memory Requirements
SQL Server uses memory to manage users, databases, database objects,
and locks. Any additional memory is used for procedure and data
cache. Increasing the memory available to SQL Server can improve
performance.
With Microsoft SQL Server, you have the option of allocating a fixed
amount of memory or allowing SQL Server to configure memory
dynamically according to demand. We recommend you choose the
latter option. (If you want to allocate memory for user connections, see
“User Connections” on page 159.)
Even if you allow SQL Server to configure memory dynamically, you are
still faced with the question of how much memory to provide on the
server machine.
158
APPENDIX B
If additional memory is available and the activities requested by the
user connection require it, SQL Server can allocate additional memory
to a connection. Typically, providing enough memory to cover twice
the number of users will be sufficient. If you allow SQL Server to
allocate memory on demand, any unused memory will be released for
functionality elsewhere in the server machine.
Use the following formula to calculate the minimum amount of
memory for SQL activities:
(U × 80)/1024 + 12 = Z
where U is the number of user connections (or twice the number of
users) and Z is the minimum amount of memory in megabytes.
If you want to manage the memory options for SQL Server, see SQL
Server Books Online.
User Connections
A user connection allows a DM user to connect to the SQL server and
execute a transaction.
In addition to dynamically managing memory, Microsoft SQL Server is
by default configured to dynamically manage user connections based
on demand. We recommend you allow SQL Server to manage both
your user connections and memory.
To verify the user-connection setting after installing SQL Server:
1. Start Enterprise Manager by going to the Start menu and
clicking Programs>Microsoft SQL Server>Enterprise Manager.
2. Expand a server group.
3. Right-click a server; then click Properties.
4. Click the Connections tab.
5. In the Maximum concurrent user connections box, the value
should be zero (0) if you want SQL Server to open and close
user connections on demand.
USER CONNECTIONS
159
If you decide to set the number of user connections rather than
allowing SQL Server to manage them, see SQL Server Books Online for
instructions on defining the maximum number of concurrent user
connections available for the SQL server. The goal here is twofold:
•
To allocate enough connections so that all users can access
the database as needed.
•
To avoid overcommitting user connections, because each
connection allocated uses approximately 40 KB of memory,
even when it is not being used.
The activities that require a user connection to SQL Server are different
for DOCS Open and DM.
DOCS Open: A user connection is opened whenever a user:
•
160
APPENDIX B
Launches a DOCS Open module, such as the Desktop or
Library Maintenance.
•
Performs a table lookup, as when searching for an author
name or document type.
For a launched module, the connection stays open as long as the
module is open. For a table lookup, the connection is released once the
user has selected an item from the lookup table.
DM: A single connection can be used for multiple user transactions.
Note: The number of user connections is different from the number of licenses
you have for SQL Server. Licenses are determined by your arrangements with
Microsoft. User connections can be increased as needed, provided the SQL
server has the memory to support them.
USER CONNECTIONS
161
Worksheets
The worksheets in this section are designed to help you plan for your
SQL installation.
Server
Configuration
Worksheet
Complete one worksheet per SQL server. If you have questions, fax the
worksheet with your information to Open Text Technical Support for
assistance at (850) 942-8085.
Question to Reviewers: Confirm that the fax number is still correct.
1 SQL server name:
____________________________________________________
2 Windows server name:
____________________________________________________
3 Processor type and speed of machine to run SQL Server:
____________________________________________________
4 Is this SQL server dedicated or non-dedicated?
____________________________________________________
5 How many databases will reside on this server?
____________________________________________________
6 How many users will access this SQL server, including the
possible concurrent remote connections from other DM libraries
and the number of connections from item 5 above (one
connection per database):
____________________________________________________
Memory required for the server (based on the calculation
information in “User Connections” on page 159):
____________________________________________________
7 Total disk space available on the SQL server:
____________________________________________________
162
APPENDIX B
SQL Server
Installation
Worksheet
Record the following information prior to installing SQL Server. Keep
the completed list for your records.
1 Windows and SQL server names:
____________________________________________________
____________________________________________________
2 SPX/IPX server name (if applicable):
____________________________________________________
3 TCP/IP file address or host name (if applicable):
____________________________________________________
4 TCP/IP port number (if applicable):
____________________________________________________
WORKSHEETS
163
Database
Configuration
Worksheet
The following information should be completed for each database.
1 Unique library database name:
____________________________________________________
2 To complete the following information, see “DM Database” on
page 154.
a.
Space for document records to
be imported (A):
__________________
b.
Space for new documents and
activity on documents (2 × B):
__________________
c.
Space for validation data
__________________
(C + D + E):
d.
Space for industry-specific data
(F):
__________________
e.
Space for custom data (tables
and indexes):
__________________
f.
Total of a through e above:
__________________
g.
Total space required for the
library database (total of a
through e above):
__________________
3 Space needed for the transaction log (typically 30 to 50 percent of
the size of the database):
____________________________________________________
164
APPENDIX B
Installation
Worksheet
Complete this worksheet during the installation of SQL Server.
1. Client-licensing mode:
•
Per server. Number of concurrent connections allowed:
___________
•
Per seat. Use License Manager to record the number of
licenses. ___________
2. SQL Server installation drive and directory. The default is
C:\Program Files/Microsoft SQL Server.
_______________________________________________
3. Character set:
•
ISO character set (default)
•
850 Multilingual (Western European languages)
•
437 U.S. English
•
Other : _____________________________
For example:
1250 Latin2 (Eastern European languages)
1251 Cyrillic Slavic (Russian and other Slavic languages)
1253 Greek
1254 Turkish
1255 Hebrew
1256 Arabic
4. Sort order. Choose one of the following. We recommend
dictionary order, case-insensitive. Do not choose a binary or
case-sensitive sort order.
•
Dictionary order, case-insensitive
•
Dictionary order, case-insensitive, uppercase preference
•
Dictionary order, case-insensitive, accent-insensitive
5. Network support. Choose one or more of the following:
•
Named Pipes (must be selected)
•
NWLink IPX/SPX
•
TCP/IP Sockets
•
Other: _____________________________
WORKSHEETS
165
6. NWLink IPX/SPX service name. The default is the name of
the server computer.
_______________________________________________
7. TCP/IP port. The default is 1433, although you have the
option of allowing SQL to determine the port number
dynamically.
_______________________________________________
8. Startup options. Choose one or both options. (We
recommend you select both.)
•
Autostart SQL Server at boot time
•
Autostart SQL Server Agent at boot time
9. SQL Executive user account.
_______________________________________________
166
APPENDIX B
APPENDIX
C
Special Considerations for
Oracle Libraries
In This Appendix
This appendix contains guidelines for setting up a DM library on an
Oracle database instance. For instructions on installing Oracle and
creating an instance and database, see your Oracle documentation.
165
DM Requirement for Oracle Databases
Prior to generating a DM library, an Oracle instance and a database
must exist. The instance/database may be created expressly for the
library or an existing instance/database may be used.Running in
ARCHIVELOG Mode
Running the library database in ARCHIVELOG mode allows Oracle to
compile a complete transaction record, which can be used to restore the
database in the event of a failure
Because library generation creates many tables and rows, we
recommend you remove the database from ARCHIVELOG mode prior
to running Library Generator. This will speed up the generation
process. Once library generation is complete, return the database to
ARCHIVELOG mode.
Multiple Libraries on a Single Oracle Instance
DM supports Oracle’s ability to create multiple DM libraries on a single
Oracle instance. Using the default tablespace names assigned during
library generation, you can create up to 100 libraries on an instance. If
you assign your own tablespace names, you can create as many libraries
as your system can handle, provided that each tablespace name is
unique.
Owner Accounts
Multiple libraries on an instance are differentiated by owner account.
As long as the owners are different, Oracle will allow multiple tables
having the same name and columns.
The owner of a library is DOCSADM by default. During library
generation, you can assign a different owner by typing over the default
DOCSADM value in the Owner field. To assign an owner of a second
or subsequent library, you supply the owner name and password as the
SQL server login account. When Library Generator detects that the
Oracle instance already contains a DM library owned by a different
account, you will see a dialog box asking if a new library should be
created.
Tablespace Names
166
APPENDIX C
Unless you assign your own tablespace names, the default tablespace
names assigned during library generation are incremented for each
new library on an instance. For example, for the first library, the default
tablespace names are DOCSPROF, DOCSVAL, DOCSIND, and
DOCSTMP; for the second library they are DOCSPROF2, DOCSVAL2,
DOCSIND2, and DOCSTMP2. Up to 100 libraries can be created using
the default tablespace names.
Rollback Segments
To accommodate multiple libraries, you’ll need to increase the
maximum number of rollback segments permitted for an instance. Do
this by modifying the following setting in the INIT.ORA file:
MAX_ROLLBACK_SEGMENTS
Oracle’s default value of 40 is sufficient for a single library, but creating
a new DM library will surpass this number. To determine the number
of additional rollback segments needed, divide the expected number of
active users of the new library by 4. For example, if you expect the
library will average 100 active users at any given time, increase the
rollback segments by 25.
Increasing the rollback-segment maximum should be done prior to
generating the new library. To have the new value take effect, stop and
restart the Oracle instance.
Mixed-Case Data and Case-Insensitive Searches
DM allows storage of mixed-case data in Oracle databases, while
preserving the ability to perform case-insensitive searches.
Oracle’s Function-Based Indexes feature provides for the creation of
uppercase indexes on mixed-case columns. When a mixed-case library
is generated by DM, it uses Oracle’s UPPER function to create indexes
on the uppercase equivalents of mixed-case text columns. If the library
is optioned for case-insensitive searches, DM converts mixed-case
search strings to uppercase and searches for the value in the uppercase
index.
By default, DM data in Oracle databases continue to be stored in
uppercase. To take advantage of the mixed-case capability, you must
choose this feature when generating a new library or regenerating an
existing one. You must also turn on settings in the INIT.ORA file prior
to generating/regenerating the library.
Note: Case-insensitive searches on mixed-case columns will return results in
MIXED-CASE DATA AND CASE-INSENSITIVE SEARCHES
167
ASCII order. This is due to the fact that Oracle does not perform caseinsensitive sorting.
Selecting MixedCase Storage
During Library
Generation
When you generate a new library—or upgrade an existing one—with
DM’s Library Generator, a dialog box appears during the generation
process. The dialog box asks if you want the library to support mixedcase data.
To store data in mixed case, click Yes; to store data in uppercase only,
select No.
If you select Yes, DM creates the uppercase indexes for the searchable
text fields on the Profile form.
INIT.ORA
Modifications for
Mixed-Case Data
These settings must be present in the INIT.ORA file to support the
Function-Based Indexes feature:
QUERY_REWRITE_INTEGRITY=TRUSTED
QUERY_REWRITE_ENABLED=TRUE
COMPATIBLE= 8.1.0.0.0 (or greater)
To have these settings take effect, restart the Oracle instance.
Removing Indexes
to Improve
Performance
168
APPENDIX C
When you upgrade a library that was previously generated without
mixed-case data, DM does not remove the non-functioned indexes
(that is, the indexes formerly used to support searching). To improve
search performance, we recommend you remove those indexes from
your database. The table below lists the old index names along with the
uppercase indexes that are created when you generated the library for
mixed-case data.
Table
Column
Old Index/
Uppercase Index
Unique
APPS
APPLICATION
APPSC1
YES
UPPER(APPLICATION)
APPSCU
IGNORE_TEXT
DBIMPIGNOREC1
UPPER(IGNORE_TEXT)
DBIMPIGNORECU
LOCATION
DOCSERVERSC1
UPPER(LOCATION)
DOCSERVERSCU
TYPE_ID
DOCTYPESC1
UPPER(TYPE_ID)
DOCTYPESCU
GROUP_ID
GROUPSC1
UPPER(GROUP_ID)
GROUPCU
USER_ID
PEOPLEC1
UPPER(USER_ID)
PEOPLECU
DBIMPORTIGNORE
DOCSERVERS
DOCUMENTTYPES
GROUPS
PEOPLE
NETWORK_ALIASE
S
YES
YES
YES
YES
YES
NETWORK_ID,NETWORK_T NETWORK_ALIASES YES
1
YPE
UPPER(NETWORK_ID),NET
WORK_TYPE
NETWORK_ALIASES
U
REMOTE_LIBRARIE LIBRARY_NAME
S
UPPER(LIBRARY_NAME)
REMOTE_LIBSC1
KEYWORD
KEYWORD_ID
KEYWORDC
UPPER(KEYWORD_ID)
KEYWORDU
PROFILE
DOCNAME
PROFILENAME
If doc names unique
UPPER(DOCNAME)
PROFILENAMEU
PROFILE
DOCNAME
PROFILENAME
If doc names not
unique
UPPER(DOCNAME)
PROFILENAMEU
STOPWORDS
STOPWORD
STOPWORDSC1
UPPER(STOPWORD)
STOPWORDSCU
YES
REMOTE_LIBSCU
YES
YES
NO
YES
Financial Libraries:
MIXED-CASE DATA AND CASE-INSENSITIVE SEARCHES
169
Table
Column
Old Index/
Uppercase Index
USER_DEPT
DEPT_ID
DEPTC1
UPPER(DEPT_ID)
DEPTCU
ACCT_NUM
ACCTC1
UPPER(ACCT_NUM)
ACCTCU
ORG_ID
ORGC1
UPPER(ORG_ID)
ORGCU
DEPT_ID
DEPTC1
UPPER(DEPT_ID)
DEPTCU
CLIENT_ID
CLIENTC1
UPPER(CLIENT_ID)
CLIENTCU
USER_ACCT
Unique
YES
YES
Government
Libraries:
USER_ORG
USER_DEPT
YES
YES
Legal Libraries:
CLIENT
YES
DOCS Routing
Libraries:
DOCUMENTS
BUNDLEID,DOCSID,DOCSLI DOCUMENTS_PK
B
DOCUMENTS_PKU
BUNDLEID,DOCSID,
UPPER(DOCSLIB)
YES
USERS
SHORTNAME
USERS_I1
NO
UPPER(SHORTNAME)
USERS_IU
MAIL_MSG_ID,MAIL_MSG_I
DX
PROFILEGW100
GroupWise Libraries:
PROFILE
NO
PROFILEGW100U
UPPER(MAIL_MSG_ID),MAI
L_MSG_IDX
To create uppercase indexes on additional columns, use the SQL\
syntax:
CREATE UNIQUE INDEX <index name> ON <table name>
(<column name>) %TS_NAME% %KEY_LEN <number>%
where:
170
APPENDIX C
%TS_NAME% indicates the tablespace name
%KEY_LEN <number>% indicates the key length variables.
DM WorkFlow Oracle Tablespaces
Prior to the installation of DM WorkFlow, we suggest you create
additional tablespaces for DM WorkFlow tables to avoid adding DM
WorkFlow information to Oracle default tablespaces and to make it
easier to administer the Oracle server.
•
Create two tablespaces at least 20 MB in size with autoincrement configured. One tablespace is used for DM
WorkFlow USER tables and the other one for DM
WorkFlow TEMPORARY tables.
•
The DM WorkFlow TEMPORARY tables should be created
like the TEMP tablespace. To do this, go to DBA studio,
select TEMP tablespace, and choose "Create Like..." from
the menu.
DM WORKFLOW ORACLE TABLESPACES
171
APPENDIX
D
The PCDOCS.INI File
In This Appendix
This appendix notes the PCDOCS.INI file settings that are applicable
to DM. Settings not listed here are applicable only to DOCSFusion or
DOCS Open.
173
Location
When you install the DM Server software, the setup program asks for
the location of your existing PCDOCS.INI file and copies it to DM
Server\Program directory (by default, C:\Program Files\Open
Text\DM Server\Program). Library Generator creates a PCDOCS.INI
file in this directory if it does not find one already there.
After library generation, you can copy the file to another location if
necessary. If you decide to move the file after installation, you will need
to run Server Manager and identify the file’s new location. See the
chapter entitled Setting DM Server Properties in the DM Administration
Guide for instructions.
Settings
The following settings in the PCDOCS.INI file are used by DM.
Settings not listed here are ignored by DM.
[Library <library name>] Section
Vendor: The SQL vendor number (Microsoft SQL
Server=3,Oracle=5, Sybase=6)
Database: The name given to the DM database during installation
of the SQL engine.
Location: The name of your SQL server.
Username: The common login name for users to access the DM
database.
Password: The password for the common login.
DefaultDOCServer: The document server on which documents
are stored by default.
Owner: If the library is on an Oracle 8i or higher database, this
field contains the account name of the library owner. (When
multiple libraries are stored on a single Oracle instance, they are
differentiated by owner account.)
UseDocnameInFolderContents: Selects whether document
names or display names are shown in DM Webtop for folders on
174
APPENDIX D
the Folder Contents and Public Folders pages and for workspaces
on the Workspaces page. Folders and workspaces are assigned a
“document” name (specified on the Document Profile form) as
well as a “display” name (specified on the Update Properties
dialog box). If UseDocnameInFolderContents is set to 1,
document names are displayed; if the setting is 0, display names
are shown. If you choose to have display names shown, we suggest
you notify users that changes to document names on the
Document Profile will not be reflected on display listings such as
the Folder Contents page.
[LDAP] Section
ServerLocation: Points DM Server to the location of the
Lightweight Directory Access Protocol (LDAP) server so that
LDAP names can be used for authentication.
ServerLocation=//<ldap><:port>/o=<....>,c=<....>
where:
<ldap> is the DNS name for the host of the LDAP service.
<port> is the port number of the LDAP server. Inclusion of
the port number is optional. If you do not include the port
number, you should omit the colon (:) also.
o=<....>,c=<....> is the root context for the LDAP directory.
For example:
ServerLocation=//ldap.server.com:389/dc=mycompany,dc=com
[Network] Section
DriveUnmapTries: This setting addresses an issue where drive
mappings created during a DM process (such as Document
Import), which are intended exist only for the duration of the
process, are not being released because high network activity
delays completion of the process beyond the instruction to release
the drive mapping. This setting causes successive calls to be made
to release the drive mapping until one of the calls succeeds.
DriveUnmapTries=<number>
where <number> is the number of calls that will be made to
release the drive mapping until a call succeeds. Any value between
SETTINGS
175
1 and 30 may be used. If this setting is not added to the
PCDOCS.INI file, the default is 4.
176
APPENDIX D
APPENDIX
E
Troubleshooting
In This Appendix
This appendix describes how to resolve issues that may arise during
setup or administration of DM.
179
Accessing Our Knowledge Base
Descriptions of a number of issues related to setup and administration
of the DM Suite can be found in Open Text’s online Knowledge Center.
If you have a problem, we suggest you search the Knowledge Center for
items that may be pertinent to your installation. If you cannot resolve
the problem after looking in both this chapter and the Knowledge
Center, contact Open Text Technical Support for assistance.
Check the Setup of the DM Server Service Account ........................... 180
The Account’s Status on the Network....................................... 181
DCOM Points to the Account on Server..................................... 181
DCOM on DM Client Machines Points to the Account............... 181
Changes to the Service Account ................................................ 181
Problems Locating DM Server............................................................. 182
Cannot Locate DM Server........................................................... 182
Local Server Not on FOLB List .................................................... 182
NetWare Connectivity ......................................................................... 182
Unable to Connect to NetWare Document Servers .................. 182
Miscellaneous Issues........................................................................... 183
DM Server Will Not Start and DCOM Errors Reported ............... 183
“Can’t Start” Message Appears After Reboot ........................... 183
Changes Made in DM Server Admin Tools not Reflected on Clients
184
DCOM Errors Related to SearchServer ....................................... 184
Check the Setup of the DM Server Service Account
To successfully deploy the DM Suite, it’s important that the DM Server
service account be set up correctly. Errors related to this account can
cause a variety of issues, particularly connection failures. If you are
having any type of problem, particularly when setting up DM for the
first time, we recommend you investigate the following items first.
180
APPENDIX E
The Account’s Status on the Network
•
Windowsonly networks and organizations with mixed NetWare
and Windows networks: the service account must be set up as a
network domain account, not a local machine account.
•
NetWare-only systems: the service account must be a local
account.
DCOM Points to the Account on Server
Ensure that DCOM is pointing to the DM Server service account on the
network and not to the server machine’s local system account. By
default, many services run as a local system account. If the account is
local, there may be problems with clients connecting to the server.
DCOM on DM Client Machines Points to the Account
Verify that the DM Server service account is properly identified to
DCOM on DM client machines (DM Web Server and workstations of
users running application integration and DM Extensions):
10. Select Start>Run and then type DCOMCNFG. Click Services.
11. Highlight Open Text eDOCS DM Server, right-click and select
Properties.
12. Click the Log On tab. Verify that the This account option is
selected and that the user name and password are those of
the DM Server service account. The user name must be in
the format:
domain name\account name
In DCOM configuration, you do not need to select the DM Server service
account under This account on DM client machines.
Changes to the Service Account
When making changes to the DM Server service account, such as
changing the password or identifying a different user as the service
account, we recommend you follow this procedure:
1. If you are changing a property, such as the password, make
the change at the network level.
2. Make the change in DCOM by running DCOMCNFG. This
will also update the service. Do not change the service via
the Control Panel. This is handled automatically when you
modify the account via DCOMCNFG.
CHECK THE SETUP OF THE DM SERVER SERVICE ACCOUNT
181
Problems Locating DM Server
Cannot Locate DM Server
When a client machine (that is, the DM Web Server or a user running
application integration or DM extensions) is unable to locate the DM
Server, you should first:
•
Verify that the DM Server service is started.
•
Verify that you can locate the DM Server over the network.
If the server is running and you can locate it over the network,
test the connection between the DM Server and the client
machine:
1. On the client machine, go to the DM API folder.
2. From a command prompt, run:
serverconnection
If the second client cannot connect to the server, contact Open Text
Technical Support.
Local Server Not on FOLB List
The servers in a failover and load-balancing (FOLB) cluster are defined
using Server Manager. By default, the local server is present in the server
list, even before the DM administrator identifies the members of the
cluster. If, for some reason, the local server is not listed, add the server
name manually.
If the local server name is not on the list, client users will see the
message, “Unable to fetch server list,” when they reach the Specifying
DM Server page while running the DM Connection Wizard.
NetWare Connectivity
Unable to Connect to NetWare Document Servers
First, verify that the Novell NetWare Client for Windows is installed on
the DM Server machine. Open Text does not support the use of the
Windows client for NetWare.
Then look at the NetWare Servers tab in the DM Server Manager for the
following items pertaining to the DM Server service account:
182
APPENDIX E
•
The NDS Tree Name field should contain only the tree
name, not a backslash or any other character.
•
The NDS Context field should display only the container
associated with the DM Server service account (or the DM
Server account name) and all parent containers to that
container. Do not include the tree name.
•
The User Name field should display only the user name of
the DM Server service account. Do not include container or
tree names.
For example, the following screen capture from NetWare
Administrator illustrates the organizational hierarchy in which a DM
Server service account (for example, DMadmin) is a member.
Miscellaneous Issues
DM Server Will Not Start and DCOM Errors Reported
In the Windows 2003/2000 Control Panel, select Services and look at
the Startup options listed for DM Server. In the Log On As box, verify
that This Account is selected and that the DM Server service account
name and password are shown.
If the DM Server service account is selected on the Startup options and
you are still getting DCOM errors, click OK on the Service dialog box
and exit the Control Panel. Then reenter Control Panel>Services, click
Startup, and click OK on the Service dialog box again. Sometimes just
“reinforcing” the options on the Service dialog box can correct the
problem.
“Can’t Start” Message Appears After Reboot
Messages that the DM Server service cannot be started can be generated
following a reboot when DM Server and the SQL server reside on the
same Windows machine. Once the reboot finishes and you run Server
Manager, you will see that the DM Server service has started after all.
The message appears because DM Server is dependent on other
services, such as the SQL server service. If on reboot, the other services
take longer to restart than DM Server, you will see the “can’t start”
message as well as messages in the system and application logs. DM
MISCELLANEOUS ISSUES
183
Server repeats the attempt to start until it is successful, so this is not
really a problem. However, you can eliminate the messages by making
the DM Server service dependent upon the other services. Here’s how
you would do it for the SQL server service:
1. Edit the registry using REGEDT32.
2. Go to HKEY_LOCAL_MACHINE\SYSTEM
\CurrentControlSet\Services\DM Server.
3. Double-click the DependOnService value. On the second
line, type the SQL server service name or Oracle instance
name.
This prevents DM Server from attempting to start until the SQL server
has started.
Note: For performance reasons, we do not recommend running DM Server
and the SQL engine on the same server machine.
Changes Made in DM Server Admin Tools not Reflected on Clients
When changes made in Library Maintenance or another DM Server
Admin Tool are not passed to clients, it’s likely that the DM Server
internal caches were not refreshed after the changes were made.
On Server Manager’s Caches tab, click Refresh All. If admin-tool
settings are changed frequently, consider selecting one of the automatic
cache-refresh options. See the DM Administration Guide for more
information.
DCOM Errors Related to SearchServer
Running the DOCSFusionSS Server service before the DM Server
service has started or after it has stopped causes DCOM errors to be
generated. To avoid them, stop the DOCSFusionSS Service before
shutting down the DM Server service.
Error #10029 - The maximum number of DBPROCESS already allocated
By default, DM Server sets DBProcesses to 255 and also creates a
registry entry for MaxDBProcesses with a value of 255. If your library
and/or SearchServer connections exceed 255, you will see this error in
your Event Log. DM Server supports up to 20 database connections for
each library and approximately four database connections for each
running SearchServer index.
To configure a larger number of connections:
184
APPENDIX E
1. Edit the following key in the registry:
HKEY_LOCAL_MACHINE
SOFTWARE
Hummingbird
DOCSFusion
2. Highlight the value MaxDBProcesses and click
Edit>Modify. In the Value data field, enter the number of
connections for your system. The value can be in either
Hexadecimal or Decimal format; select the corresponding
Base button.
3. Stop and restart the DM Server service.
Note: Increasing the number of database connections may require additional
memory.
Problems with the Microsoft SQL Client Software
If a user encounters problems while connecting to a database with DM,
verify that all DM Server machines are configured in exactly the same
way. For example, verify that the network library configuration, which
is set up using the Client Network utility, is the same for every DM
Server machine.
Microsoft SQL Server Errors
Error #1105
Error 1105 means the database is full.
If the database is not configured to expand dynamically, increase the
size of the database.
If the database is configured to expand dynamically, error #1105 means
you are out of disk space. As a temporary measure, and if possible,
delete any unnecessary files on the disk.
See the topic “Insufficient Disk Space” in SQL Books Online for
instructions on recovering from this error and preventing future fulldatabase problems.
We recommend you regularly monitor the drives where your database
files are stored to verify you have sufficient free space.
PROBLEMS WITH THE MICROSOFT SQL CLIENT SOFTWARE
185
Error #9002
Error #9002 indicates that the database’s transaction log is full.
If you have never or rarely received this error message, simply truncate
the transaction log and back up the database. If you are frequently
receiving this error, you should also extend the transaction log onto a
new filegroup or implement more frequent backups of the transaction
log.
To dump the transaction log after a 9002 error:
1. Back up the transaction log. For specific instructions on
backing up the transaction log, refer to your Microsoft
documentation.
2. If the backup fails, retry with the NO_LOG option. To do
this:
2.1 In the Database Backup/Restore window, select the
Schedule button.
2.2 Enter a new task name. The task name must be unique.
2.3 Replace the text in the SQL Command text box with
the following:
2.4 DUMP TRAN <database name> WITH NO_LOG
2.5 Select the Immediately option.
2.6 Click OK to execute the transaction log dump.
3. Back up the database. Refer to the Microsoft
documentation for instructions.
Note: It is important to back up the database after dumping the transaction log
using the NO_LOG or TRUNCATE_ONLY options. If you do not back up the
database, you will not be able to fully restore the database in the event of a
failure.
Another option is to configure the transaction log so that the file
expands dynamically. However, this option allows the transaction log
to expand until the disk is full.
We recommend you regularly monitor the drives where transaction log
files are stored to verify you have sufficient free space.
Error #10004
186
APPENDIX E
Error #10004 indicates that there is a problem connecting to the server.
Verify that the network is working properly and SQL Server is running.
Decreased
Performance or
High Server
Utilization
There are several things you can do to improve performance on a slowrunning machine:
•
Use the DBCC (database consistency checker) statements to
make sure that nothing is wrong with the database. See
your Microsoft documentation for instructions on using the
DBCC statements.
•
Run the UPDATE STATISTICS command. This will correct
any slowness caused by the SQL server choosing less than
optimal paths for retrieving data. See your Microsoft
documentation for instructions on running the UPDATE
STATISTICS command.
•
Users who perform unqualified searches (searches returning
all documents in a library) can slow the server dramatically.
A flag can be set in the server’s PCDOCS.INI file to prevent
users from executing unqualified searches. To do this, add
the following to the PCDOCS.INI file:
[QBESearch]
AllowUnqualifiedSearches = 0
•
Provide more physical memory on the server where SQL
Server is installed.
•
Add the following section to your PCDOCS.INI file:
[recentedits]
maxdays = 10
By default, the documents that appear in a user’s Quick Retrieve
list are the documents that have been edited in the last 30 days. By
adding this section to the PCDOCS.INI file and setting the value
to 10, the Quick Retrieve list will show the documents that have
been edited within the last 10 days.
Problems with the Oracle Client Software
If you run into problems while trying to connect to your Oracle
database with DM, chances are you will see one of the two error
messages listed below. Before calling Open Text Technical Support,
review the information listed below.
PROBLEMS WITH THE ORACLE CLIENT SOFTWARE
187
•
You see an ORA-12203 message.
What this means is that you cannot connect to the
destination database from your client. There are a few
possible causes of this, but chances are that you entered the
wrong connection data, and probably did not test your
connection after you entered the information. Go back and
check your connection information. Pay particular
attention to the following items: instance name, TCP/IP
address (for those using TCP/IP), IPX/SPX listener name
(for those using IPX/SPX), or server name and pipe name
(for those using Named Pipes). And for Net8, if you used
Net8 Assistant to configure your TNSNAMES.ORA file, if you
did not save the network configuration, nothing you
entered during the configuration process was saved.
•
You see an ORA-12224 message.
This message is displayed when the Oracle Listener cannot
be detected on the server. Either you set up your client
wrong (see #1), or the Oracle Listener was not started on the
server (even though the instance might have been). Check
with your Oracle DBA to make sure the Listener process has
been started, and try again. Also, if the Listener has been
started, ask your Oracle DBA if the database instance has
been added to the LISTENER.ORA file. If not, the DBA
must add it, stop, and restart the Listener.
•
Verify that you have the right components installed. For
example, if you are trying to connect via IPX/SPX, but it was
not installed with your Oracle client, install it. To see a list of
what is installed, run the Oracle Installer program, or use a
text editor to view the file NT.RGS, which can be found
under the ORAINST directory under your installation
location.
Note: Do not modify the contents of the .RGS files.
•
188
APPENDIX E
Verify that you’ve entered the same configuration
information for every client, particularly the database alias
for the database.
Index
C
Changing Database Access from Trusted
Connection 65
D
database administrator login and
password 37, 41
databases. See libraries.
DM Server
installing 17
prerequisites for installation 16
DM Server service account
creating on Windows 2000 146
rights required 146
DM Web Server
installing 24
prerequisites for installation 23
DM WorkFlow
common file locations 85
enabling mail notification 84
installing 83
on DM Web Server 90
server components 86
web server information 83
library requirements 84
post-installation setup 90
single library restriction 84
user synchronization 88
WorkFlow Engine requirements 84
DOCSADM login and password 41, 168
Document Sentry Agent
about 108
audit trail 116
configuring 115
creating a share 112
document server configuration 115
installation 110
requirements 109
document servers
defining 56
importing existing documents into 64
documents
defining document servers 56
importing into document servers 64
Profiles 151
E
eDOCS RM
additional installation information 124
assigning forms 124
configuring for custom reports 125
enable logging 124
installing
on DM Web Server 121
RM Administration Tool 122
server components 120
PCDOCS.INI file location 121, 124
repair option 126
uninstalling the RM Administration
Tool 126
eDOCS Suite Installer 14
error recovery 185
INDEX
189
G
M
groups, adding local to DM library 97
Microsoft SQL Server
disk space requirements for library 154
disk space requirements for server files 153
location of libraries 152
location of transaction logs 152
locations of SQL and data files 150
memory for user connections 159
memory requirements 152, 158
multiple libraries 152
user connections 152
user-connections 160
Windows service accounts 150
MSI Install Options 7
MSI Silent Install Samples 11
I
IIS Anonymous User account 83
indexing with DM Indexer
index location 72
index log files 77
index properties 72
multiple indexes for single library 78
installation
DM Server 17
DM Web Server 24
Document Sentry Agent (DSA) 110
Windows Security Service 93
L
libraries
N
network aliases, synchronizing with the
library 61
about 151
O
adding users to 61
Oracle
adding rollback segments to INIT.ORA 63,
64
creating a new tablespace 51
creating a temporary tablespace 53
database owners 168
editing tablespace storage parameters 48
improving search performance 170
modifications to INIT.ORA 169, 170
modifying a default tablespace 50
owners of multiple libraries on an
instance 41
prerequisites for library generation 169
rollback setments for multiple libraries 169
specifying number of redo log files 55
custom tables for industry types 35
populating with your data 64
SQL database administrator login and
password 37, 41
library generation
activities required after 64
activities required prior to 30
instructions for updating 32
logins and passwords
database administrator 37, 41
DOCSADM 41
Microsoft SQL Server service accounts 150
Oracle database owner 168
190
specifying number of rollback segments 54,
63, 64
specifying tablespaces 44
speeding up the library generation
process 168
tablespace names 168
troubleshooting client connection to
database 187
W
Windows
DSA requirements 109
Windows Security Service
configuring a document server 104
installing 93
starting and stopping 105
troubleshooting 106
P
PCDOCS.INI file
location 176
location of 31
settings used by eDOCS DM 176
performance, improving 187
S
Scripted Installs 7
security
Document Sentry Agent (DSA) 108
Services 11
SQL client software, installing 3
T
Transforms 6
troubleshooting 179
U
uninstalling RM Administration Tool 126
users
adding to libraries 61
synchronizing network aliases 61
Using Mixed and Windows
Authentication 65
INDEX
191