You are on page 1of 186

Goldfire Server

System Configuration Guide


(with Microsoft User Database)

Release 6.1.1
September 2010

20032010 Invention Machine Corporation. All rights reserved. Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database) No part of this book, or the software it describes, may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording, or otherwise, without the prior written permission of Invention Machine Corporation. The content of this book is furnished for informational use only, is subject to change without notice, and should not be construed as a commitment by Invention Machine Corporation. Invention Machine Corporation assumes no responsibility or liability for any errors or inaccuracies that may appear in this book. Invention Machine, Goldfire, and the Goldfire logo are trademarks of Invention Machine Corporation. All other companies and product names are trademarks or registered trademarks of their respective owners. They are used in this book in an editorial fashion only. No use of any trade name is intended to convey endorsement or other affiliation with Invention Machine Corporation. Invention Machine Corporation, 28 State Street, Suite 3600, Boston, Massachusetts, 02109, USA

Table of Contents
Table of Contents ....................................................iii Preface ...................................................................ix
Whats in this guide ............................................................... x Getting help .........................................................................xi

Chapter 1 New installation or upgrade? .................................. 1


Performing a new installation .................................................. 1 Upgrading from an earlier version ........................................... 2 Simple upgrade, or upgrade with modifications? ................... 2

Chapter 2 Getting ready to install ........................................... 3


Before you install the Goldfire Server ....................................... 3 Goldfire Server requirements: Hardware ............................. 4 Goldfire Server requirements: Software .............................. 4 Goldfire Server requirements: Microsoft SQL Server configuration ......................................................... 5 Goldfire Server requirements: MSDE 2000 configuration ........ 6 Goldfire Server requirements: Other software ...................... 6 Indexing server requirements: Hardware ............................. 8 Indexing server requirements: Software .............................. 8 Remote User database requirements: Microsoft SQL Server configuration ......................................................... 9 Configuring the User database ................................................ 9 Configuring a User database on the Goldfire Application server machine ........................ 10 Configuring the Goldfire Server with your user directory ........... 10

iv

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Chapter 3 Installing the Goldfire Server with a Microsoft User Database .................................................. 11
Pre-installation checklist ...................................................... 12 Additional components installed with Goldfire Server setup ....... 13 Installing the Goldfire Server ................................................ 13 New installation or upgrade installation? ............................ 14 Installing the Goldfire Server on multiple computers ........... 14 Configuring e-mail servers for Goldfire .............................. 15 New installation of the Goldfire Server ................................... 15 Beginning the installation ................................................ 15 Configuring the Microsoft SQL User database ..................... 20 Completing the installation .............................................. 22 Specifying the user directory ........................................... 36 Upgrading from an earlier version of the Goldfire Server .......... 42 Simple upgrade ............................................................. 42 Upgrade with modifications ............................................. 44 Installing an additional Goldfire Indexing server ...................... 47

Chapter 4 Connecting to document storage systems ............. 53


Connecting to ODBC-compliant databases .............................. 54 Connecting to Lotus Domino servers ...................................... 58 Connecting to Microsoft SharePoint Portal servers ................... 60 Connecting to Livelink servers .............................................. 61 Connecting to Documentum databases ................................... 61 Connecting to Windchill servers ............................................. 63 Processing large numbers of documents ............................ 63 Connecting to Teamcenter Enterprise servers ......................... 65 About the Teamcenter Enterprise configuration file ............. 66 Format of the Teamcenter Enterprise configuration file ........ 68 Connecting to Teamcenter servers ......................................... 70 Connecting to Teamcenter Community Collaboration servers ..... 72 Mapping different user directories for document-level security ... 72 User-mapping file ........................................................... 72 Custom user-mapping file ............................................... 73 Syntax of explicit rules ................................................... 73 Example content from a user-mapping file ......................... 74

Table of Contents

Chapter 5 What to do after you install the Goldfire Server .... 77


Running the Diagnostic utility ............................................... 77 Setting proxy-server time-out settings ................................... 78 Defining Goldfire administrator accounts ................................ 78 Providing connection settings ................................................ 78 Automatic sign-on ............................................................... 78 Creating corporate knowledge bases ...................................... 79 Defining user access to corporate knowledge bases ................. 79 Defining user access to the Repository ................................... 79 Registering the Goldfire Server ............................................. 80 Registering the Goldfire Server ........................................ 80

Chapter 6 Modifying Goldfire Server configuration settings .. 81


Modifying the Goldfire Application Service account ................... 81 Modifying the User database settings ..................................... 83 Adding or removing Indexing servers ..................................... 86

Chapter 7 Administrative tasks ............................................. 89


Troubleshooting the Goldfire Server ....................................... 90 Diagnostics and troubleshooting ....................................... 91 System Information, Logs, and Troubleshooting ................. 91 Excluding Goldfire Server files from antivirus protection ........... 93 Using Microsoft Windows NTBackup to back up Goldfire databases ..................................................... 94 Using NTBackup to back up and restore your system .......... 94 Synchronizing databases ................................................. 95 Installing and uninstalling the Language Pack ......................... 97 Configuring connections to remote Goldfire Servers ................. 97 About federated Goldfire Servers ...................................... 97 About the federated Goldfire Servers environment .............. 98 Administering a federated Goldfire Servers environment ...... 98 Controlling end-user access to remote corporate knowledge bases ......................... 99 Modifying the user-authentication method .............................. 99 Changing authentication from anonymous to authorized ...... 99 Changing authentication from authorized to anonymous .....101 Modifying automatic retrieval of end-user e-mail addresses .....102

vi

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Optimizing Sun Java for Goldfire Administrator .......................104 Creating and publishing custom news ...................................105 Setting custom variables .....................................................108 Tuning the number of viewable search results ...................109 Customizing text at the beginning and at the end of reports .....................................................109 Creating and editing the CustomVars.xml files ..................110 Recurrent processing settings ..............................................113 Converting nontext files to plain text ....................................114 Common fields ..............................................................114 Required fields for each entry .........................................115 Optional Fields for each entry .........................................116 Converting PDF files ......................................................116 Example of a CustomConverter.ini File .............................117 Specifying the number of CPUs for document processing .........118 Number of simultaneous connections to the KETemp folder .118 Moving an Indexing server from one computer to another .......119 Uninstalling an Indexing server ............................................120 Using the uninstall wizard ..............................................120 Manually uninstalling an Indexing server ..........................121 Disabling SYN attack protection ...........................................122 Uninstalling the Goldfire Server ............................................122

Chapter 8 Online update of the Goldfire Server ................... 123


Configuring the online update ..............................................123 Performing an online update ................................................129

Appendix A Goldfire services ................................................. 133 Appendix B Goldfire Server client programs .......................... 135
Invention Machine Goldfire ..................................................135 Goldfire Researcher ............................................................136 Starting Goldfire Researcher ...........................................137 Information flow during searches ....................................138 System Requirements for Goldfire Researcher ...................138 Goldfire Administrator .........................................................140 Starting Goldfire Administrator ........................................141 System Requirements for Goldfire Administrator ...............142

Table of Contents

vii

Goldfire Deep Web Link .......................................................144 System Requirements for Deep Web Link .........................145 Downloading and installing Deep Web Link .......................146 Importing Custom Links .................................................147 Deleting Custom Links ...................................................147 Goldfire Knowledge Base Producer ........................................148 Product requirements ....................................................149 Where to get Goldfire Knowledge Base Producer ................149 Starting Goldfire Knowledge Base Producer .......................149 Goldfire Desktop ................................................................150

Appendix C Installing the User database on a remote server ................................................. 151 Appendix D Supported document formats ............................. 159
Word processing formats .....................................................160 Desktop publishing format ...................................................162 Spreadsheet formats ..........................................................163 Presentation formats ..........................................................164 Graphic formats .................................................................164 E-mail format ....................................................................164 Compressed formats ...........................................................165 Other supported formats .....................................................165

Appendix E Advanced installation of the Goldfire Server ....... 167


Installing the Goldfire Server ...............................................167 Beginning the installation ...............................................168

viii

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Preface
Congratulations on your purchase of the Goldfire Server! The Goldfire Server does the following: Provides functionality for the Invention Machine Goldfire client, the Goldfire Researcher web client, and the Goldfire Administrator web client Stores corporate knowledge bases Integrates with your network user directory to manage user authentication

Upgrading to Goldfire Server 6.n

If you are upgrading to Goldfire Server version 6.n from version 4.1 or later, you can upgrade using the online update service. If you are upgrading to Goldfire Server version 6.n from a version earlier than 4.1, you must perform a new installation. You cannot use the online update service.

Avoid antivirus scanning

We recommend that Goldfire Server database files be excluded from antivirus scanning. Excluding database files helps you to avoid decreased performance as well as potential sharing violations that can block user access. Important: To ensure the integrity of the Goldfire databases, we recommend that Goldfire administrators use the Goldfire Server backup and restore utilities to back up and restore their Goldfire databases. For information about how to back up and restore the Goldfire Server databases, see Goldfire Administrator online help. It is also possible to back up Goldfire using the Microsoft Windows NTBackup program. For information about how to back up and restore Goldfire using NTBackup, see Using Microsoft Windows NTBackup to back up Goldfire databases on page 94.

Backing up Goldfire databases

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Whats in this guide


This guide provides detailed instructions for installing, configuring, and maintaining the Goldfire Server. This guide contains the following chapters: Chapter Chapter 1, New installation or upgrade?, provides an overview of what to do in each of these scenarios. Chapter 2, Getting ready to install, provides system requirements and describes possible User database configurations for the Goldfire Server installation. Chapter 3, Installing the Goldfire Server with a Microsoft User Database, details the procedures and settings for performing a new Goldfire Server installation. Chapter 4, Connecting to document storage systems, describes how to establish connectivity with ODBC-compliant databases, Lotus Domino servers, Microsoft SharePoint Portal servers, Livelink servers, Documentum databases, Windchill servers, Teamcenter Enterprise servers, and Teamcenter servers. Chapter 5, What to do after you install the Goldfire Server, provides a checklist for what to do after Goldfire Server installation. Chapter 6, Modifying Goldfire Server configuration settings, describes how to update Goldfire Server configuration settings. You can change the name and password of the Goldfire Application Service account, and you can change User database settings. Chapter 7, Administrative tasks, describes such tasks as sending system information and log files to Invention Machine support, modifying the user-authentication method and the automatic retrieval of e-mail addresses, creating and publishing custom news, setting custom variables, setting recurrent processing behavior for local documents, and uninstalling the Goldfire Server. Chapter 8, Online update of the Goldfire Server, describes how to configure and update availability-checking and how to perform an online update. Appendix A, Goldfire services, describes the Goldfire services that are installed with the Goldfire Server. Some or all of these services must be started or stopped to perform certain operations on the Goldfire Server. Appendix B, Goldfire Server client programs, describes the various client programs that can interact with the Goldfire Server. See Page 1 3

11

53

77

81

89

123

133

135

Preface Getting help

xi

Chapter Appendix C, Installing the User database on a remote server, details the procedures and settings for installing the User database on a remote server. Appendix D, Supported document formats, summarizes the document formats that can be successfully processed with Goldfire Administrator and Goldfire Knowledge Base Producer. Appendix E, Advanced installation of the Goldfire Server, describes the procedure for performing Advanced Goldfire Server installations.

See Page 151

159

167

Getting help
Invention Machine's technical support professionals and consultants are committed to helping our customers maximize returns on investment in our products. With both online and phone access, customers receive the benefits of the latest product updates, general information for product use, and hotline technical assistance. In addition, our professional services group is ready to help integrate our products into your environment, as well as to maximize their use with our training programs. Contacting technical support If you require technical assistance, please do the following: Access online support at the following web site: http://www.inventionmachine.com/support-center/ Send e-mail to support@inventionmachine.com With all e-mail requests, please include your name, company name, phone number, product and version information, and a detailed description of the problem or issue. Run the Goldfire System Information, Logs, and Troubleshooting utility. This utility gathers and compresses all system information and log files that are usually required by the Invention Machine support team to troubleshoot your system. It also enables you to send the information to Invention Machine either automatically or manually. For more information, see Troubleshooting the Goldfire Server on page 90.

xii

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

For immediate assistance, please call us at one of the following numbers: (617) 305-9250 (800) 595-5500 (US & Canada only)

Our telephone help desk hours are Monday through Friday, 8:30 AM to 8:00 PM, Eastern Time (ET). Contacting professional services Invention Machine's deployment experts help our customers to successfully integrate our Goldfire Server solution into their environment. Our experts also custom-link our precision knowledgeretrieval applications to our customers corporate repositories and subscription-based sites. To obtain pricing information, or to schedule professional services, please contact your regional sales manager, or e-mail us at service@inventionmachine.com.

1
New installation or upgrade?
This chapter contains information about the following: Performing a new installation Upgrading from an earlier version

Performing a new installation


You can configure the Goldfire Server on one computer or on multiple computers. Configuring the Goldfire Server on multiple computers is highly recommended for best performance. You perform a new installation of the Goldfire Server by running the setup program from Server Disc 1, as described in Installing the Goldfire Server on page 13. In addition to installing Goldfire Server application components, the Goldfire Server setup also configures your User database for storing all user-related information, including saved queries and reports. Your User database can be a database on one of the following: Microsoft SQL Server 2008 Microsoft SQL Server 2005 Express Edition Microsoft SQL Server 2005 Microsoft SQL Server 2000 Oracle Server

This book describes how to install the Goldfire Server with a Microsoft User database.

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Upgrading from an earlier version


If you are upgrading from Goldfire Server 2.0 4.0 to Goldfire Server 6.n, you must perform a new installation. You can upgrade from Goldfire Server 4.1 or later to Goldfire Server 6.n by performing an online update. For more information, see Online update of the Goldfire Server on page 123.

Simple upgrade, or upgrade with modifications?


For information about how to use the setup program on Server Disc 1 to perform a simple upgrade, see Simple upgrade on page 42. For information about how to use the setup program on Server Disc 1 to perform an upgrade with modifications to the current configuration settings, see Upgrade with modifications on page 44.

2
Getting ready to install
This chapter describes what is needed to integrate the Goldfire Server into your environment, including system requirements and User database configurations. This chapter includes the following topics: Topic Before you install the Goldfire Server Configuring the User database Configuring the Goldfire Server with your user directory See Page 3 9 10

Before you install the Goldfire Server


Before you perform a typical installation of the Goldfire Server, review the system requirements for the Goldfire Server, which are described in this section. In addition, choose your User database configuration and note the settings that are relevant to the Goldfire Server setup. For information about how to perform the installation, see Installing the Goldfire Server with a Microsoft User Database on page 11.

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Goldfire Server requirements: Hardware


The following hardware components are required for installing the Goldfire Server. Requirement Type CPU Memory Description x86 or x64, 4+ cores, 2 GHz or higher One of the following: 8 GB RAM or more if you install the Language Pack 4 GB RAM or more if you do not install the Language Pack Hard Disks 400+ GB SCSI Note: RAID is recommended Display Intranet Internet CD-ROM Drive 1024 x 768 resolution with 16-bit colors Network card 100 MBit/s or faster Access to the internet For installation from the CD

Goldfire Server requirements: Software


The following software components are required for the Goldfire Server. Requirement Type Operating System Description One of the following: Windows 2000 Server (all editions) Windows Server 2003 (all 32-bit and 64-bit editions) Windows Server 2008, including R2 (all 32-bit and 64-bit editions) Notes: Goldfire does not support Intel Itanium Architecture. The Microsoft SQL Server 2005 Express Edition that is shipped with the Goldfire Server is not compatible with Windows Server 2008 SP2 or with Windows Server 2008 R2. IIS Microsoft Internet Information Server (IIS) Version 5, 6, or 7

2 Getting ready to install Before you install the Goldfire Server

Requirement Type .NET

Description Microsoft .NET Framework 2.0 Note: Microsoft .NET Framework 3.0 and 3.5 both include .NET Framework 2.0.

Browser

Microsoft Internet Explorer 6.x, 7, or 8 (for accessing https://gfi.goldfire.com and internet sites) 128-bit encryption for connection to Goldfire.com.

Configuring IIS 7.0

On Windows Server 2008, the default application pool must be configured to run in Classic mode. To set the IIS default application pool to run in Classic mode 1 2 3 4 5 In Control Panel, click Administrative Tools, and then open Internet Information Services (IIS) Manager. From the list of servers, select the Goldfire Server machine, and then click View Application Pools. In the list of application pools, right-click DefaultAppPool, and then click Basic Settings. In the Edit Applications Pool dialog box, select Classic from the Managed pipeline mode list. Select the Start application pool immediately check box, and then click OK.

Goldfire Server requirements: Microsoft SQL Server configuration


One of the following must be installed if you want to use Microsoft SQL Server to host the User database on the Goldfire Server machine: MS SQL Server 2008 MS SQL Server 2005 SQL Server 2008 Enterprise Edition SQL Server 2008 Standard Edition SQL Server 2008 Workgroup Edition SQL Server 2008 Web Edition SQL Server 2008 Express Edition SQL Server 2005 Enterprise Edition SQL Server 2005 Standard Edition SQL Server 2005 Workgroup Edition

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

SQL Server 2005 Express Edition SQL Server 2005 Express Edition with Advanced Services

Note: MS SQL Server 2005 client components must also be installed on the machine where the Goldfire Server is installed. Microsoft SQL Server 2005 Express Edition can be installed from the Goldfire Server setup program. Note: The Microsoft SQL Server 2005 Express Edition that is shipped with the Goldfire Server is not compatible with Windows Server 2008 SP2 or with Windows Server 2008 R2. MS SQL Server 2000 Microsoft SQL Server 2000 Standard Edition Microsoft SQL Server 2000 Enterprise Edition

Goldfire Server requirements: MSDE 2000 configuration


The following requirement applies when the following two conditions apply: MSDE 2000 is used for the Goldfire Server User database Goldfire Application server hosts the User database

Goldfire Server requirements: Other software


The following table describes any additional software you might need on the Goldfire Server. Software Lotus Notes Client 5.0, 6.0, 6.5, 7.0, 8.0, or 8.5 Documentum Foundation Classes 5.n, 6.n Livelink 9.2, 9.5, 9.6, or 9.7 Publishing and Knowledge Management Collaboration Data Objects (PKMCDO) Required to process Lotus Notes databases Documentum sources Livelink sources Microsoft SharePoint server documents that were created with Microsoft SharePoint Portal Server 2001. PKMCDO are not required to process documents that were created with Microsoft SharePoint Portal Server 2003 or Microsoft SharePoint Portal Server 2007.

2 Getting ready to install Before you install the Goldfire Server

Software Windchill 8.n Windchill 8.n ProjectLink Windchill 8.n Foundation Windchill 8.n PDM Windchill 8.n PDMLink Pro/INTRALINK 8.n Windchill 9.n Windchill 9.n ProjectLink Windchill 9.n PDMLink Teamcenter Enterprise 2005 Teamcenter Enterprise 2007, MP01MP04 Teamcenter 2007 SP1 & SP2 Teamcenter 8.n Teamcenter Engineering 2005 SR1, MP7 Teamcenter Engineering 2007, MP7 Teamcenter Engineering 8.n Teamcenter Community 8.n

Required to process Windchill sources

Teamcenter Enterprise sources

Teamcenter sources

Teamcenter Community Collaboration sources

Note: If you use Microsoft SharePoint Portal Server 2003 to access documents that were created with Microsoft SharePoint Portal Server 2001, you must install client components for BackwardCompatible Document Libraries on the Goldfire Server machine. These components are available on the Microsoft SharePoint Portal Server installation CD. They can also be downloaded from the following web page: http://www.microsoft.com/downloads/ details.aspx?FamilyID=df39e250-f7ae-445a-ac9da80c9035ed6b&displaylang=en.

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Indexing server requirements: Hardware


The following hardware components are required for installing Goldfire Indexing servers. Requirement Type CPU Memory Description x86 or x64, 4+ cores, 2 GHz or higher One of the following: 8 GB RAM or more if you install the Language Pack 4 GB RAM or more if you do not install the Language Pack Hard Disks 400+ GB SCSI Note: RAID is recommended Display Intranet Internet CD-ROM Drive 1024 x 768 resolution with 16-bit colors Network card 100 MBit/s or faster Access to the internet For installation from the CD

Indexing server requirements: Software


The following software components are required for Goldfire Indexing servers: Requirement Type Operating System Description One of the following: Windows 2000 Professional Windows 2000 Server (all editions) Windows 2003 Server (all 32-bit and 64-bit editions) Windows 2008 Server, including R2 (all 32-bit and 64-bit editions) Windows XP Professional (all 32-bit and 64-bit editions) Windows Vista (all 32-bit and 64-bit editions) Windows 7 (all 32-bit and 64-bit editions) Note: Goldfire does not support IPv6 on Windows Server 2008 or on Windows Vista.

2 Getting ready to install Configuring the User database

Remote User database requirements: Microsoft SQL Server configuration


One of the following must be installed if you want to use Microsoft SQL Server to host the User database on a remote server: MS SQL Server 2008 MS SQL Server 2005 SQL Server 2008 Enterprise Edition SQL Server 2008 Standard Edition SQL Server 2008 Workgroup Edition SQL Server 2008 Web Edition SQL Server 2008 Express Edition SQL Server 2005 Express Edition Note: The Microsoft SQL Server 2005 Express Edition that is shipped with the Goldfire Server is not compatible with Windows Server 2008 SP2 or with Windows Server 2008 R2. SQL Server 2005 Express Edition with Advanced Services SQL Server 2005 Enterprise Edition SQL Server 2005 Standard Edition SQL Server 2005 Workgroup Edition

Note: MS SQL Server 2005 client components must also be installed on the machine where the Goldfire Server is installed. MS SQL Server 2000 Microsoft SQL Server 2000 Standard Edition Microsoft SQL Server 2000 Enterprise Edition

Configuring the User database


You can configure the Goldfire User database on either of the following: Goldfire Application server machine Remote database machine

This section describes how to configuration the User database on the Goldfire Application server machine. For information about how to configure the User database on a remote machine, see Appendix C, Installing the User database on a remote server, on page 151.

10

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Configuring a User database on the Goldfire Application server machine


In this situation, the User database resides on the machine where the Goldfire Application server is installed. Use the following table to determine what to do before and during the Goldfire Server setup, as well as what setup options to select. When Before installing Goldfire Server Where On the Goldfire Application server machine Do What Install a compatible Microsoft server. Note: If you do not install a compatible version, Goldfire Server setup prompts you to install the Microsoft SQL Server 2005 Express Edition. In step 8 of the Beginning the installation procedure (page 19), choose a New or an Existing database.

During Goldfire Server setup

On the Goldfire Application server machine

Configuring the Goldfire Server with your user directory


Goldfire Server is configured during installation to connect with your existing user directory. The user directory can be any of the following: Supported user directories NT Domain or Active Directory (mixed mode) Active Directory (native mode) LDAP

For detailed information about settings, see Specifying the user directory on page 36.

3
Installing the Goldfire Server with a Microsoft User Database
This chapter describes how to install the Goldfire Server, configuring it with a Microsoft User database. You can configure the Goldfire Server with any of the following: Microsoft SQL Server 2005 Express Edition Microsoft SQL Server 2000 Microsoft SQL Server 2005 Microsoft SQL Server 2008

For information about how to configure the Goldfire Server with an Oracle User database, see GF Server System Configuration (Oracle).pdf on Server Disc 1. This chapter includes the following topics: Topic Pre-installation checklist Additional components installed with Goldfire Server setup Installing the Goldfire Server New installation of the Goldfire Server Upgrading from an earlier version of the Goldfire Server Installing an additional Goldfire Indexing server See Page 12 13 13 15 42 47

12

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Pre-installation checklist
IMPORTANT! You must install the Goldfire Server from an account that has administrator privileges on the local installation computer. This account is the Goldfire Application Service account. The Application Service account must be registered with the local network domain, and the account must have access to the internet. In addition, we recommend that the Application Service account be assigned a password that does not change. The Application Service account is used to start and run the following: Checklist All Goldfire services All DCOM processing components

Application Service account

Before you begin to install the Goldfire Server, do the following: Verify all hardware and software requirements for your specific configuration. See Getting ready to install on page 3. Decide on the type of user directory with which you will integrate the Goldfire Server: NT Domain, Active Directory, or LDAP. If you are integrating with NT Domain or with Active Directory, verify the name of the default domain. If you are integrating with Active Directory, verify the login ID and password (if you do not use the Application Service account to access the directory). If you are integrating with LDAP, verify the required LDAP parameters. See Configuring with LDAP on page 38.

If the Goldfire Server will connect to the internet through a proxy server, verify the appropriate proxy settings with your network administrator. Verify that the Application Service account has the appropriate database access rights to the User database server. If you are configuring with a Lotus Domino server, verify the Lotus Notes ID, and make sure that it has the appropriate access rights for processing all Lotus Notes databases. Verify the name of your SMTP mail server and the port number, used for sending Goldfire notifications. Verify the name of your incoming mail server and the port number, used for receiving replies to messages in the problem-sharing forum. Close all Windows programs.

3 Installing the Goldfire Server with a Microsoft User Database Additional components installed with Goldfire Server setup

13

Additional components installed with Goldfire Server setup


In addition to Goldfire Server application components, the following can also be installed during the Goldfire Server setup: What is installed Microsoft SQL Server 2005 Express Edition When it is installed When no compatible version of a database product is found for use by the Goldfire Server User database. Note: You are prompted to choose whether to install this component. MDAC 2.8 When no compatible version of a database client is found for connecting to the Goldfire Server User database. Note: You are prompted to choose whether to install this component. Choose this if you want to connect to a remote SQL server. MSXML 4.0, for processing XML documents If not already installed

Installing the Goldfire Server


IMPORTANT! You must install the Goldfire Server from an account that has administrator privileges on the local installation computer. This account is the Goldfire Application Service account. The Application Service account must be registered with the local network domain, and the account must have access to the internet. In addition, we recommend that the Application Service account be assigned a password that does not change. The following components must already be installed before you begin the Goldfire Server setup program: Microsoft Internet Information Server (IIS) Microsoft Internet Explorer Microsoft .NET Framework 2.0

If these components are not installed, you cannot install the Goldfire Server. After you install the Goldfire Server, see What to do after you install the Goldfire Server on page 77.

14

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

New installation or upgrade installation?


How you install the Goldfire Server depends on whether you are installing the Goldfire Server for the first time (a new installation) or you are upgrading from an earlier version of the Goldfire Server to the current version. If you are upgrading from an earlier version of the Goldfire Server, you can run the Setup procedure in two ways: As a simple upgrade As an upgrade with modifications

For information about upgrading the Goldfire Server, see Upgrading from an earlier version of the Goldfire Server on page 42. For information about performing a new installation of the Goldfire Server, read the following sections.

Installing the Goldfire Server on multiple computers


For improved performance, you can install additional indexing components of the Goldfire Server on different computers. Goldfire application components are installed on the Application server, and additional indexing components are installed on one or more Indexing servers. Locating index processing on separate computers provides better and more consistent performance. When you configure the Goldfire Server on multiple computers, you typically install the Application server and an Indexing server on the first computer, and you install one or more additional Indexing servers on other computers. With a Typical installation, the Application server components and the Indexing server components are installed on a single computer. But you can also set up the Goldfire Server in the following way: Computer 1, where only the Goldfire Application server components are located Computers 2, 3, n... where the Goldfire Indexing server components are located

For information about installing the Goldfire Server in this way, see Appendix E, Advanced installation of the Goldfire Server, on page 167.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

15

Configuring e-mail servers for Goldfire


We strongly recommend that when you are installing the Goldfire Server, you configure an outgoing e-mail server (SMTP) and an incoming e-mail server (POP3 or IMAP4) to work with Goldfire. Typically, you will configure the same e-mail server for both outgoing and incoming e-mail messages. If you do not configure e-mail servers for Goldfire when you use the setup program to install the Goldfire Server, you can configure them later using Goldfire Administrator. For details, see Goldfire Administrator online help. SMTP mail server Incoming mail server Goldfire uses the outgoing SMTP mail server to send important notifications to Goldfire administrators and to Goldfire end users. Goldfire uses a dedicated problem-sharing mailbox on the incoming mail server to capture e-mail replies to notifications that are sent when new questions or replies are posted to the Goldfire problem-sharing forum. For detailed information about using the problem-sharing forum, see Invention Machine Goldfire online help.

New installation of the Goldfire Server


Installing Goldfire Server in three stages You install the Goldfire Server in three stages: Stage 1: Beginning the installation (page 15) Stage 2: Configuring the Microsoft SQL User database (page 20) Stage 3: Completing the installation (page 22)

The following sections describe the steps to follow at each stage.

Beginning the installation


You can exit the setup at any time by clicking Cancel. 1 2 On the Goldfire Application server machine, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard.

16

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue. The Type of Installation screen appears.

Do one of the following: Click Typical to install the Goldfire Application server and one or more Goldfire Indexing servers, and then proceed with step 5 on page 17. Click Add Indexing Servers to install one or more additional Indexing servers. For information about installing additional Indexing servers, see Installing an additional Goldfire Indexing server on page 47. Click Advanced to do any of the following: Install Goldfire application components and indexing components on a single computer. For details, see Advanced installation of the Goldfire Server on page 167. Install a stand-alone Goldfire Application server on one computer and one or more Indexing servers on one or more

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

17

separate computers. For details, see Advanced installation of the Goldfire Server on page 167. Install the User database on a remote machine. For details, see Installing the User database on a remote server on page 151.

Type the product serial number, which is printed on the Goldfire Server Installation CD-ROM case.

Click Next to continue.

18

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Wait while Setup checks for required software components. The required components screen looks like this:

Click Next to continue. The Database Version screen appears:

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

19

Database version

Click one of the following: Microsoft SQL Server 2005 Express Edition Microsoft SQL Server 2000 Microsoft SQL Server 2005, 2008

Click Next to continue. 8 Do one of the following: If the Microsoft SQL Server is not installed, you are prompted to exit the Goldfire Server setup and install it. After you install the Microsoft SQL Server, you must restart Goldfire Server setup. If you do not install a Microsoft SQL Server at this time, you must choose a different database product, otherwise you cannot complete the Goldfire Server setup. If the Microsoft SQL Server is already installed, the Database type screen appears:

Database type

Click one of the following: Create a new database Use an existing database

Click Next to proceed to the next stage, Configuring the Microsoft SQL User database.

20

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Configuring the Microsoft SQL User database


If you chose Create a new database, the New Database screen appears:

If you chose Use an existing database, the Existing Database screen appears:

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

21

Enter the database parameters for your Microsoft SQL Server configuration: a In the Server box, enter the name of the server (up to 64 characters). If you do not see the required server in the list, either the server might be disabled, or there might be problems with the network. Without quitting setup, try to fix the server or network problem. Then return to the Goldfire Server setup, and click Refresh to update the server list. If the server name still does not appear in the list, type the server name in the Server box.

User database server

User database name

In the Database Name box, we recommend that you keep the default name. If you need to modify the database name (because it must conform to your companys naming conventions, for example), edit the Database Name (up to 64 characters).

Authentication type

Specify the account that Goldfire Server setup will use to create a new database or to create database objects in an existing database on the SQL server. This account must have DBA privileges. Click one of the following: Windows Authentication, which uses the current Application Service account to access the SQL server. SQL Server Authentication, which uses an existing SQL server account. You must enter the Login and Password for this account.

Data file path, or database objects

The data file path option (or the database objects option) specifies how the folder or the database objects for the User database are created. For a new User database, Create during setup (local database only) specifies that Goldfire Server setup creates the required folder for the database. The new User database must reside on the present machine. For a new User database, Use existing specifies that the Goldfire Server use an existing database folder. The new User database can reside on the local machine or on a remote machine. For an existing User database, Create during setup specifies that Goldfire Server setup creates the required database objects for the User database. The User database can reside on the local machine or on a remote machine.

22

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

For an existing database, Use existing specifies that the Goldfire Server use existing User database objects from an earlier Goldfire Server installation. If you select Use existing, you must type this path when you specify where to install Goldfire Server database components. Click Next to continue. The User Authentication screen appears:

User Authentication

Specify the account that Goldfire services will use to access the SQL server after the Goldfire Server is installed and running. This account must have at least RESOURCE privileges: Windows Authentication, which will use the current Application Service account to access the SQL server. SQL Server Authentication, which will use an SQL server account. You must enter the Login and Password for this account. If this SQL server account does not yet exist, Goldfire Server setup tries to create it.

Click Next to proceed to the next stage, Completing the installation.

Completing the installation


After you finish configuring the Microsoft SQL User database, the Application Service account password screen appears.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

23

Application Service account password

Specify a password for the Application Service account.

Click Next to continue. User directory 2 Select the user directory system to use to define end-user accounts for Goldfire Server clients.

NT Domain or Active Directory (mixed mode) LDAP Active Directory (native mode)

24

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

For instructions about how to specify user directory settings, see Specifying the user directory on page 36. Click Next to continue. Goldfire installation directory 3 (Optional) To change the default installation directory, click and then select an installation folder. ,

(Optional) To change the default paths where specific Goldfire Server data will be installed, do the following: a b Click Advanced. Change the default paths of the DB, Catalog, Global Config File, and Temporary Folder by typing the paths in the text boxes. You can also click the button at the right of the text box, and then select the folder from the network directory. Note: DB path might be absent if you are connecting to an existing User database and you are not creating new database objects. c Click OK to accept your changes and return to setup.

Language Pack

(Optional) To install French, German, and Japanese semantic engines, select the Language Pack check box. (Optional) If you have earlier versions of Goldfire Innovator or Goldfire Knowledge Base Producer (or both) installed on your network, select the Client Update Package check box. You must install the Client Update Package if you want to enable end users of Goldfire to run the Goldfire Online Update program on their computers.

Client Update Package

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

25

7 Add Indexing servers 8

Click Next to continue. (Optional) Add one or more additional Indexing servers on this computer.

To add another Indexing server, click Add. To remove an existing Indexing server, click the name of the Indexing server in the list, and then click Remove. (Optional) To modify the paths where the Indexing server components are installed, click the name of an Indexing server in the list, and then click Modify. The following dialog box appears:

Change the default paths of the Temporary Folder, Doc Storage, and Word Index by typing the paths in the editable

26

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

fields. You can also click network directory. b c Network share names 9

, and then select the folder from the

Edit any port numbers you want to change. Click OK to accept your changes and return to setup.

Specify the network share names for the local paths to be used by the Goldfire services on the Indexing servers.

We recommend that you accept the default values. The setup program automatically creates these network paths with full read/ write public network share rights. If you want to restrict these rights, you must do so manually using Windows Explorer. Click Next to continue.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

27

Goldfire client access

10 (Optional) Specify the server address and the virtual folder names for Administrator (Goldfire Administrator), Web client (Goldfire Researcher), and Goldfire client (Invention Machine Goldfire).

We recommend that you leave the default virtual folder names unchanged. Note: You cannot modify these virtual folder names after installation. To specify a different web site as the location for the virtual folders, choose a web site from the Web Site list. Click Refresh to refresh the Web Site list. Authentication method 11 Select one of the following authentication methods: Built-in authentication page for users. Select this check box to specify that end users should log in to the Goldfire Server by means of anonymous authentication in Internet Information Services (IIS). Authentication need not be the users network login ID. Users of Goldfire Researcher open the default login page in their browsers, and then type their user names and passwords. Users of Goldfire type their user names and passwords in the login window.

28

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

IIS-based authentication for users. Select this check box to specify that end users log in to the Goldfire Server by means of one of the following authentication methods supported by Internet Information Services (IIS): Basic authentication (password is sent in clear text). End users must type a user name and password when starting a Goldfire Server client. The user name and password are sent over the network in unencrypted form. Digest authentication for Windows domain servers. End users must type a user name and password when starting a Goldfire Server client. The users password is encrypted, and mechanisms are provided for helping to prevent some common server attacks (such as a replay attack). To use digest authentication in Windows 2000, the server must have access to an Active Directory server that is set up for digest authentication. If the server running IIS is not an Active Directory server, or if it does not have access to the Active Directory, this authentication method will not work. For more information about making the server an Active Directory server, see Windows 2000 documentation. Integrated Windows authentication. End users gain access to the Goldfire Server when they log in to their computers. When they start a Goldfire client, they need not provide a user name and password. This method uses a cryptographic exchange with the users Internet Explorer to confirm the identity of the user. For detailed information about these authentication methods, see your IIS documentation.

Click Next to continue. Check HTTPS setting 12 Invention Machine recommends that you use the HTTPS protocol for secure data transfer.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

29

Click the here link to check whether your computer supports the HTTPS protocol. Click Next to continue. Online Update settings 13 (Optional) In the Online Update settings, specify how you want to download online update files.

30

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

If you want to do this Automatically download online update files when they become available

Do the following a Select the Enable automatic download of updated files check box. b Type the destination path in the Save updated files to field.

Manually download online update files

Clear the Enable automatic download of updated files check box.

Note: You can also specify these settings after installation. To do so, choose Start Programs Goldfire Server Configure Online Update Service from the Windows taskbar. For more information, see Configuring the online update on page 123. 14 In the E-mail Online Update Notification to field, type the e-mail address to receive notifications about the following: Online Update availability Download status Errors encountered during an update

Click Next to continue.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

31

Outgoing e-mail server settings

15 Specify the following outgoing e-mail server settings:

In the Outgoing SMTP mail server box, type the name of the outgoing e-mail server. The Goldfire Server uses this mail server to send notifications to end users and to Goldfire administrators.

In the Port box, type the port number of the outgoing mail server. Default: 25.

Incoming e-mail server settings (for problemsharing)

16 The Goldfire Server uses a special problem-sharing mailbox on an incoming mail server to capture e-mail replies to questions and to other replies that are posted to the problem-sharing forum. This problem-sharing mailbox is used only by the Goldfire Server. Specify the following incoming e-mail server settings: a b c d e Select the type of incoming e-mail server that you will use: POP3 or IMAP4. Default: POP3. Type the name of the incoming e-mail server in the Incoming mail server box. Type the port number of the incoming mail server in the Port box. Type the e-mail address for the problem-sharing mailbox on the incoming e-mail server. Type the user name and password that the Goldfire Server will use for access to the problem-sharing mailbox.

32

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

(Optional) To specify a Secure logon method, click one of the following: SPA (Secure Password Authentication) APOP (for a POP3 server) or CRAM-MD5 (for an IMAP4 server)

(Optional) To use an encrypted connection, select the SSL/TLS encrypted connection check box.

Click Next to continue. Port numbers 17 (Optional) Edit any port numbers you want to change.

Click Next to continue. Proxy server settings 18 (Optional) If you use a proxy server to access internet documents, select the Connect through a proxy server check box, and then specify the proxy settings. (If you do not use a proxy server, clear

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

33

the Connect through a proxy server check box and proceed to step 19.)

Automatically detect settings: Specifies to automatically detect proxy-server settings or automatic configuration settings for connecting to the internet. A proxy server acts as an intermediary between your internal network and the internet, retrieving files from remote web servers. Automatic configuration settings are contained in a file provided by your system administrator. Use automatic configuration script: Specifies that Goldfire use configuration information contained in a file provided by your system administrator. Connect through a proxy server: To connect through a proxy server, select this check box. The following options become available: Proxy address and Port: Type the address and port number of the proxy server that you want to use to connect to the internet. Bypass proxy server for local addresses: Specifies whether you want to use the proxy server for all local (intranet) addresses. Because a proxy server acts as a security barrier between your internal network and the internet, you might need extra permission from your system administrator to gain access to web pages through a proxy server. You might be able to access local addresses faster if you do not use the proxy server.

Use proxy authentication: Ask your system administrator if you need extra permission to gain access to web pages through a

34

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

proxy server. If you do, select this check box, and then enter the Username and Password. Click Next to continue. Lotus Domino server settings 19 (If a Lotus Notes Client is installed) Specify the settings for connecting to one or more Lotus Domino servers. Important:If you do not specify the Lotus Domino server settings at this time, you must reinstall the Goldfire Server to enter these settings later.

From the Options list, select one of the following: Support Lotus Notes. This enables Lotus Notes processing in Goldfire Administrator, allowing the processing of Lotus Notes databases for supported versions of Lotus Notes. No Lotus Notes Support. This disables Lotus Notes processing in Goldfire Administrator.

Type the Lotus Notes Password. Only documents that can be accessed with this Lotus Notes password can be processed. Goldfire Server setup writes this password, encrypted, into the registry, and it adds the DLL with the Lotus Notes settings to the NOTES.INI file. From the Link type list, select one of the following link types: Generate Domino server links. This generates links based on the HTTP location of a Domino server. If you select this link type, you must type an HTTP link prefix in the labelled text box. This prefix begins the URL of any server that you select for processing. For example: http://Domino001

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

35

If you want to link to more than one Domino server, you must run the LNIniEditor.exe program after you install the Goldfire Server. This program maps Domino server names to unique HTTP link prefixes. The program is located in the serv folder in the Goldfire Server installation directory. Generate Lotus Client link. This generates links based on the local-share location of the document and on NDL-buffer information. On a Windows network, a Lotus Notes client is used to view Notes documents. If you select this link type, you must type a Local link prefix in the labelled text box. This prefix specifies a networkshared folder where NDL files are stored. For example: \\Domino001\ndl Use HTTP location for NDL. This generates links based on the HTTP location of the NDL-buffer information. A Lotus Notes client is used to view Notes documents, but your users are not on the Windows network and cannot access the server through a network share. If you select this link type, you must type a Local link prefix in the labelled text box. This prefix specifies the drive and folder that temporarily store NDL files. For example: C:\NDLTemp You must also type a Virtual Folder name. This provides access to the directory whose path you entered in the Local link prefix box. After you install the Goldfire Server, use Goldfire Administrator to install the Goldfire Plug-in. For more information about connecting to Lotus Domino servers, see Connecting to Lotus Domino servers on page 58. Click Next to continue.

36

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

20 (Optional) Review the list of Goldfire Server components to be installed.

To change any installation settings, click Back to return to a previous screen and edit the settings. Note: This will not cause you to lose any information already entered. Begin to install 21 Click Next to begin the installation. You are notified if errors are encountered, and when the installation is complete.

Specifying the user directory


During Goldfire Server setup, you specify the user directory system to use to define end-user accounts for Goldfire Server clients (see User directory on page 23). You specify one of the following user directory types: NT Domain or Active Directory (mixed mode) LDAP Active Directory (native mode)

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

37

This section includes the following topics: Topic Configuring with NT Domain or Active Directory (mixed mode) Configuring with LDAP Configuring with Active Directory (native mode) See Page 37 38 40

Configuring with NT Domain or Active Directory (mixed mode)


You can configure the Goldfire Server to use NT Domain or Active Directory (mixed mode). If you select this user directory configuration, the following screen appears during Goldfire Server setup:

NT Domain or Active Directory (mixed mode)

Specify the following settings: (Optional) Default Domain. This automatically specifies the domain prefix for users in the default domain as part of their User Name during login to a Goldfire Server client, so that they do not have to type it. (Optional) Retrieve e-mail addresses for Goldfire users. Select this check box to automatically retrieve e-mail addresses for end users when user accounts are created in Goldfire Administrator.

38

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

You can change these settings later, as described in Modifying automatic retrieval of end-user e-mail addresses on page 102. (Optional) Use an alternate account to access Active Directory. Select this check box to use an account other than the one that starts Goldfire services for accessing the Active Directory. Then enter the Login and Password for this account. When you finish specifying NT domain settings, return to step 3 on page 24.

Configuring with LDAP


If you choose to configure with the LDAP user directory, you specify LDAP settings on two screens. The Goldfire Server can be configured with only one LDAP server (LDAP Version 3 is supported). Important: Before you begin, be sure to verify and test the LDAP parameters you need to enter. LDAP settings: Screen 1 In the first screen for LDAP configuration, you specify the following settings:

Access
Default Servers: Specify one primary LDAP server address. If this LDAP server includes referrals, type the addresses of these LDAP servers after the primary server, separated by commas. For example: primary_ldap_server, ldap_server_1, ladp_server_2 The first address, which specifies the primary server, is followed by its referrals. Login and Password: When Anonymous bind is not possible, you must enter a valid Bind Distinguished Name (DN) string for the Login, and a corresponding Bind Password. If you leave these fields blank, the Goldfire Server tries to bind anonymously. Authentication method: Select one of five possible authentication methods: Distributed password authentication Microsoft Network authentication Generic Security Services Windows NT LAN Manager (default) LDAP authentication Use LDAP authentication only if the Use simple login type check box is selected.

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

39

Search Filter
User filter: Specify the elements that will be used to generate a unique user list. For example: ( objectClass=Person ) Parentheses are required. Group filter: Specify the elements that will be used to generate a unique user group list. ( objectClass=groupOfUniqueNames ) Parentheses are required. LDAP settings: Screen 2 In the second screen for LDAP configuration, specify the following settings:

Attributes
User attributes: Specify up to three parameter names that define the information displayed for each user in Goldfire Administrator. The first field must be a unique user ID for logging in to the Goldfire Server. For example:

uid, ucn
The first attribute is a unique user ID, the second is the user common name. Users search DN: Specify the Distinguished Name that represents the default point of entry in the Directory Server where user lookup will start. Click DN to fill in the attributes automatically. If you are using Anonymous bind, you can supply the base DN. Group attributes: Specify up to two parameter names that define what user group information is displayed in Goldfire Administrator. For example:

gcn, description
The first attribute is a group common name, the second is the group description. Group user attributes: Enter the parameter name used to get the users who are included in the group specified by Group attributes. For example: uniqueMember Group search DN: Specify the Distinguished Name that represents the default point of entry in the Directory Server where the group lookup will start. Click DN to fill in the attribute automatically. Retrieve e-mail addresses for Goldfire users: Select the check box if you want the Goldfire Server to automatically retrieve e-mail addresses for end users when user accounts are created in Goldfire Administrator, or by self-registration. Then, for the E-mail

40

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

attribute, specify the LDAP directory field that contains user e-mail addresses. Typically, this attribute is mail. You can change this setting later, as described in Modifying automatic retrieval of enduser e-mail addresses on page 102.

Result Fetching
Page size: Enter the number of results to be fetched from the LDAP server at one time. The default value is 10.

LDAP options
Use SSL connection: When this option is selected, the Goldfire Server communicates with your directory server using only network connections secured with the Secure Sockets Layer (SSL). Follow referrals: When the LDAP architecture is distributed over multiple servers, selecting this option will automatically follow referrals to a different server. This option is selected by default. Search time-out: Specifies the number of seconds after which the server should discontinue its attempt to complete a service routine. The value 0 indicates that no time-out limit is set. Dereference aliases specifies how alias objects should be handled during search. The term dereference specifies that object aliases be treated as independent entities, rather than as references to some base object. The possible settings include the following: Never: Do not dereference aliases in searching or in locating the base object of the search. Searching: Dereference aliases in subordinates of the base object in searching, but not in locating the base object of the search. Finding: Dereference aliases in locating the base object of the search, but not when searching subordinates of the base object. Always: Dereference aliases both in searching and in locating the base object of the search.

When you finish specifying LDAP settings, return to step 3 on page 24.

Configuring with Active Directory (native mode)


You can configure the Goldfire Server to use Active Directory (native mode).

3 Installing the Goldfire Server with a Microsoft User Database New installation of the Goldfire Server

41

If you select this user directory configuration, the following screen appears during Goldfire Server setup:

Active Directory (native mode) settings

Specify the following settings: (Optional) Default Domain. This automatically specifies the domain prefix for users in the default domain as part of their User Name during login into a Goldfire Server client, so that they do not have to type it. (Optional) Retrieve e-mail addresses for Goldfire users. Select this check box to automatically retrieve e-mail addresses for end users when user accounts are created in Goldfire Administrator. You can change these settings later, as described in Modifying automatic retrieval of end-user e-mail addresses on page 102. (Optional) Use an alternate account to access Active Directory. Select this check box to specify that an account other than the one used to start Goldfire services be used for accessing the Active Directory. Then enter the Login and Password for this account. When you finish specifying Active directory settings, return to step 3 on page 24.

42

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Upgrading from an earlier version of the Goldfire Server


If you are upgrading from an earlier version of the Goldfire Server, you can do either of the following: Perform a simple upgrade that retains all of the existing Goldfire Server configuration settings (see Simple upgrade on page 42). Perform a full upgrade, enabling you to modify the existing Goldfire Server configuration settings (see Upgrade with modifications on page 44).

Simple upgrade
How to perform a simple upgrade You can exit the setup at any time by clicking Cancel. 1 2 On the Goldfire Application server machine, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard. If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue.

3 Installing the Goldfire Server with a Microsoft User Database Upgrading from an earlier version of the Goldfire Server

43

The following window appears:

Click Simple Upgrade. This option upgrades the Goldfire Server, retaining all of the current Goldfire Server configuration settings. Click Next to continue.

5 6

Wait while Setup checks for required software components. Click Next to continue. Type the password for the Application Service account.

Click Next to continue.

44

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Review the list of Goldfire Server components to be installed. To change any installation settings, click Back to return to a previous screen and edit the settings. Note: This will not cause you to lose any information already entered.

Click Next to begin the installation. You are notified if errors are encountered, and when the installation is complete.

Upgrade with modifications


The following procedure is essentially the same as the procedure for new installations (see New installation of the Goldfire Server on page 15). How to perform an upgrade with modifications You can exit the setup at any time by clicking Cancel. 1 2 On the Goldfire Application server machine, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard. If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue.

3 Installing the Goldfire Server with a Microsoft User Database Upgrading from an earlier version of the Goldfire Server

45

The Type of Installation screen appears:

Click Upgrade with Modifications. This option upgrades the Goldfire Server, enabling you to make changes to the current Goldfire Server configuration settings. Click Next to continue. The second Type of Installation screen appears:

Click one of the following: Single-server configuration to install the Goldfire application components and indexing components on one computer.

46

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

If you click Single-server configuration, proceed with step 5 on page 17. Multiple-server configuration to install the Goldfire Server in a multiple-server configuration on two or more machines. If you click Multiple-server configuration, the Goldfire Server Components screen appears.

Do one of the following: Click Application Server (must be installed on the first server) to install only the Application server. Proceed with step 5 on page 17, and follow the instructions on the Setup screens. Click Indexing Server to install only the Indexing server. To use this option, the Application server must already be installed. This option is the same as the Add Indexing Server option. Proceed with step 5 on page 48, and follow the instructions on the Setup screens. Click Application Server and Indexing Server to install both servers on the same machine. This option is the same as the Typical Installation option. Proceed with step 5 on page 17, and follow the instructions on the Setup screens. User database installation. For details about installing the User database, see Installing the User database on a remote server on page 151.

3 Installing the Goldfire Server with a Microsoft User Database Installing an additional Goldfire Indexing server

47

Installing an additional Goldfire Indexing server


The following procedure describes how to install an additional Goldfire Indexing server. 1 2 On the computer where the Indexing server will reside, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard. If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 4 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue. Click Add Indexing Servers.

Click Next to continue.

48

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Specify the password for the Application Service account.

The Application Service account is used to start and run all Goldfire services. Click Next to continue. Paths to Goldfire Application server components 6 Specify the paths to the Goldfire Application server components.

The paths must be the same as the share names that were entered during the Goldfire Application server installation procedure (see

3 Installing the Goldfire Server with a Microsoft User Database Installing an additional Goldfire Indexing server

49

(Optional) Add one or more additional Indexing servers on this computer. on page 25). The default paths are as follows:
Components: < drive >:\Goldfire\ Global Config File: < drive >:\Goldfire\SipDB

To browse for paths where Goldfire Application server components are installed, click Click Next to continue. Changing location of Indexing server components 7 (Optional) Add one or more additional Indexing servers on this computer. , and then select a folder.

To add another Indexing server, click Add. To remove an existing Indexing server, click the name of the Indexing server in the list, and then click Remove.

50

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

(Optional) To modify the paths where the Indexing server components are installed, click the name of an Indexing server in the list, and then click Modify. The following dialog box appears:

Change the default paths of the Temporary Folder, Doc Storage, and Word Index by typing the paths in the editable fields. You can also click network directory. , and then select the folder from the

b c 8

Edit any port numbers you want to change. Click OK to accept your changes and return to setup.

Click Next to continue.

3 Installing the Goldfire Server with a Microsoft User Database Installing an additional Goldfire Indexing server

51

Port numbers

(Optional) Edit any port numbers you want to change.

Click Next to continue. 10 (Optional) Review the list of Goldfire Server components to be installed. To change any installation settings, click Back to return to a previous screen and edit the settings. Note: This will not cause you to lose any information already entered. Begin to install 11 Click Next to begin the installation. You are notified if errors are encountered, and when the installation is complete.

52

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

4
Connecting to document storage systems
You can configure the Goldfire Server to process documents from the following types of document storage and management systems: ODBC-compliant databases Lotus Domino server databases Microsoft SharePoint Portal servers Livelink servers Documentum databases Windchill servers Teamcenter Enterprise servers Teamcenter servers Teamcenter Community Collaboration servers

This chapter describes the requirements and settings for establishing connections to document storage systems. For the complete list of supported document formats that can be indexed on the Goldfire Server, see Appendix D, Supported document formats. This chapter includes the following topics: Topic Connecting to ODBC-compliant databases Connecting to Lotus Domino servers Connecting to Microsoft SharePoint Portal servers Connecting to Livelink servers Connecting to Documentum databases Connecting to Windchill servers Connecting to Teamcenter Enterprise servers See Page 54 58 60 61 61 63 65

54

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Topic Connecting to Teamcenter servers Connecting to Teamcenter Community Collaboration servers Mapping different user directories for document-level security

See Page 70 72 72

Connecting to ODBC-compliant databases


Connecting to one or more ODBC-compliant databases requires that you install and configure the appropriate ODBC drivers on the Goldfire Server machine. Actual connectivity is established when you process documents in specific ODBC-compliant databases in Goldfire Administrator. Ensuring document security End users who have search access to a corporate knowledge base can view results citations from the source documents as well as summaries of the source documents. However, in order to open and view the documents themselves, end users must also have the appropriate permissions to access the source documents. Goldfire administrators can ensure the security of corporate knowledge bases by assigning the appropriate search access rights to each corporate knowledge base. ODBC requirements ODBC processing of database documents through Goldfire Administrator requires the following: The appropriate ODBC driver, supplied by your database vendor, must be installed on the Goldfire Server machine. Microsoft SQL Server and Microsoft Access databases: the ODBC drivers for Microsoft SQL Server and for Microsoft Access are included in the Microsoft Data Access Components (MDAC) package. For download and installation instructions, see http:// www.microsoft.com. If the Goldfire Server is configured to use a Microsoft SQL User database, the Microsoft ODBC drivers are already installed on the server. Oracle databases: before you install the Oracle ODBC driver, the Oracle Client must be installed on the Goldfire Server machine. For details about the Oracle ODBC driver and Oracle Client, see http://www.oracle.com.

4 Connecting to document storage systems Connecting to ODBC-compliant databases

55

If the Goldfire Server is configured to use an Oracle User database, the Oracle Client is already installed on the server. Other databases: see your vendors ODBC documentation for information about how to install and configure other ODBC drivers.

The database must be properly configured with the ODBC driver (according to ODBC documentation). The documents in the database must be stored in one or more tables.

The database tables should include at least three columns, including the following: Specifying the ODBC data source Unique document identifier (document IDs) Document title (displayed in the results citation) Document text fields (full text of the document to be indexed)

To specify the ODBC-compliant database that you want to index, enter the following information in the ODBC Processing page of the Build KB Wizard in Goldfire Administrator: In the ODBC Source text box, type the name of the ODBC data source containing the documents that you want to process. This name must match the name that was specified when the ODBC data source was configured. In the Username and Password text boxes, type the information that is required to access the data source.

For detailed information about using Goldfire Administrator, see the Goldfire Administrator online help. Specifying document processing criteria During ODBC processing, documents are selected based on two SQL queries: The first query retrieves the document IDs.

56

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

For each selected document, the second query retrieves the document title, the document URL, the document body, and (optionally) the modification date of the document.

The following procedure describes how to specify which documents to process, assuming that you have opened the ODBC Processing page of the Build KB Wizard in Goldfire Administrator. For detailed information about using Goldfire Administrator, see the Goldfire Administrator online help. How to specify documents for processing 1 In the DB Query 1 text box, type an SQL query that retrieves the document IDs of the documents that you want to process. For example: SELECT doc_id FROM my_doc_list WHERE doc_date BETWEEN to_date('20-MAY-2007') AND to_date('20-JULY-2007') 2 In the Document ID text box, type the name of the field that contains the document IDs. This helps Goldfire Administrator to parse the first query. For example: doc_id. In the DB Query 2 text box, type an SQL query that retrieves the attributes of the documents that are specified by the selected document IDs. For example: SELECT doc_title, doc_url, doc_body, doc_date FROM my_doc_list WHERE doc_id = %doc_id%

4 Connecting to document storage systems Connecting to ODBC-compliant databases

57

Note that the document ID value in the second query is enclosed within % characters: %doc_id%. The % character is a special Goldfire character, not the SQL % character. Goldfire uses the list of document IDs that were selected by DB Query 1 to provide values for %doc_id% in DB Query 2. 4 In the Title and Document text boxes, type the names of the fields that store this information. This helps Goldfire Administrator to parse the second query. (Optional) In the Modification Date text box, type the name of the field that stores document modification dates. We recommend that you specify to include these dates in the knowledge base. Document modification dates are used during recurrence to determine which documents were updated since they were last processed. If modification dates are not available for the recurrence task, only document CRCs are used to determine whether files were updated since they were last processed. 6 To specify how users will access documents in the ODBC database, do one of the following: Click Generate links to external web server (default). Documents that are stored on the ODBC database are opened through an external web server. In the URL template text box, type the URL template to use for accessing documents from the external web server. The format of the URL template is the following: string<variable> variable is <url> Here is an example: http://<webserver>/publish?url=%<url>% webserver is the name of the server where the ODBC data source is located. url is the name of the URL variable that you specified in step 3. For example: %doc_url%. When users click a link to an ODBC document, the document is downloaded from the external web server, and then the document is opened with the appropriate viewer. Click Use Goldfire Server. When users click a link to an ODBC document, the Goldfire Server connects to the ODBC database and gives users access to documents that are stored there.

(Optional) To test the ODBC queries and settings that you have entered, click Test (recommended). If the test is successful, links to the first 10 documents are returned as test results.

Click the links to view the documents in the appropriate application (for example, Internet Explorer, Adobe Reader, etc.).

58

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Connecting to Lotus Domino servers


This section describes the following: Requirements for connecting the Goldfire Server to one or more Domino servers Ensuring document security Settings for establishing connectivity during Goldfire Server setup Document link generation options Updating the Lotus Notes ID Information required to specify database processing

Actual connectivity is established when you select to process specific Lotus Notes databases in Goldfire Administrator. Two Goldfire Server utilities are available that enable you to do the following: Modify the Lotus Notes ID for authenticating Lotus Notes database access (LNClientPwd.exe) after Goldfire Server setup Map multiple Domino server names to their HTTP names (LNIniEditor.exe)

Ensuring document security

End users who have search access to a corporate knowledge base can view results citations from the source documents as well as summaries of the source documents. However, in order to open and view the documents themselves, end users must also have the appropriate permissions to access the Lotus Notes documents. Goldfire administrators can ensure the security of corporate knowledge bases by assigning the appropriate search access rights to each corporate knowledge base.

Lotus Domino requirements

To establish connectivity between the Goldfire Server and the Domino servers, you must do the following: Before the Goldfire Server setup: Install and configure a Lotus Notes Client version 5.0, 6.0, 6.5, 7.0, or 8.0 on the Goldfire Application server. During the Goldfire Server setup: Select your Lotus Notes Client. Provide the Lotus Notes attributes that specify the active Lotus Notes ID. Specify how to generate links to documents during processing.

Mapping server names

When connecting to multiple Domino servers, you must run the LNIniEditor.exe utility after you install the Goldfire Server, to map each

4 Connecting to document storage systems Connecting to Lotus Domino servers

59

Domino server name to its corresponding HTTP server name. The LNIniEditor.exe utility is located in C:\goldfire_installation_dir\serv by default. Servers that are not mapped use the default HTTP server name, which is specified during the Goldfire Server setup. If any of these Domino servers are reconfigured, you must run the LNIniEditor.exe utility to update the mapping of the Domino server name and the HTTP link prefix. Link type The Link Type, specified during the Goldfire Server setup (see Lotus Domino server settings on page 34 or on page 43), defines whether a URL or a Lotus Notes Client link is used to access documents in a Lotus Notes database from the following: Updating the Lotus Notes ID Goldfire Administrator, when opening a source that is selected for processing Goldfire user client, when opening the document from search results

The Lotus Notes ID can be modified after the Goldfire Server installation as follows: Log in to the Goldfire Application server. Reconfigure the Lotus Notes Client software for a different default ID. Start the Lotus Notes Password Changer utility, and specify a new password at the prompt. The Lotus Notes Password Changer utility (LNClientPwd.exe) is located in C:\goldfire_installation_dir\serv by default.

Information needed to specify database processing

In the Lotus Notes processing screen of Goldfire Administrator, you browse and select one or more Lotus Notes databases to process. In Advanced Lotus Notes Options, you optionally specify the following: Which text fields to process If attachments are included in processing Method for constructing documents titles from the database fields

For detailed information about using Goldfire Administrator, see the Goldfire Administrator online help.

60

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Connecting to Microsoft SharePoint Portal servers


Goldfire Server supports connectivity to the following through an HTTP protocol: One or more Microsoft SharePoint Portal servers One or more Teamcenter Community Collaboration servers

For performance reasons, we recommend that the Goldfire Server be installed on a machine other than the Microsoft SharePoint Portal Server. SharePoint requirements In order to use SharePoint Portal servers for document processing, you must do the following: Have Microsoft SharePoint Portal Server 2007, Microsoft SharePoint Portal Server 2003, or Microsoft SharePoint Portal Server 2001. In the Source Connectivity window of Goldfire Administrator, enter the SharePoint Portal server URL and the corresponding user name and password with access to the documents that you want to process in Goldfire Administrator (Source Connectivity window). If you do not specify a user name and password, the Goldfire Application Service account is used to access the SharePoint Portal server by default. Only one SharePoint Portal server account can be mapped per SharePoint Portal server URL in Goldfire Administrator. Therefore only those documents that are accessible to this account can be processed on that server at any given time. Note: If you are using Microsoft SharePoint Portal Server 2001, you must install Publishing and Knowledge Management Collaboration Data Objects (PKMCDO) on the Goldfire Server machine. These objects provide full access to SPPW document management functionality. Note: If you use Microsoft SharePoint Portal Server 2003 or Microsoft SharePoint Portal Server 2001 to access documents that were created with Microsoft SharePoint Portal Server 2001, you must do the following: Install the client components for Backward-Compatible Document Libraries on the Goldfire Server machine. These components are available on the Microsoft SharePoint Portal Server installation CD. They can also be downloaded from the following web page: http://www.microsoft.com/downloads/ details.aspx?FamilyID=df39e250-f7ae-445a-ac9da80c9035ed6b&displaylang=en Install the optional component for backward-compatible document libraries when you install Microsoft SharePoint

4 Connecting to document storage systems Connecting to Livelink servers

61

Portal Server 2003. See your Microsoft SharePoint 2003 documentation for how to do this. Install Publishing and Knowledge Management Collaboration Data Objects (PKMCDO) on the Goldfire Application server machine.

These client components provide full access to SharePoint Portal Server document management functionality. You can install the client components by running setup from the Microsoft SharePoint Portal Server CD. The client functionality of Microsoft SharePoint Portal Server is automatically included with Office XP. Note: Client components for Backward-Compatible Document Libraries and PKMCDO are not required for access to documents that were processed with Microsoft SharePoint Portal Server 2007 or Microsoft SharePoint Portal Server 2003.

Connecting to Livelink servers


Goldfire Server supports connectivity to one or more Livelink servers through an HTTP protocol. In order to process documents that are stored on Livelink servers, you must use the Source Connectivity window of Goldfire Administrator, enter the Livelink Connection name, the Livelink HTTP Prefix, and the corresponding user name and password with access to the documents that you want to process.

Connecting to Documentum databases


Goldfire Server supports connectivity to one or more Documentum databases through an HTTP protocol. For performance reasons, we recommend that the Goldfire Server be installed on a machine other than the Documentum database. Documentum requirements In order to process Documentum databases, you must do the following: Have Documentum 5.n or higher. Install the Documentum API (Documentum Foundation Classes) on the Goldfire Application server machine. This API provides full access to Documentum document management functionality.

62

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Note: Installing Documentum Desktop on the Goldfire Application server machine is not required; however, Documentum Desktop software can be helpful for verifying Documentum connectivity options. Edit the Goldfire Server configuration file to enable Documentum processing (see Enabling Documentum processing manually on page 62). In the Source Connectivity window of Goldfire Administrator, enter the Documentum accounts and the corresponding user names and passwords (and, optionally, domain names) with access to the documents that you want to process in Goldfire Administrator (Source Connectivity window). If you do not specify a user name and password, the Goldfire Application Service account is used to access the Documentum database by default. Only one Documentum account can be mapped per Documentum URL in Goldfire Administrator. Therefore only those documents that are accessible to this account can be processed in that database at any given time. Note: Only Documentum databases with Documentum Desktop objects are supported. Other Documentum repository database structures are not supported. Support of Documentum Access Control Lists for individual objects is not required. Goldfire administrators can assign access control rights at the knowledge base level. Enabling Documentum processing manually If your Documentum software was not installed and configured before you installed the Goldfire Server, you can enable Documentum processing manually. To enable Documentum processing after the Goldfire Server is installed, you must do the following: Install and configure DFC (Documentum Foundation Classes) on the Goldfire Server. Edit the Defines.xml configuration file on the Goldfire Application server machine to enable Documentum processing.

For information about Documentum hardware and software requirements, and about Documentum installation instructions, see your Documentum documentation. 1 2 Open the Defines.xml file using any text editor. The default location is C:\goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data In the Defines.xml file, locate the following string: <var name = "EnableDocumentumProcessing"><number>0</number></ var> 3 In the variable definition string, replace 0 with 1: <var name = "EnableDocumentumProcessing"><number>1</number></ var>

4 Connecting to document storage systems Connecting to Windchill servers

63

4 5

Save and close the Defines.xml file. Copy this Defines.xml file to the following two locations: C:\goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data C:\goldfire_installation_dir\HTML\IM.GFR.User\App_Data

Restart the following services: GF WorldObjectView service GF DocGenerator service

Connecting to Windchill servers


Goldfire Server supports connectivity to one or more Windchill servers through an HTTP protocol. In order to process documents that are stored on Windchill servers, you must use the Source Connectivity window of Goldfire Administrator, enter the Windchill Connection name, the Windchill Server Base URL, and the corresponding user name and password with access to the documents that you want to process.

Processing large numbers of documents


If you plan to process large numbers of documents that are stored on Windchill servers, we recommend that you make the following modifications to your Windchill server setup. Increase Java Virtual Machine Heap size

For the Tomcat server:


1 2 Open the wttomcat_start.bat file using any text editor. The default location is C:\windchill_installation_dir\tomcat5\bin In the wttomcat_start.bat file, locate the following line: set JAVA_OPTS=-server -Xms64M -Xmx128M -Djava.awt.headless=true -Dwt.context.defaultLocalResourcesOnly=true 3 Change the preceding line to the following: set JAVA_OPTS=-server -Xms1024M -Xmx1024M -XX:NewRatio=2 -Djava.awt.headless=true -Dwt.context.defaultLocalResourcesOnly=true 4 Save and close the wttomcat_start.bat file.

64

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

For the Windchill server:


1 2 Open the wt.properties file using any text editor. The default location is C:\windchill_installation_dir\Windchill_8.0\codebase In the wt.properties file, locate the following line: wt.manager.cmd.MethodServer.java.command=$(wt.java.cmd.quoted) $(wt.manager.cmd.common.java.args) -Djava.protocol.handler.pkgs\=HTTPClient -DHTTPClient.disableKeepAlives\=true -DHTTPClient.dontChunkRequests\=true -Xms64m -Xmx128m $(wt.manager.cmd.MethodServer.platform.java.args) wt.method.MethodServerMain 3 Change the preceding line to the following: wt.manager.cmd.MethodServer.java.command=$(wt.java.cmd.quoted) $(wt.manager.cmd.common.java.args) -Djava.protocol.handler.pkgs\=HTTPClient -DHTTPClient.disableKeepAlives\=true -DHTTPClient.dontChunkRequests\=true -Xms1024m -Xmx1024m $(wt.manager.cmd.MethodServer.platform.java.args) wt.method.MethodServerMain 4 Locate the following line: wt.manager.cmd.ServerManager.java.command=$(wt.java.cmd.quoted) $(wt.manager.cmd.common.java.args) -Xms14m wt.manager.ServerManagerMain 5 Change the preceding line to the following: wt.manager.cmd.ServerManager.java.command=$(wt.java.cmd.quoted) $(wt.manager.cmd.common.java.args) -Xms1024m -Xmx1024m -XX:NewRatio=2 -XX:MaxLiveObjectEvacuationRatio=33 -XX:SurvivorRatio=8 wt.manager.ServerManagerMain 6 Modify default WCTYPE attributes 1 Save and close the wt.properties file. Open the wt.adapter.delegates.properties file using any text editor. The default location is C:\Windchill_installation_dir\Windchill_8.0\codebase In the wt.adapter.delegates.properties file, locate the following line: DefaultAttributes.WCTYPE|wt.doc.WTDocument=name,number, checkoutInfo.state,department,description,docType,domainRef, folderingInfo.cabinet,format,iterationInfo.branchId, iterationInfo.creator,iterationInfo.identifier.iterationId, iterationInfo.latest,iterationInfo.modifier, iterationInfo.state,lock.date,locker.id,lock.note, masterReference,ownership.owner,teamId,lifeCycleAtGate, state.lifeCycleId,state.state,thePersistInfo.createStamp, thePersistInfo.modifyStamp,title, versionInfo.identifier.versionId, versionInfo.identifier.versionLevel

4 Connecting to document storage systems Connecting to Teamcenter Enterprise servers

65

Change the preceding line to the following: DefaultAttributes.WCTYPE|wt.doc.WTDocument=name, thePersistInfo.modifyStamp,number

Save and close the wt.properties file.

Connecting to Teamcenter Enterprise servers


Goldfire Server supports connectivity to the Teamcenter Enterprise environment. In order to process documents that are stored on Teamcenter Enterprise servers, you must use the Source Connectivity window of Goldfire Administrator, enter the Teamcenter Enterprise account name and the corresponding user name and password with access to the document classes that you want to process. Optionally, you can also enter the Teamcenter Enterprise URL. Enabling Teamcenter Enterprise processing manually If your Teamcenter Enterprise software was not installed and configured before you installed the Goldfire Server, you can enable Teamcenter Enterprise processing manually. To enable Teamcenter Enterprise processing after the Goldfire Server is installed, you must do the following: Install and configure the Teamcenter client on the Goldfire Server. Edit the Defines.xml configuration file on the Goldfire Application server machine to enable Teamcenter Enterprise processing.

For information about Teamcenter Enterprise hardware and software requirements, and about Teamcenter Enterprise installation instructions, see your Teamcenter documentation. 1 Stop the following services on the Goldfire Application server: 2 3 GF WorldObjectViewer service GF DocGenerator service

Open the Defines.xml file using any text editor. The default location is C:\goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data In the Defines.xml file, locate the following string: <var name = "EnableTeamcenterEnterpriseProcessing"><number>0 </number></var>

In the variable definition string, replace 0 with 1: <var name = "EnableTeamcenterEnterpriseProcessing"><number>1 </number></var>

5 6

Save and close the Defines.xml file. Copy this Defines.xml file to the following two locations:

66

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

C:\goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data C:\goldfire_installation_dir\HTML\IM.GFR.User\App_Data 7 Locate the following file: <teamcenter_client_installation_dir>\config\pdmsetup.bat Copy the pdmsetup.bat file to: <goldfire_installation_dir>\Serv\TeamcenterEnt.cfg 8 Restart the following services: GF WorldObjectViewer service GF DocGenerator service

About the Teamcenter Enterprise configuration file


The Teamcenter Enterprise file specifies the Teamcenter classes that are displayed in the Teamcenter Enterprise processing window of Goldfire Administrator. The path to the Teamcenter Enterprise configuration file is: <Goldfire installation dir>\Serv\teamcenterent.xml The following classes are supported by default:
Class File Note Fields to process File content Note title Description Data Document number Title Description Part number Description Composition name Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management Examples of web applications that have this class

Document

Part

Composition

Distributor

Distributor ID Distributor name Address Phone E-mail address Web site Contact name Comments

4 Connecting to document storage systems Connecting to Teamcenter Enterprise servers

67

Class Item Report

Fields to process Report name Report title Report description Manufacturer ID Manufacturer name Address Phone E-mail address Web site Contact name Comments Package title Description Paper name Description Part Description Additional part information Reason for request Reason (comments) Recommended manufacturer information Remarks Request for quote ID Request purpose Request description Service name Description Comments Report name Report title Report description Supplier ID Supplier name Address Phone E-mail address Web site Contact name Comments Synopsis Description of problem Proposed Solution (by requestor) Synopsis Description of problem Proposed Solution (by requestor)

Examples of web applications that have this class Product data management Authorized data access Change management Product data management Authorized data access Change management

Manufacturer

Package

Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management

Paper

Part Request

RFQ

Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management Product data management Authorized data access Change management

Service Type

Summary Report Supplier

Change Request

Change management

Change Notice

Change management

68

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Class Problem Report

Fields to process Synopsis Description of problem Sequence of events leading up to the problem Proposed solution (by requestor) Synopsis Rationale for recurring deviation Description of deviation Task name Description of problem Deliverable template name Deliverable template description Criterion template name Criterion template description Criterion template details Initiative request name Description

Examples of web applications that have this class Change management

Deviation Request

Change management

Task Deliverable Template Criterion Template Initiative Request

Change management Program execution

Program execution

Program execution

Format of the Teamcenter Enterprise configuration file


The format of the teamcenterent.xml file is as follows: Parameter classes all_classes Type array of ClassInfo structures ClassInfo structure This structure describes the list of query filter attributes that are common for all classes. Description

The format of the ClassInfo structure is as follows: Parameter id Type string Description identifier of the Teamcenter Enterprise class Examples: File, Note name string display name of the Teamcenter Enterprise class Examples: File, Note

4 Connecting to document storage systems Connecting to Teamcenter Enterprise servers

69

Parameter attributes

Type array of AttributeInfo structures array of AttributeInfo structures

Description list of attributes for the query filter

pr_attributes

list of attributes for processing (can be absent)

The format of the AllClassesInfo structure is as as follows: Parameter attributes Type array of AttributeInfo structures Description list of attributes for the query filter

The format of the AttributeInfo structure is as follows: Parameter id Type string Description identifier of the Teamcenter Enterprise class attribute Examples: CategoryName, DestinationFold name string display name of Teamcenter Enterprise class attribute Examples: Category Name, Team Folder Example of a Teamcenter Enterprise configuration file <wddxPacket version="1.0"> <header></header> <data> <struct> <var name="classes"> <array length="1"> <struct> <var name="id">< string >File</ string ></var> <var name="name"><string>File</string></var> <var name="attributes"> <array length="2"> <struct> <var name="id">< string >CategoryName</ string ></var> <var name="name"><string>Category Name</string></var> </struct> <struct> <var name="id">< string > DestinationFold </ string ></var> <var name="name"><string> Team Folder </string></var> </struct> </array></var> <var name="pr_attributes"> <array length="1"> <struct> <var name="id">< string >Description</ string ></var>

70

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

<var name="name"><string> Description</string></var> </struct> </array></var> </struct> </array> </var> <var name=" all_classes"> <struct> <var name="id">< string >AllClasses</ string ></var> <var name="name"><string>All Classes</string></var> <var name="attributes"> <array length="2"> <struct> <var name="id">< string >CategoryName</ string ></var> <var name="name"><string>Category Name</string></var> </struct> <struct> <var name="id">< string > DestinationFold </ string ></var> <var name="name"><string> Team Folder </string></var> </struct> </array></var> </struct> </var> </struct> </data> </wddxPacket>

Connecting to Teamcenter servers


Goldfire Server supports connectivity to the Teamcenter (including Teamcenter Engineering) environment. In order to process documents that are stored on Teamcenter servers, you must use the Source Connectivity window of Goldfire Administrator, enter the Teamcenter account name and the corresponding user name and password with access to the document classes that you want to process. Optionally, you can also enter the Teamcenter URL. Teamcenter requirements In order to process Teamcenter databases, you must do the following: Have one of the following: Teamcenter 2007.x Teamcenter Engineering 2007.x Teamcenter Engineering 2005 SR1

4 Connecting to document storage systems Connecting to Teamcenter servers

71

Install and configure the File Management System (FMS) component on the Goldfire Application server machine. This FMS component provides full access to Teamcenter document management functionality. For information about the FMS component, see the following PDF, section Installing FMS: http://support.ugs.com/docs/teamcenter/2007/en/ InstallationOnWindowsClients.pdf

Enabling Teamcenter processing manually

If your Teamcenter software was not installed and configured before you installed the Goldfire Server, you can enable Teamcenter processing manually. To enable Teamcenter processing after the Goldfire Server is installed, you must do the following: Install and configure the Teamcenter client on the Goldfire Server. Edit the Defines.xml configuration file on the Goldfire Application server machine to enable Teamcenter processing.

For information about Teamcenter hardware and software requirements, and about Teamcenter installation instructions, see your Teamcenter documentation. 1 Stop the following services on the Goldfire Application server: 2 3 GF WorldObjectViewer service GF DocGenerator service

Open the Defines.xml file using any text editor. The default location is C:\goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data In the Defines.xml file, locate the following string: <var name = "EnableTeamcenterProcessing"><number>0 </number></var>

In the variable definition string, replace 0 with 1: <var name = "EnableTeamcenterProcessing"><number>1 </number></var>

5 6

Save and close the Defines.xml file. Copy this Defines.xml file to the following two locations: C:\goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data C:\goldfire_installation_dir\HTML\IM.GFR.User\App_Data

Restart the following services: GF WorldObjectViewer service GF DocGenerator service

72

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Connecting to Teamcenter Community Collaboration servers


Goldfire Server supports connectivity to the Teamcenter Community Collaboration environment. In order to process documents that are stored on Teamcenter Community Collaboration servers, you must use the SharePoint Servers tab on the Source Connectivity window of Goldfire Administrator. For more information about connecting to Teamcenter Community Collaboration servers, see Connecting to Microsoft SharePoint Portal servers on page 60.

Mapping different user directories for document-level security


Some document storage systems use records in their own user directories, which are different from user records in the directory services that the Goldfire Server uses (Active Directory, NT Domain, and LDAP). For example, the Goldfire Server might use user records from Active Directory, but you need to apply document-level security to documents that are stored on Lotus Domino Servers. Or the Goldfire Server might use user records from an LDAP directory, but you need to apply document-level security to documents that are stored in shared folders on a Windows network or on SharePoint servers.

User-mapping file
Goldfire uses user-mapping files that map users from other user directories to users in the Active Directory, NT Domain, or LDAP user directory that Goldfire uses. The mapping of users in other directories to Goldfire users is done automatically. However, administrators can control the mapping by specifying explicit matches.

4 Connecting to document storage systems Mapping different user directories for document-level security

73

Custom user-mapping file


Goldfire administrators can create a custom mapping file that controls the way Goldfire maps users from different realms. Once this XML mapping file is created, you specify the path to this file in the sip.ini file. For example: [General] . . . UserMappingCustom=

full_path

This XML file must contain an <explicitRules> section, which describes different modes of domain authentication. The following sections describe the syntax to use when you create a customized XML mapping file.

Syntax of explicit rules


The <explicitRules> section comprises a set of <rule> nodes. <rule> nodes have two attributes: Attribute type Value allow deny sid SID of a user that comes from document processing. This SID comprises two parts: Prefix (see next section) SID in processed realm If type=allow, the exact SID value from processing with prefix. If type=deny, the first symbols of SID (for example, UNK means that all SIDs that begin with the UNK prefix will not participate in the matching algorithm. If colons (:) are present in literals, they must be escaped, as follows: Replace : (colon) with ,\ (comma, backslash) Replace , (comma) with ,, (two commas) If the <rule> type is allow, the <rule> node can include a <to> subnode that points to the SID of a user in the Goldfire realm. Description

74

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

About prefixes
Prefixes help to do the following: Determine where to get information about users Separate users from different user directories who have identical SIDs More information Source SharePoint processing, local file processing Name of workstation Local file processing Used only for matching Account name for the SharePoint server (from Source Connectivity) Name of Lotus server where document processing occurs Name of Lotus server where document processing occurs SharePoint processing Lotus Notes processing Lotus Notes processing

Prefix DEF

Prefixed to SIDs from a Windows domain

DEF_LOCAL_ DEF_LDAP

SIDs from a Windows workstation SIDs from an LDAP server that is used by Goldfire SharePoint group IDs

DEF_SP_

DLN_

Real Lotus users and user groups

DLN_META_

Meta-Lotus groups such as default, full administrators, and deny access to users

Example content from a user-mapping file


The following example shows what the content of a custom usermapping file looks like: <?xml version="1.0" encoding="utf-8"?> <userMapping> <explicitRules> <rule type="allow" sid="DLN_CN=vm-ln7-qa111/OU=QA1.1.1/ OU=QA1.1/O=IMBQA1:CN=Ellen Glasgow/OU=QA1.1.1/OU=QA1.1/ O=IMBQA1"> <to>S-1-5-21-1993962763-113007714-1957994488-1312</to> </rule> <rule type="deny" sid="DLN_CN=vm-ln7-qa111/OU=QA1.1.1/ OU=QA1.1/O=IMBQA1:CN=Frank Norris/OU=QA1.2.1/OU=QA1.2/ O=IMBQA1"> </rule>

4 Connecting to document storage systems Mapping different user directories for document-level security

75

</explicitRules> </userMapping>y The following rule: <rule type="allow" sid="DLN_CN=vm-ln7-qa111/OU=QA1.1.1/ OU=QA1.1/O=IMBQA1:CN=Ellen Glasgow/OU=QA1.1.1/OU=QA1.1/ O=IMBQA1"> <to>S-1-5-21-1993962763-113007714-1957994488-1312</to> </rule> means that the user that occurred during Lotus processing of database from server: vm-ln7-qa111/OU=QA1.1.1/OU=QA1.1/O=IMBQA1 whose SID is: CN=Ellen Glasgow/OU=QA1.1.1/OU=QA1.1/O=IMBQA1: corresponds to the Goldfire user whose SID is: S-1-5-21-1993962763-113007714-1957994488-1312 The following rule: <rule type="deny" sid="DLN_CN=vm-ln7-qa111/OU=QA1.1.1/ OU=QA1.1/O=IMBQA1:CN=Frank Norris/OU=QA1.2.1/OU=QA1.2/ O=IMBQA1"> </rule> means that the following user: CN=Frank Norris/OU=QA1.2.1/OU=QA1.2/O=IMBQA1 has no corresponding Goldfire SID.

76

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

5
What to do after you install the Goldfire Server
After you install the Goldfire Server, use Goldfire Administrator to do the following: Run the Diagnostics utility Check time-out settings for your proxy server Define Goldfire administrator accounts Provide end users with Goldfire Server connection settings Create corporate knowledge bases Define user access to corporate knowledge bases (For Goldfire users and Goldfire Insight users only) Define user access to shared folders and custom tasks in the collaboration Repository (If the Goldfire Server was not automatically registered) Register the Goldfire Server

For complete information about working with Goldfire Administrator, see the Goldfire Administrator online help.

Running the Diagnostic utility


To verify that the components of your Goldfire Server configuration are set up and running properly, run Goldfires Diagnostic utility. Click the Diagnostic link at the top of the Goldfire Administrator window to run a sequence of diagnostic tests. The results of these diagnostic tests will indicate any common problems that you might encounter. Diagnostic errors and diagnostic warnings are

78

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

linked to troubleshooting guides that help you to solve the particular problems to which they are linked. For more information about using the Diagnostic utility, see Diagnostics and troubleshooting on page 91.

Setting proxy-server time-out settings


After you install the Goldfire Server, we recommend that you set the internet connection time-out setting for your proxy server to 600 seconds or higher. Shorter time-out periods could result in time-out errors.

Defining Goldfire administrator accounts


After you install the Goldfire Server, use Goldfire Administrator to create Goldfire administrator accounts for Goldfire users (including yourself) who will administer the Goldfire Server for end users. If a Goldfire administrator account is to administer Goldfire end users, that account must also be assigned to a Goldfire license. For information about the default Goldfire administrator account, see Starting Goldfire Administrator on page 141.

Providing connection settings


The Goldfire administrator must provide end users of Goldfire client programs with connection settings for the Goldfire Server. To do this, use the Send e-mail command in Goldfire Administrator to send e-mail to end users.

Automatic sign-on
Goldfire Server automatic sign-on, when enabled, automatically passes Windows credentials to connect end users to the Goldfire Server. With

5 What to do after you install the Goldfire Server Creating corporate knowledge bases

79

automatic sign-on enabled, end users can start Goldfire client programs without being prompted to enter a user name and a password. In order to provide automatic sign-on capabilities for Goldfire end users, you must specify one of the following types of user directory during the Goldfire Server installation: NT Domain Active Directory

For more information, see Specifying the user directory on page 36. In addition, your system must have IIS-based authentication. For more information, see Authentication method on page 27.

Creating corporate knowledge bases


Use Goldfire Administrator to submit document processing tasks. For detailed information, see Goldfire Administrator online help.

Defining user access to corporate knowledge bases


Use Goldfire Administrator to assign search access rights for each corporate knowledge base. Users who do not have access to a knowledge base do not see it in their list of available knowledge bases.

Defining user access to the Repository


Goldfire uses the collaboration Repository on the Goldfire Server to store project files, reports, custom tasks, and analysis models. A designated Goldfire administrator must log in to Goldfire and define access rights for the shared folders and custom tasks lists in the Repository. This user must have a Goldfire administrator account and must also occupy a Goldfire license seat.

80

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Registering the Goldfire Server


After you install the Goldfire Server, it is automatically registered with Invention Machines Goldfire.com server. The first time that you log in to Goldfire Administrator, the Goldfire Server Registration dialog box appears. In the Goldfire Server Registration dialog box, click Import License to import the license file and register the Goldfire Server.

After the Goldfire Server is successfully registered, do one of the following: Assign specific end users to each license Enable self-registration for end users

Registering the Goldfire Server


If for some reason the Goldfire Server could not be registered, you are prompted to try to register it again: 1 2 Click Yes to run the registration procedure again. Choose a server registration method. Do one of the following: Click Automated online registration to automatically register the Goldfire Server online. If automatic registration is unsuccessful, click E-mail or phone registration. Click E-mail or phone registration to register the Goldfire Server manually. Follow the online instructions in the Goldfire Server Registration dialog box. After you click E-mail or phone registration, you must contact Invention Machine customer support and send the Server Information that is shown in the Goldfire Server Registration dialog box. Customer support will then send you a new license file to import. The license file should be stored in a shared folder on the Goldfire Application server machine. 3 Import the new license file.

6
Modifying Goldfire Server configuration settings
This chapter describes how to update Goldfire Server configuration settings. You can make the following changes: Change the user name and the password of the Goldfire Application Service account Change User database settings Add or remove Indexing servers

Modifying the Goldfire Application Service account


You can exit the setup at any time by clicking Cancel. 1 2 3 On the Goldfire server machine, log in to the Goldfire Application Service account. On the Windows Start menu, click Programs Goldfire Server Modify Goldfire Server configuration. On the Welcome screen of the Goldfire Server Setup wizard, click Next to continue.

82

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Click Modify Goldfire Application Service account.

Click Next to continue. 5 Wait while Setup checks for required software components. Click Next to continue. Specify an account name and a password for the Application Service account.

Application Service account name and password

Click Next to continue.

6 Modifying Goldfire Server configuration settings Modifying the User database settings

83

(Optional) Review the list of Goldfire Application Service account settings to be modified. To change any settings, click Back to return to a previous screen and edit the settings. Note: This does not cause you to lose any information that you already entered.

Update settings

Click Next to update the Goldfire Application Service account settings.

Modifying the User database settings


You can exit the setup at any time by clicking Cancel. 1 2 3 4 On the Goldfire server machine, log in to the Goldfire Application Service account. On the Windows Start menu, click Programs Goldfire Server Modify Goldfire Server configuration. On the Welcome screen of the Goldfire Server Setup wizard, click Next to continue. Click Modify User database configuration.

Click Next to continue. 5 Wait while Setup checks for required software components. Click Next to continue.

84

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

The Existing Database screen appears:

Enter the database parameters for your Microsoft SQL Server configuration: a In the Server box, enter the name of the server (up to 64 characters). If you do not see the required server in the list, either the server might be disabled, or there might be problems with the network. Without quitting setup, try to fix the server or network problem. Then return to the Goldfire Server setup, and click Refresh to update the server list. If the server name still does not appear in the list, type the server name in the Server box.

User database server

Authentication type

Specify the account that Goldfire Server setup will use to create a new database or to create database objects in an existing database on the SQL server. This account must have DBA privileges. Click one of the following: Windows Authentication, which uses the current Application Service account to access the SQL server. SQL Server Authentication, which uses an existing SQL server account. You must enter the Login and Password for this account.

User database name

In the Database Name box, we recommend that you keep the default name. If you need to modify the database name (because it must conform to your companys naming conventions, for example), edit the Database Name (up to 64 characters).

6 Modifying Goldfire Server configuration settings Modifying the User database settings

85

Click Next to continue. The User Authentication screen appears:

User Authentication

Specify the account that Goldfire services will use to access the SQL server after the Goldfire Server is installed and running. This account must have at least RESOURCE privileges: Windows Authentication, which will use the current Application Service account to access the SQL server. SQL Server Authentication, which will use an SQL server account. You must enter the Login and Password for this account. If this SQL server account does not yet exist, Goldfire Server setup tries to create it.

Click Next. The Application Service account password screen appears.

86

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Application Service account password

Specify a password for the Application Service account.

(Optional) Review the list of User database settings to be modified. To change any settings, click Back to return to a previous screen and edit the settings. Note: This does not cause you to lose any information that you already entered.

Update settings

10 Click Next to update the User database settings.

Adding or removing Indexing servers


You can exit the setup at any time by clicking Cancel. 1 2 3 On the Goldfire server machine, log in to the Goldfire Application Service account. On the Windows Start menu, click Programs Goldfire Server Modify Goldfire Server configuration. On the Welcome screen of the Goldfire Server Setup wizard, click Next to continue.

6 Modifying Goldfire Server configuration settings Adding or removing Indexing servers

87

Click Add or Remove one or more Indexing servers.

Click Next to continue. 5 6 Wait while Setup checks for required software components. Click Next to continue. (Optional) Add or remove one or more additional Indexing servers on this computer.

To add another Indexing server, click Add. To remove an existing Indexing server, click the name of the Indexing server in the list, and then click Remove.

88

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

To modify the paths where the Indexing server components are installed, click the name of an Indexing server in the list, and then click Modify. The following dialog box appears:

Change the default paths of the Temporary Folder, Doc Storage, and Word Index by typing the paths in the editable fields. You can also click network directory. , and then select the folder from the

b c 7

Edit any port numbers you want to change. Click OK to accept your changes and return to setup.

Click Next to add or remove Indexing servers.

7
Administrative tasks
This chapter includes the following topics: Topic Troubleshooting the Goldfire Server Excluding Goldfire Server files from antivirus protection Using Microsoft Windows NTBackup to back up Goldfire databases Installing and uninstalling the Language Pack Configuring connections to remote Goldfire Servers Modifying the user-authentication method Modifying automatic retrieval of end-user e-mail addresses Optimizing Sun Java for Goldfire Administrator Creating and publishing custom news Setting custom variables Recurrent processing settings Converting nontext files to plain text Specifying the number of CPUs for document processing Moving an Indexing server from one computer to another Uninstalling an Indexing server Disabling SYN attack protection Uninstalling the Goldfire Server See page 90 93 94 97 97 99 102 104 105 108 113 114 118 119 120 122 122

90

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Troubleshooting the Goldfire Server


The Goldfire Server provides three troubleshooting methods: If you are running Goldfire Administrator, click the Diagnostic link at the top of the Goldfire Administrator window to run a sequence of diagnostic tests. These diagnostic tests check to see if the components of your Goldfire Server configuration are set up and running properly. The results of these diagnostic tests will indicate the most common problems that you might encounter. Any diagnostic errors and diagnostic warnings are linked to troubleshooting guides that help you to solve the particular problems to which they are linked. If you cannot run Goldfire Administrator, run the System Information, Logs, and Troubleshooting utility from the Windows taskbar on the machine where the Goldfire Application server is installed. This utility also runs a sequence of diagnostic tests and provides troubleshooting guides to help you solve particular problems. In addition, this utility enables you to gather system information and log files, which you can send to the Invention Machine support team. Automatic Diagnostic. The Goldfire Server has an Automatic Diagnostic feature that can periodically run diagnostic tests on the Goldfire Server. These tests run automatically in the background, and appropriate warning and error messages are displayed to designated Goldfire administrators. In addition, Automatic Diagnostic can be configured to automatically send e-mail messages to Goldfire administrators, and to enter warnings and errors into the Windows Event Log (in the Application folder).

How to troubleshoot the Goldfire Server

Do one of the following: Click Diagnostic at the top of the Goldfire Administrator window. On the Windows taskbar of the machine where the Goldfire Application server is installed, choose Start Programs Goldfire Server System Information, Logs, and Troubleshooting. On the Goldfire Administrator navigation bar, click Options, and then click the Automatic Diagnostic tab. For details, see Goldfire Administrator online help.

How to configure Automatic Diagnostic

7 Administrative tasks Troubleshooting the Goldfire Server

91

Diagnostics and troubleshooting


The Diagnostic link enables you do the following: Run a sequence of diagnostic tests on the Goldfire Server Troubleshoot common problems that are found by the Goldfire Server diagnostic tests

How to run diagnostic tests on the Goldfire Server

Click Diagnostic at the top of the Goldfire Administrator window. When you click Diagnostic, the following diagnostic tests (among others) are done: Is the Goldfire Application Service account valid? If it is not, no other diagnostic tests are performed. Are all Indexing servers available? If not, no other diagnostic tests are performed. Are all Goldfire services available? are they all running? Can DCOM objects run? Is the Goldfire Server connected to the User database?

After the diagnostic tests return results, one or more troubleshooting pages are displayed. Each troubleshooting page describes a particular problem that was discovered by the diagnostic tests, along with recommendations for how to resolve the problem. Follow the on-screen instructions to troubleshoot these problems.

System Information, Logs, and Troubleshooting


Use the System Information, Logs, and Troubleshooting utility when a problem occurs with the Goldfire Server and you need the help of the Invention Machine support team to solve it. The wizard guides you through the steps of gathering the data that is required by Invention Machine support to fully troubleshoot your problem. Use the System Information, Logs, and Troubleshooting utility to do the following: Diagnose the Goldfire Server for possible problems Troubleshoot problems that are found by the Goldfire Server diagnostic tests Gather system information and log files to send to the Invention Machine support team

You must run the System Information, Logs, and Troubleshooting utility on the machine where the Goldfire Application server is installed.

92

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

How to start the utility

Do one of the following: From the Windows taskbar, choose Start Programs Goldfire Server System Information, Logs, and Troubleshooting. In the goldfire_installation_dir\Serv folder, run the executable program GF_SysInfoLog.exe. goldfire_installation_dir is the path to the folder where the Goldfire Server is installed.

Diagnostic tests

Diagnostic tests include the following: Is the Goldfire Application Service account valid? If not, no other diagnostic tests are performed. Are all Indexing servers available? If not, no other diagnostic tests are performed. Are all Goldfire services running? Can DCOM objects run? Is the Goldfire Server connected to the User database?

Troubleshooting

After the diagnostic tests return results, one or more troubleshooting pages are displayed. Each troubleshooting page describes a particular problem that was discovered by the diagnostic tests, along with suggestions as to how to resolve the problem. Follow the on-screen instructions to troubleshoot these problems.

Sending system information to Invention Machine

Goldfire administrators can gather and send system information and log files to the Invention Machine support team for troubleshooting. Data that is gathered as part of system information and logs includes the following: System information Registry and other specific settings Versions of installed products Directory listings Configuration files Log files Data about the Goldfire database

Note: Passwords and other secure information are never included in the data that is sent to Invention Machine support. Running System Info, Logs, and Troubleshooting You can do either of the following: Gather and automatically send system information and log files to Invention Machine support Gather and store system information and log files that you later send manually to Invention Machine support

7 Administrative tasks Excluding Goldfire Server files from antivirus protection

93

System data and log files are compressed and then stored in a temporary folder that the Goldfire administrator specifies.

Excluding Goldfire Server files from antivirus protection


To ensure the best performance and to maintain a high level of stability of the Goldfire Server, you should exclude the following Goldfire Server folders from antivirus real-time protection. All of these folders are located in the Goldfire Server installation directory (for example, C:\Goldfire): On the Application server SipDB folder (exclude this folder nonrecursively) SipDB\Catalog SipDB\Queue SipDB\ReposBin SipDB\KETemp SipDB\Doc Storage SipDB\Queue SipDB\Word Index SipDB\KETemp It might also be necessary to disable antivirus protection for the network folders that are used to export knowledge bases. We recommend that you do periodic antivirus scans of all of the aforementioned folders that you exclude from real-time antivirus protection. How to scan folders 1 2 3 On the Application server and on all Indexing servers, stop all Goldfire services. Run the antivirus scan. Start all Goldfire services.

On each Indexing server

Important: While the Goldfire services are stopped, users will not have access to the Goldfire Server. Also, if you stop the Goldfire services while any active Backup, Import, Export, Index Optimization, or Browsing Data Creation tasks are running, they might fail. We recommend that you stop the Goldfire services only after all of these tasks have finished.

94

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Using Microsoft Windows NTBackup to back up Goldfire databases


Important: To ensure the integrity of the Goldfire databases, we recommend that Goldfire administrators use the Goldfire Server backup and restore utilities to back up and restore their Goldfire databases. However, it is also possible to back up Goldfire using the Microsoft Windows NTBackup program. For information about how to use the Goldfire Server backup and restore utilities, see Goldfire Administrator online help.

Using NTBackup to back up and restore your system


The Goldfire Server supports the Microsoft Windows NTBackup program, with or without the integration of Volume Shadow Copy Services (VSS). Important: When you use NTBackup to back up and restore the Goldfire Server, the following conditions apply: No Goldfire Indexing servers can be indexing any documents during the backup procedure. Goldfire Server cannot be performing any database management tasks during the backup procedure. Before you restore your system from an NTBackup, all Goldfire SipDB folders on your system must be empty.

How to perform a system backup

Use Microsoft Windows NTBackup to back up your system. The Goldfire Server should not be indexing any documents when you back up your system with NTBackup.

Immediately after your system backup is complete, or as soon as possible after you back up your system, back up your User database (MS SQL or Oracle). We recommend that you schedule the backup of your User database at a time when activity on the Goldfire Server is minimal.

Note: If your Goldfire Server is installed on more than one computer (Application server on one computer and one or more Indexing servers on separate computers), you must ensure that the data on all backups from the different computers is properly synchronized. For example, you should not restore one of your Goldfire computers from a backup that was created yesterday,

7 Administrative tasks Using Microsoft Windows NTBackup to back up Goldfire databases

95

and restore another of your Goldfire computers from a backup that was created last week. How to restore from a full system backup 1 2 3 4 5 6 Stop all Goldfire services on the Application server and on all Indexing servers. Make sure that all Goldfire SipDB folders are empty. Restore all computers in your system from your most recent full NTBackups. Restore your User database from your User database backup. Restart all Goldfire services on the Application server and on all Indexing servers. Verify that your databases are properly synchronized. To do this, use the procedures in the section Synchronizing databases. Stop all Goldfire services on the Application server and on all Indexing servers. Make sure that all Goldfire SipDB folders are empty. Restore all computers in your system from your most recent full NTBackup. Restore all computers in your system from all necessary incremental NTBackups. Restore your User database from your User database backup. Add the following parameter to all [WordIndexService. n ] sections of all sip.ini files on all Indexing servers: SystemRestoreRemoveDetachedFiles=1 7 8 9 Restart all Goldfire services on the Application server and on all Indexing servers. Verify that your databases are properly synchronized. To do this, use the procedures in the section Synchronizing databases. Remove the SystemRestoreRemoveDetachedFiles=1 parameter from the [WordIndexService. n ] section of the sip.ini file.

How to restore from incremental system backups

1 2 3 4 5 6

Synchronizing databases
It is sometimes possible that data in a system backup and data in a User database backup are not synchronized. This can happen, for example, if the backup of the User database was performed at some time later, after the system backup was performed. If you restore your system from backups whose databases are not synchronized, Goldfire Server errors can result.

96

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

How to check whether your databases need synchronizing

On the computer where the Goldfire Application server is installed, open the sip.ini file, which is located in the folder <Goldfire_install_directory>\SipDB. In the sip.ini file, find the Backup_synchronization parameter. If you do not find the Backup_synchronization parameter in the sip.ini file, add it to the section [DBClient.1] . For example: [DBClient.1] . . . Backup_synchronization=0

3 4 5 6

Change the value of Backup_synchronization from 0 to 1. Save your changes and close the sip.ini file. Restart the GF DBClient service. Check the rep*.log files (located in the folder <Goldfire_install_directory>\SipDB\log) to see if they contain either of the following errors: Extra DBClient items found Extra ReposBin files found

If there are no errors, your databases are properly synchronized. 7 If you find errors, use the following procedure to synchronize your databases. On the computer where the Goldfire Application server is installed, open the sip.ini file, which is located in the folder <Goldfire_install_directory>\SipDB. In the sip.ini file, find the Backup_synchronization parameter. If you do not find the Backup_synchronization parameter in the sip.ini file, add it to the section [DBClient.1] . For example: [DBClient.1] . . . Backup_synchronization=0 3 4 5 6 Change the value of Backup_synchronization from 0 to 2. Save your changes and close the sip.ini file. Restart the GF DBClient service. To verify that your databases are properly synchronized, check the rep*.log files (located in the folder <Goldfire_install_directory>\SipDB\log) to make sure there are no errors.

How to synchronize your restored databases

7 Administrative tasks Installing and uninstalling the Language Pack

97

Installing and uninstalling the Language Pack


The Language Pack contains semantic engines for languages other than English. Non-English semantic engines enable the Goldfire Server to index documents and web pages that are written in languages other than English. The Goldfire Server Language Pack provides semantic engines for the following languages in addition to English: French German Japanese

The Language Pack can be installed on the Goldfire Server at installation time. If the Language Pack is not installed when the Goldfire Server is installed, you can install it later at any time. You can also uninstall the Language Pack at any time. To install or uninstall the Language Pack, do the following: On the machine where the Goldfire Server is installed, choose Start Programs Goldfire Server Language Pack on the taskbar.

Configuring connections to remote Goldfire Servers


This section describes how to configure your local Goldfire Server to communicate with other, remote Goldfire Servers. For details about how to set up, configure, and enable connections to remote Goldfire Servers in a federated Goldfire Server network, see Goldfire Administrator online help.

About federated Goldfire Servers


Federated Goldfire Servers enable Goldfire end users at different locations (that is, who connect to different Goldfire Servers) to access Goldfire data at all specified locations in one universal environment from a single entry point. Federated Goldfire Servers enable seamless user access to corporate knowledge bases across multiple Goldfire Servers. All existing Goldfire Server installations that are upgraded to Goldfire release 5.2 or later, as well as all new installations of the Goldfire

98

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Server, include this federated capability. No special installation or upgrade steps are required to enable federated Goldfire Servers functionality.

About the federated Goldfire Servers environment


A federated Goldfire Servers environment provides a way to share and access corporate knowledge bases that are located on multiple Goldfire Servers. For queries against corporate knowledge bases, the query can be sent to multiple remote Goldfire Servers. Their responses are merged with the results from the local Goldfire Server and are then presented to end users as a single result set.

Administering a federated Goldfire Servers environment


The Goldfire Server has a new set of parameters that enable administrators to define the following: Whether or not the local Goldfire Server operates in a federated environment What other Goldfire Servers the local Goldfire Server interacts with

Goldfire administrators use the Goldfire Administrator web client program to set and change these parameters. Parameters in a federated Goldfire Servers environment are set and maintained on each Goldfire Server by its own Goldfire administrators. Administrators control what data on remote Goldfire Servers can be requested, as well as what data remote Goldfire Servers can request from the local Goldfire Server. Only administrators with the Manage Federated Goldfire Servers administrative right can manage a federated environment. Security concerns Security concerns about communications in a federated Goldfire Servers environment must be addressed by your companys Information Technology (IT) administrators. Possible solutions that can address security concerns might include HTTPS configuration, private network connections, etc.

7 Administrative tasks Modifying the user-authentication method

99

Controlling end-user access to remote corporate knowledge bases


User access control mechanisms support the access of end users from remote Goldfire Servers to corporate knowledge bases on the local Goldfire Server. Goldfire administrators define user access rules for knowledge bases on the Goldfire Server that they currently administer. To configure user access, administrators must be able to access the domain structure (users and groups) on remote Goldfire Servers.

Modifying the user-authentication method


Several options are available for authenticating user access to Goldfire Server clients. You can manually change the user authentication method after Goldfire Server installation by doing the following: Modify the IIS authentication method options Edit the Defines.xml file, located in goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data Copy the updated Defines.xml file to the following two locations: goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data goldfire_installation_dir\HTML\IM.GFR.User\App_Data

Changing authentication from anonymous to authorized


Using the following procedure, you specify to use authorized instead of anonymous authentication. This enables Goldfire Server automatic sign-on, which automatically passes Windows credentials to connect to the Goldfire Server when end users start their Goldfire user clients, without prompting them to enter a user name and password. 1 2 In the Internet Services Manager, right-click the GF virtual directory, and then select Properties. In the Directory Security tab, under Access and Authentication Control, click Edit.

100

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Clear the Anonymous Access check box, and then select one or more of the Authenticated Access options (see IIS documentation for more information). Close the Internet Services Manager. Open the Defines.xml file with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data by default.

4 5

In Defines.xml, locate the UseIISAuth parameter value, and then change the value from 0 to 1. For example: <var name="UseIISAuth"><number>1</number></var>

Copy this Defines.xml file to the following two locations: C:\goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data C:\goldfire_installation_dir\HTML\IM.GFR.User\App_Data

Open the Web.config file for Goldfire Researcher with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.User by default.

In the Web.config file, locate the authentication mode parameter value, and then change the value to Windows. For example: <authentication mode="Windows">

10 Open the Web.config file for Goldfire with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.Remote by default. 11 In the Web.config file, locate the authentication mode parameter value, and then change the value to Windows. For example: <authentication mode="Windows"> 12 Locate and modify the following Registry key (used by the Goldfire Server Online Update utility): [HKEY_LOCAL_MACHINE\SOFTWARE\Invention Machine Corporation\Goldfire Server\Globals]: IISAuthMode(dword) = <n> n is one of the following: 128+2 128+4 128+4+2 128+16 128+16+2 128+16+4 for Basic IIS for Digest IIS for Digest IIS + Basic IIS for Integrated IIS for Integrated IIS + Basic IIS for Integrated IIS + Digest IIS

7 Administrative tasks Modifying the user-authentication method

101

128+16+4+2

for Integrated IIS + Digest IIS + Basic IIS

Changing authentication from authorized to anonymous


Using this procedure, you specify to use anonymous instead of authorized authentication. This disables Goldfire Server automatic sign-on from automatically passing Windows credentials to connect to the Goldfire Server. Therefore end users are prompted to enter a user name and password when they start their Goldfire user clients. 1 2 3 In the Internet Services Manager, right-click the GF virtual directory, and then select Properties. In the Directory Security tab, under Access and Authentication Control, click Edit. Select the Anonymous Access check box, and then clear all Authenticated Access options (see IIS documentation for more information). Close the Internet Services Manager. Open the Defines.xml file with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.Admin\App_Data by default. 6 In Defines.xml, locate the UseIISAuth parameter value, and then change the value from 1 to 0. For example: <var name="UseIISAuth"><number>0</number></var> 7 Copy this Defines.xml file to the following two locations: C:\goldfire_installation_dir\HTML\IM.GFR.Remote\App_Data C:\goldfire_installation_dir\HTML\IM.GFR.User\App_Data 8 Open the Web.config file for Goldfire Researcher with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.User by default. 9 In the Web.config file, locate the authentication mode parameter value, and then change the value to Forms. For example: <authentication mode="Forms"> 10 Open the Web.config file for Goldfire with any text editor. The file is located in C:\goldfire_installation_dir\HTML\IM.GFR.Remote by default.

4 5

102

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

11 In the Web.config file, locate the authentication mode parameter value, and then change the value to Forms. For example: <authentication mode="Forms"> 12 Locate and modify the following Registry key (used by the Goldfire Server Online Update utility): [HKEY_LOCAL_MACHINE\SOFTWARE\Invention Machine Corporation\Goldfire Server\Globals]: IISAuthMode(dword) = 0

Modifying automatic retrieval of end-user e-mail addresses


The Goldfire Server can be configured to automatically retrieve e-mail addresses for end users during either of the following procedures: Manual account creation in Goldfire Administrator Self-registration

During Goldfire Server setup, this option is specified with the user directory settings (see Specifying the user directory on page 36 or on page 45). How to change e-mail address retrieval The following procedure describes how to specify whether e-mail addresses are automatically retrieved. You specify this by editing the SIP.INI file. The SIP.INI file is located in the SipDB folder of the Goldfire Server installation directory. 1 2 Open the sip.ini file with any text editor. In the sip.ini file, scroll to the WorldObjectsViewer.1 section. This section contains all parameters that specify e-mail address retrieval. Edit the parameter values that correspond to your user directory type (see Specifying the user directory on page 36): 4 5 6 NT Domain or Active Directory (mixed mode) Active Directory (native mode) LDAP

Save and close the sip.ini file. Restart the GF WorldObjectsViewer service to apply the new settings. Run the Registry Editor and open the key: HKEY_LOCAL_MACHINE\Software\Invention Machine Corporation\Goldfire Server\Globals

7 Administrative tasks Modifying automatic retrieval of end-user e-mail addresses

103

Edit the registry parameter values corresponding to your user directory type (see Specifying the user directory on page 36 or on page 45): NT Domain or Active Directory (mixed mode) Active Directory (native mode) LDAP

Parameters for NT Domain and Active Directory

The following parameters apply to both of the following: NT Domain or Active Directory (mixed mode) Active Directory (native mode)

First, edit the sip.ini parameters, and then edit the corresponding registry parameters. Parameter ap_retrieve_email Description and the corresponding registry parameters Enables or disables the automatic retrieval of end-user e-mail addresses. To enable: ap_retrieve_email = 1 To disable: ap_retrieve_email = 0 Then edit the registry parameter values: To enable: "UARetrieveEmail"=dword:00000001 To disable: "UARetrieveEmail"=dword:00000000 ap_use_diff_ account (Only used when ap_retrieve_email = 1) Enables of disables the use of an alternative account for accessing the Active Directory, which is different from the account used to run the Windows NT Services. To enable: ap_use_diff_account = 1 To disable: ap_use_diff_account = 0 Then edit the registry parameter values: To enable: "UAUseDiffAccount"=dword:00000001 To disable: "UAUseDiffAccount"=dword:00000000

104

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Parameter ap_user_loginap_ user_password

Description and the corresponding registry parameters (Only used when ap_use_diff_account = 1) Specifies the Login and Password for the alternate account used to access the Active Directory. ap_user_login = TypeLoginHere ap_user_password = TypePasswordHere Then edit the registry parameter values: "UALogin"=" TypeLoginHere " "UAPassword"=" TypePasswordHere "

Parameters for LDAP

First, edit the sip.ini parameters, and then edit the corresponding registry parameters. Parameter ap_retrieve_emai l Description and the corresponding registry parameters Enables or disables the automatic retrieval of end-user e-mail addresses. To enable: ap_retrieve_email = 1 To disable: ap_retrieve_email = 0 Then edit the registry parameter values: To enable: "UARetrieveEmail"=dword:00000001 To disable: "UARetrieveEmail"=dword:00000000 ap_email_attr (Only used when ap_retrieve_email = 1) The LDAP attribute name that contains user e-mail addresses, entered in SIP.INI as: ap_email_attr = TypeNameHere Then edit the registry parameter value: "UAEmailAttr"=" TypeNameHere "

Optimizing Sun Java for Goldfire Administrator


Sun Java Version 6 is recommended Versions of Sun Java earlier than Version 6 (builds 1.6.n) occasionally cause some programs (such as Goldfire Administrator) to hang. To avoid this problem, we recommend that you upgrade your version of Sun Java to Version 6 (1.6.n).

7 Administrative tasks Creating and publishing custom news

105

If the upgrade to Version 6 of Sun Java does not resolve the problem, we recommend that you delete all temporary files from the Java cache. To do this, open the Java Control Panel, click Settings (under Temporary Internet Files), click Delete Files, select all check boxes in the Delete Temporary Files dialog box, and then click OK. Using the HttpOnly flag Some administrators might want to use the HttpOnly flag for greater security protection. To use the HttpOnly flag, you must be running Version 6 of Sun Java (or later). You must also add the following parameter to the CustomVars.xml file: useOuterLoader=1 For information about the CustomVars.xml file, see Creating and editing the CustomVars.xml files on page 110. Disabling Direct3D in Java applets To improve the performance of Goldfire Administrator, we recommend that you disable Direct3D in Java applets. To do this, set the following variable in the Java Runtime Environment Settings: Dsun.java2d.d3d=false For example:

Creating and publishing custom news


Goldfire administrators can create and publish custom news and notifications for end users of Goldfire and of Goldfire Researcher.

106

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

First, you create custom news items and a custom news header by creating and then editing two CustomNews.xml files. To make your custom news items visible or invisible to end users, you enable or disable custom news in the CustomNews.xml files. CustomNews.x ml files You create the CustomNews.xml files in the following two locations: C:\ goldfire_installation_dir \HTML\IM.GFR.Remote\App_Data C:\ goldfire_installation_dir \HTML\IM.GFR.User\App_Data The first location is used to publish news in Goldfire. The second location is used to publish news in Goldfire Researcher. Editing the CustomNews.x ml files Use WDDX syntax to edit the CustomNews.xml files. Custom news items have the following parts: Date, in the format mm/dd/yy Title, which can be up to 256 characters long Body, which can be up to 4096 characters long Status, which is either Current or Archived. End users see only news with Current status.

If your custom news contains non-ASCII characters, specify the type of xml encoding in the header of the CustomNews.xml file. The xml encoding should correspond to the encoding that was used when the xml file was saved. For example, if the xml file contains Japanese characters, and the xml file was saved using Shift_JIS encoding, the CustomNews.xml file should begin with the following: <?xml version="1.0" encoding="Shift_JIS"?> <wddxPacket version="1.0"> CustomNews.x ml template The following is a template that illustrates the syntax to use for editing the CustomNews.xml files: <wddxPacket version="1.0"> <header></header> <data> <struct> <var name="Enable_Custom_News"><string> enable_or_disable </string></var> <var name="Custom_News_Title"><string> news_header </ string></var> <var name="Custom_News"> <array length=" number_of_news_items "> <struct> <var name="Date"><string> mm/dd/yy </string></var> <var name="Title"><string> news _ item_title </string></var> <var name="Body"><string> news_item_body </string></var> <var name="Status"><string> status </string></var>

7 Administrative tasks Creating and publishing custom news

107

</struct> . . . </array> </var> </struct> </data> </wddxPacket> Substitute your own values for the italicized elements, as follows: enable_or_disable: either 0 to disable custom news, or 1 to enable custom news. news_header: a title for the custom news section. It is a string of up to 40 characters. For example: Department News number_of_news_items: the number of news items in the file. The number must be greater than or equal to 1. mm/dd/yy a date for the news in month/day/year format. For example: 02/15/05 news_item_title a title for the news item. It is a string of up to 256 characters. For example: New oil for jet engine news_item_body the content of the news item. It is a string with plain text or encoded HTML. The string can be up to 4096 characters. The string can also be empty. For example: New oil for jet engine has been produced by our partner. status the status of the news item. Status can be 1 for Current or 0 for Archived.

Available HTML Tags

Only the HTML Tags in the following table can be used in the CustomNews.xml files: HTML Tag <p> </p> <br> <hr> <h1> </h1> <h2> </h2> <h3> </h3> <h4> </h4> <h5> </h5> <h6> </h6> <b> </b> <i> </i> How to use it <p>Text Text Text </p> Text Text Text <br> Text Text Text Text Text Text <hr> Text Text Text <h1>Text Text Text </h1> <h2>Text Text Text</h2> <h3>Text Text Text</h3> <h4>Text Text Text</h4> <h5>Text Text Text</h5> <h6>Text Text Text</h6> <b>Text Text Text</b> <i>Text Text Text</i>

108

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

HTML Tag <big> </big> <small> </small> <font color=color> </font>

How to use it Bid <big>Text Text Text</big> text <small>text</small> Text <font color=blue> text now</font> text* Supported colors: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, yellow or white <center>Text Text Text</center> Some text: <ul> <li>Text</li> <li>Text</li> </ul>

<center> </center> <ul> </ul>

<ol> </ol>

Some Text: <ol> <li>Some Text1</li> <li>Some Text2</li> </ol>

<img> <a href> </a>

<img src="http://www.yourdomain.com/ images/ yourpicture.jpg"> <a href="http://www.inventionmachine.com> Invention Machine</a>

Setting custom variables


The CustomVars.xml files are Goldfire Server configuration files. You can change variables in these files to do the following: Tune the number of search results that end users can view in Goldfire Researcher and in Goldfire Customize the text that appears at the beginning and at the end of Goldfire reports (for Goldfire Researcher only)

This section contains the following topics: Topic Tuning the number of viewable search results Customizing text at the beginning and at the end of reports Creating and editing the CustomVars.xml files See Page 109 109 110

7 Administrative tasks Setting custom variables

109

Tuning the number of viewable search results


Goldfire administrators can tune how many search results appear in the results page of Goldfire and of Goldfire Researcher. You can set a maximum limit of from 200 results through 1,000 results for the following knowledge bases: Corporate knowledge bases Personal knowledge bases Patents & Articles

To tune the maximum number of viewable search results, you set the value of the SIP_SEARCH_RESULT_DISPLAY_LIMIT variable in the CustomVars.xml files. After you set the SIP_SEARCH_RESULT_DISPLAY_LIMIT variable, you must restart Goldfire to see the change. For information about editing the CustomVars.xml files, see Creating and editing the CustomVars.xml files on page 110. The SIP_SEARCH_RESULT_DISPLAY_LIMIT variable is located in the Search Parameters structure of the CustomVars.xml files. Example Here is an example that sets the maximum number of viewable results to 400: <var name="Search Parameters"> <struct> . . . <var name="SIP_SEARCH_RESULT_DISPLAY_LIMIT"> <number>400</number> </var> . . . </struct> </var>

Customizing text at the beginning and at the end of reports


Goldfire administrators can customize the text that appears at the beginning and at the end of every report generated by end users of Goldfire Researcher.

110

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

To customize text at the beginning and at the end of reports, you edit two variables in the CustomVars.xml files: BEGIN_REPORT_STRING variable END_REPORT_STRING variable

For information about editing the CustomVars.xml files, see Creating and editing the CustomVars.xml files on page 110. The BEGIN_REPORT_STRING and END_REPORT_STRING variables are located in the Report structure of the CustomVars.xml files. The string value for each variable can be up to 512 characters long. The BEGIN_REPORT_STRING and END_REPORT_STRING variables are optional. If they are not set, the strings are treated as empty values. Example Here is an example that sets the beginning text to Department 1 Report and the ending text to Department 1 Report End of report. <var name="Report"> <struct> <var name="BEGIN_REPORT_STRING"> <string>Department 1 Report</string> </var> <var name="END_REPORT_STRING"> <string>Department 1 Report - End of report</string> </var> </struct> </var>

Creating and editing the CustomVars.xml files


Location To edit the CustomVars.xml files, you must first create the file in the following location: C:\ goldfire_installation_dir \HTML\IM.GFR.User\App_Data\Cus tomVars.xml After you save your changes to the CustomVars.xml file, copy it to the following location: C:\ goldfire_installation_dir \HTML\IM.GFR.Remote\App_Data The CustomVars.xml files are optional files. They are not required by the Goldfire Server.

7 Administrative tasks Setting custom variables

111

Example

Here is a sample CustomVars.xml file:

<wddxPacket version="1.0"> <header></header> <data> <struct> <var name="NatLangQuery"> <struct> <var name="Example"> <string> how to reduce cholesterol?</string> </var> </struct> </var> <var name="SIP_SEARCH_RESULT_DISPLAY_LIMIT"> <number>400</number> </var> <var name="MaxCompanyNewsCount"> <number>5</number> </var> <var name="Report"> <struct> <var name="BEGIN_REPORT_STRING"> <string>Department 1 Report</string> </var> <var name="END_REPORT_STRING"> <string>Department 1 Report - End of report</string> </var> </struct> </var> </struct> </data> </wddxPacket> Available HTML Tags You can use HTML tags in the CustomVars.xml files. Only the HTML Tags in the following table can be used: HTML Tag <p> </p> <br> <hr> <h1> </h1> <h2> </h2> <h3> </h3> <h4> </h4> <h5> </h5> <h6> </h6> <b> </b> How to use it <p>Text Text Text </p> Text Text Text <br> Text Text Text Text Text Text <hr> Text Text Text <h1>Text Text Text </h1> <h2>Text Text Text</h2> <h3>Text Text Text</h3> <h4>Text Text Text</h4> <h5>Text Text Text</h5> <h6>Text Text Text</h6> <b>Text Text Text</b>

112

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

HTML Tag <i> </i> <big> </big> <small> </small> <font color=color> </font>

How to use it <i>Text Text Text</i> Bid <big>Text Text Text</big> text <small>text</small> Text <font color=blue> text now</font> text* Supported colors: aqua, black, blue, fuchsia, gray, green, lime, maroon, navy, olive, purple, red, silver, teal, yellow or white <center>Text Text Text</center> Some text: <ul> <li>Text</li> <li>Text</li> </ul>

<center> </center> <ul> </ul>

<ol> </ol>

Some Text: <ol> <li>Some Text1</li> <li>Some Text2</li> </ol>

<img>

<img src="http://www.yourdomain.com/ images/ yourpicture.jpg"> <a href="http://www.inventionmachine.com> Invention Machine</a>

<a href> </a>

Example

Here is an example of how an HTML fragment looks in an XML editor and how the same fragment looks when it is encoded in the XML file. The fragment is a value of the variable Body: How it looks in an XML Editor: <var name="Body"> <string><p>Body 1</p> <br> <b>C</b>ontent</string></var> How it looks in the XML file: <var name="Body"> <string>&lt;p&gt;Body 1&lt;/p&gt; &lt;br&gt; &lt;b&gt;C&lt;/b&gt;ontent</string></var>

7 Administrative tasks Recurrent processing settings

113

Recurrent processing settings


For local document processing, Goldfire administrators can specify how the Goldfire Server checks existing documents to determine if they have been updated. The following two types of verification are possible: Verifying the document CRC (default) Verifying the documents modification date

When Goldfire Server verifies a documents modification date, it does not open the document nor does it read the documents content if the following conditions apply: The document was indexed with the same processing options The documents modification date has not changed since the last time it was processed

Editing the Use_CRC variable

To determine which method Goldfire Server should use to verify existing local documents, you must perform both of the following tasks: Edit the Use_CRC variable, which is in the [General] section of the sip.ini file. The sip.ini file is located in the <goldfire_installation_dir>\SipDB folder. Edit the Use_CRC variable in the following branch of the registry: HKEY_LOCAL_MACHINE\SOFTWARE\Invention Machine Corporation\Goldfire Server\Globals In both places, you can set the following values for the Use_CRC variable: 1 Verify a documents CRC 0 Verify a documents modification date

Recurrence behavior

The following behavior occurs, depending on which Use_CRC value you set: Value 1 Behavior CRC: Goldfire Server calculates the documents CRC to determine if it is necessary to update the document in the indexing database. All new or modified documents are indexed, and the content associated with all deleted documents is removed from the knowledge base.

114

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Value 2

Behavior Modification date: Goldfire Server checks the documents modification date. If the document exists in the database and the modification date matches the date stored in the index, the document is kept in the index without changes. All new or modified documents are indexed, and the content associated with all deleted documents is removed from the knowledge base.

Converting nontext files to plain text


The Goldfire Server can integrate third-party software that converts nontext files (such as video files, audio files, and image files) to plain text. Third-party text conversion tools can be called from a new Goldfire configuration file, enabling Goldfire to integrate the converted text into Goldfire and then semantically index it. Goldfire uses an optional configuration file, called CustomConverter.ini, to specify how the semantic engine can use third-party converters for the indexing of audio files, video files, and image files (including PDF files that contain images instead of text). The third-party converters must be installed on the Goldfire Application server as well as on all Goldfire Indexing servers. The CustomConverter.ini file must be installed in the Serv folder on the Goldfire Application server (<goldfire_install_dir>\Serv) as well as on all Goldfire Indexing servers. The CustomConverter.ini file includes the following two sections: [parameters] [converters]

The [converters] section contains one or more entries, one or more for each custom converter. For example, if ConvertersCount=2, there will be two entries for two custom converters. Fields of the first entry will have the suffix 0 (CommandLine0, FileTypes0, etc.), fields of the second entry will have the suffix 1 (CommandLine1, FileTypes1, etc.).

Common fields
ConvertersCount. This required field is located in the section [converters]. It specifies the total number of custom converters.

7 Administrative tasks Converting nontext files to plain text

115

XPDF_PlainTextThreshold. This optional field is located in the section [parameters]. Value can be a positive integer or 0 (the default value). If this parameter is set to a positive integer, it specifies the minimal size, in bytes, of a text file that is created by the Goldfire converter from a PDF file. XPDF_PlainTextThreshold is used to recognize a case where the internal Goldfire converter produces, from the PDF input file, an output file that is too small (perhaps because the PDF contains only images). In such a case, a custom converter for the PDF should be used. See Case 2 in the section Converting PDF files on page 116.

TempDirectory. This optional field is located in the section [parameters]. Use this parameter to specify the name of the folder where intermediate conversion results are to be temporarily stored. If you do not specify a value, the system temporary folder will be used.

Required fields for each entry


Each custom converter entry in the CustomConverter.ini file must include the following fields: CommandLine n . This field specifies a command line that will be called. This command line must have two parameters: Input file name Output file name For example: convert.exe [/<opt1> /<opt2> . . .] %in-file% %out-file% convert2.bat [/<opt1> /<opt2> . . .] <%in-file%>%out-file% FileTypes n . This field specifies a list of one or more file types that must be processed by the custom converter. Values for this field can be one or more file extensions (including the initial dot), UNRECOGNIZED (which represents all file formats that are not recognized by the Goldfire converters), and ALL (which represents all files). For example: .jpg .tiff .bmp . . . UNRECOGNIZED ALL

116

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Optional Fields for each entry


Each custom converter entry in the CustomConverter.ini file can also include any of the following optional fields: ResultCode_OK n . This field specifies the return code that indicates that the conversion was successful. The default value is 0. UseRecognizedFileTypeAsIntermediateExtension n . If this parameter is specified, and if the system recognizes the file type of the file to be converted, and if the file extension is .tmpa copy of the file, with the extension of the recognized file type, is created in the KETemp folder. ExtensionForUnrecognizedFileTypes n . If this parameter is specified, and if the system does not recognize the file type of the file to be converted, and if the file extension is .tmpa copy of the file, with the extension specified by this parameter, is created in the KETemp folder. ConvertOutputAgain n . Use this parameter to specify that the output file that is produced by the converter must be converted by the Goldfire converters. The default is: do not convert again. The value of ConvertOutputAgain can be 0 only if the custom converter produces a unicode text file. UseForError n . Use this parameter to specify the error code that the converter should handle. The value is a hexadecimal value (for example, UseForError2 = 0x80070005). Note that if you use 0 as a value, you should prefix it with 0x (for example, 0x0).

Converting PDF files


Converting PDF files is more complex than converting other, non-PDF files. You can specify several entries for PDF custom converters in order to handle different situations. The logical flow for converting PDFs might be as follows: Case 1 handles conversions of PDFs when the internal Goldfire converter (1) produces no errors and (2) produces an output file whose size is not less than the value of XPDF_PlainTextThreshold. In such cases, the output file of the internal converter is the final resulting output file. Case 2 handles conversions of PDFs when the internal Goldfire converter (1) produces no errors and (2) produces an output file whose size is less than the value of XPDF_PlainTextThreshold. In such cases, the conversion uses the first custom PDF converter in the CustomConverter.ini file (that is, the one with the lowest index). In the example in the next section, this would be CommandLine3.

7 Administrative tasks Converting nontext files to plain text

117

Case 3 handles conversions of PDFs that produce errors. In such cases, the conversion searches for a UseForError value that is equal to the error code that occured. If such a custom PDF converter is found, it is used; if the error code does not match any UseForError value, the conversion uses the first custom PDF converter in the CustomConverter.ini file. For example, if access to a PDF is denied, the error code will be 0x80070005. In the example in the next section, the case would be handled by CommandLine4.

Example of a CustomConverter.ini File


[parameters] TempDirectory = C:\TEMP XPDF_PlainTextThreshold = 1024 [converters] ConvertersCount = 5 CommandLine0 = C:\Converters\ConvJPG.bat "%in_file%" "%out_file%" FileTypes0 = .jpg,.tiff ConvertOutputAgain0 = 1 CommandLine1 = C:\Converters\ConvWAV.bat "%in_file%" "%out_file%" FileTypes1 = .wav ConvertOutputAgain1 = 1 CommandLine2 = C:\Converters\ConvMP3.bat "%in_file%" "%out_file%" FileTypes2 = .mp3 ConvertOutputAgain2 = 1 CommandLine3 = C:\pdfocrjb2\pdfocrjb2.exe ocr 1 bwimg 2 ocrtxt %out-file% nopdf %in_file% LOCKED2.pdf log c:\temp\pdflog.txt ConvertOutputAgain0=1 FileTypes0 = .pdf CommandLine4 = C:\Program Files\gs\gs8.71\bin\gswin32c.exe dBATCH dNOPAUSE sDEVICE=pdfwrite dVERBOSE sOutputFile=%out_file% %in_file% ConvertOutputAgain2=1 FileTypes2 = .pdf UseForError2 = 0x80070005 Note: There are several different entries for PDF files (in the example, CommandLine3 and CommandLine4). They need not be gathered

118

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

into one single contiguous group. For example, you might have CommandLine2 with a PDF converter; then CommandLine3 with a non-PDF converter; then CommandLine4 with another PDF converter.

Specifying the number of CPUs for document processing


The Goldfire Servers GF DocProcessor service supports parallel document indexing, which enables multiprocessor server machines to take full advantage of all available CPU power. When the Goldfire Server starts up, the GF DocProcessor service determines how many CPUs are currently installed on the system, and then runs that number of parallel processes. Goldfire administrators can change the number of parallel processes that GF DocProcessor uses. For example, administrators might want to use only two parallel processes on a server with four available CPUs. GFDocProc_ Outproc parameter To set the number of CPUs to use for parallel document processing, edit the GFDocProc_Outproc parameter in the following branch of the registry: [HKEY_LOCAL_MACHINE\SOFTWARE\Invention Machine Corporation\Goldfire Server] The following example specifies that the GF DocProcessor service uses two parallel processes: "GFDocProc_Outproc"=dword:00000002 The value of the GFDocProc_Outproc parameter can be any integer from 1 through 10. After you modify the GFDocProc_Outproc parameter, you must restart the GF DocProcessor service in order for your change to take effect.

Number of simultaneous connections to the KETemp folder


For a Goldfire configuration that uses multiple servers, the number of allowed simultaneous connections to the KETemp folder must not be less than the total number of CPUs on all Indexing servers. If you change the GFDocProc_Outproc parameter on one or more Indexing servers, you should adjust the number of simultaneous

7 Administrative tasks Moving an Indexing server from one computer to another

119

connections to the values of the GFDocProc_Outproc parameters on all Indexing servers. If you change the number of CPUs for document processing on one or more Indexing servers, you should adjust the number of simultaneous connections to the KETemp folder. This number should be: Not less than the total number of CPUs on all Indexing servers where the GFDocProc_Outproc parameter is not specified, plus The sum of all GFDocProc_Outproc parameter values on all Indexing servers where the GFDocProc_Outproc parameter is specified

Moving an Indexing server from one computer to another


When you move an Indexing server from one computer (the source) to another computer (the destination), you do the following: First, uninstall the Indexing server from the source computer. Next, move the index data from the source computer to the destination computer. Finally, install the Indexing server on the destination computer.

Important: The destination computer must have a hard disk partition with the same name as the source computer. How to move an Indexing server 1 (Optional) Perform a full backup of the Goldfire Server. This might not be possible if the Indexing server is damaged or unavailable. 2 3 On the Application server, stop the GF Catalog service. On the Windows taskbar of the source computer, click Start Programs Goldfire Server Uninstall Goldfire Server. Wait until the Goldfire Indexing server software has been completely removed from the source computer. 4 Move the indexing data, which is stored in the < Goldfire install dir >\SipDB folder, from the source computer to the same location on the destination computer. For example, move \\source\d \< Goldfire install dir >\SipDB to \\destination\d \< Goldfire install dir >\SipDB. 5 On the destination computer, install the Indexing server over the moved SipDB folder.

120

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Continuing the example from Step 4, you would install the Indexing server at d:\< Goldfire install dir >. 6 On the Application server, start the GF Catalog service.

Uninstalling an Indexing server


When you uninstall an Indexing server from a Goldfire Server configuration, you do the following: Uninstall the Indexing server from the computer where it is located. Remove the Catalog database from the Application server. Remove all DocGenerator queue files from the Application server and from all remaining Indexing servers.

You can uninstall an Indexing server in two ways: Run the uninstall wizard Manually uninstall an Indexing server

The following sections describe how to perform each of these tasks.

Using the uninstall wizard


How to uninstall 1 2 Perform a full backup of the Goldfire Server. On the Windows taskbar of the Indexing server, click Start Programs Goldfire Server Uninstall Goldfire Server. Wait until the Goldfire Indexing server software has been completely removed from the Indexing server machine. 3 4 On the Application server and on all remaining Indexing servers, stop all Goldfire services. On the Application server, remove the Catalog database. The Catalog database is located at the following folder: < Goldfire install dir >\SipDB\Catalog 5 On the Application server and on all Indexing servers, remove the DocGenerator queue files. The queue files are located in the following folder: < Goldfire install dir >\SipDB\Queue 6 7 On the Application server and on all Indexing servers, start all Goldfire services. Restore the system from the full backup that you made at Step 1.

7 Administrative tasks Uninstalling an Indexing server

121

Note: After you restore the system, all Indexing servers are active. To freeze any Indexing servers, use Goldfire Administrator.

Manually uninstalling an Indexing server


If for some reason you are unable to uninstall an Indexing server using the procedure that is described in Using the uninstall wizard", use the following procedure to uninstall the Indexing server manually. 1 2 3 Perform a full backup of the Goldfire Server. On the Application server, stop all Goldfire services. On the computer with the Indexing server that you want to uninstall, open the sip.ini file, whose path is < Goldfire install dir >\SipDB\sip.ini. In the [General] section of the sip.ini file, find the NodeID of the Indexing server. 4 On the Application server, open the sip.ini file and remove the section that corresponds to the NodeID that you found in Step 3. For example, if NodeID is 3, you would remove the section that looks like this: [Node.3] Host=XP64-NEW-1 NodeVersion=4.60.5612.0 NodeIdentifier=3 DPPort=14132 DSPort=14133 WIPort=14134 KETemp=\\XP64-NEW-1\GFTemp 5 In the sip.ini file on the Application server, find all of the NodeIdentifier settings (for example, NodeIdentifier=1, NodeIdentifier=2, etc.), and determine which is the highest NodeIdentifier number. In the sip.ini file, set MaxNodeID to the highest NodeIdentifier number. 6 7 In the [General] section of the sip.ini file on the Application server, change the NodeCount to NodeCount 1 . In the [OnlineUpdate.1] section of the sip.ini file on the Application server, remove the Node and Type lines for the Indexing server that you are uninstalling. For example: Node3=SIP-IN-4 Type3=4

122

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

On the computer where the uninstalled Indexing server was located, disable all Goldfire services. This prevents unexpected network requests to the Application server from this computer.

On the Application server, start all Goldfire services.

10 Restore the system from the full backup that you made at Step 1. Note: After you restore the system, all Indexing servers are active. To freeze any Indexing servers, use Goldfire Administrator.

Disabling SYN attack protection


If your company plans to install 10 or more Indexing servers, you must disable SYN attack protection on the Application server machine in order to prevent the Goldfire Server from forcibly closing connections from a large number of clients. You disable SYN attack protection by adding a key to the registry. To disable SYN attack protection 1 2 On the Application server machine, click Start Run, and then type regedit in the Open box. In the Registry Editor, locate the following key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\Tcpip \Parameters\ 3 Add the following key to the list of parameters: Type: DWORD Name: SynAttackProtect Value: 0

Uninstalling the Goldfire Server


Uninstalling Goldfire Server removes the software from the computer. Uninstalling does not remove any user data from the computer. How to uninstall To uninstall the Goldfire Server, run the uninstall wizard by choosing Start Program Files Goldfire Server Uninstall Goldfire Server from the Windows taskbar, and follow the on-screen instructions. You must uninstall on the Application server and on all Indexing servers.

8
Online update of the Goldfire Server
Goldfire Server online updates are available to customers who have purchased a maintenance plan. This chapter describes how to do the following: Configure your online update service Perform the Goldfire Server online update

Note: If your Goldfire Server is earlier than version 4.1, you must perform a new Goldfire Server installation. Who can perform an online update? Customers who have purchased a maintenance plan are eligible to download and install Goldfire online updates. For information about obtaining a maintenance contract, please contact support@inventionmachine.com. This section includes the following topics: Topic Configuring the online update Performing an online update See Page 123 129

Configuring the online update


We recommend that you configure the GF Online Update Downloader Service immediately after you install the Goldfire Server. This section describes why you need to configure the GF Online Update Downloader Service. It also describes the configuration settings.

124

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Why configure the Online Update Service?

You must configure the Online Update Service to do the following: Schedule how frequently to check the availability of updates Specify connection settings and e-mail notification settings

When the Online Update Service detects that a newer version of the Goldfire Server is available, an e-mail notification is sent. The notification is sent to the e-mail address that is specified in the E-mail tab of the GF Online Update Downloader Service settings (see e-mail Settings on page 126). If you do not enable e-mail notification for online update availability, you can check for online updates manually from the General tab of the Online Update Service Settings dialog box (see General Settings on page 126). How to configure the Online Update Service To open the Online Update Service Settings dialog box, choose Start Programs Goldfire Server Configure Online Update Service on the Goldfire Application server. The dialog box includes the following tabs: Service Settings: Enables you to start and stop the Online Update service, as well as to modify the account that is used to run this service. For more information, see Service Settings on page 125. General Settings: Enables you to schedule periodic update checks, as well as to manually initiate a check or download files. For more information, see General Settings on page 126. If you do not enable automatic downloads, you must download manually from this dialog box before you perform an update. E-mail Settings: Specify connection to the e-mail server and the e-mail address for receiving notifications regarding update availability and download status. For more information, see e-mail Settings on page 126. Log: Enables or disables the creation of a log file that describes the various online update events. For more information, see Log Settings on page 128.

8 Online update of the Goldfire Server Configuring the online update

125

Service Settings

The Service Settings tab enables you to change the status of the service:

The Start and Stop buttons change the status of the service. The Service Status message appears whether the Online Update Service is currently stopped or running. When the Online Update service is stopped, you can change the account that is used for running this service by clicking Modify Account. The default account for all Goldfire services is specified during Goldfire Server setup.

126

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

General Settings

The General tab enables you to schedule update availability checks, as well to manually initiate a check or to download files:

To initiate a manual check at any time, click Check Now. Under Information, a message appears regarding the availability of updates. To schedule a check, enter the following information under Scheduling: Check time: Entered as hh:mm (for example, 1:00 AM). The time at which the GF Online Update Downloader service checks for update availability. Check every: Entered as the number of days between successive checks. Download Update, if available: This command downloads the update files to a temporary folder. Update files are stored in the temp folder at the location specified during installation. Sends an e-mail notification to the specified address regarding the outcome of the download. Check Update availability only: This command checks for update availability but does not download the files. Sends an e-mail notification to the specified address regarding the availability of updates.

To download files when a download is available, click Download. The new files are stored in the temp folder at the location specified during installation. The Information section displays a message after the files are downloaded successfully. e-mail Settings The E-mail tab enables you to specify the connection and the address of the notification message that is sent in the event of a successful update

8 Online update of the Goldfire Server Configuring the online update

127

download, update availability, or any errors encountered during the download:

SMTP Server specifies the name of the e-mail server. Port defines the mail server port (25 by default). From specifies the origin e-mail address. To defines the e-mail address where a notification about an existing online update will be sent. In addition, any errors that are encountered during the update are sent to this address. Subject contains the e-mail subject, which is Goldfire Update Notification by default.

128

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

To edit the default body text of the e-mail messages, click More. This opens the Mail Messages dialog box, where you can edit the text boxes.

To send a test e-mail to the specified address, click Test. Log Settings In the Log tab, you change the Online Update log file settings:

We recommend that you enable the log file so that you can diagnose any errors that are encountered during the online update process.

8 Online update of the Goldfire Server Performing an online update

129

The log files tracks connection information as well as the specific files downloaded. Log files are named automatically at the time of creation. The log file name includes a date/time stamp, made up of the year, month, date, hour, minute, and second. You can limit the size of the log file by entering the number of bytes in the Max. file size box. To view the most recent log file, click View Log.

Performing an online update


This section describes how to perform an online update with the Perform Update utility after the appropriate files have been downloaded. Who can perform an online update? Customers who have purchased a maintenance plan are eligible to download and install Goldfire online updates. For information about obtaining a maintenance contract, please contact support@inventionmachine.com. If automatic download is enabled When the Online Update Service is configured to download files automatically, files are copied to the temporary folder. After these files are downloaded, you can install the update by running the Perform Update utility (OUPerformer.exe). To view the log at any time, click View Log. For more information about configuring the online update log, see Log Settings on page 128. If automatic download is disabled When an online update is available but you have not enabled automatic downloading, you must manually download the files before performing the update, as described in General Settings on page 126. Once the files are successfully downloaded, you can perform the update. Goldfire Server Online Update temporarily stops Microsoft Internet Information Server and Goldfire Server services during the update or rollback operations. The Goldfire Server, as well as any other applications that rely on these services, are unavailable during this time.

Other services are stopped

130

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

How to perform an online update

From the Windows taskbar, choose Start Programs Goldfire Server Perform Update. This opens the Online Update Performer utility:

Click Update, and then click Next. The Online Update Performer utility installs updated files.

8 Online update of the Goldfire Server Performing an online update

131

If Goldfire or Goldfire Knowledge Base Producer (or both) are currently being used by network clients, you are prompted to disconnect all these users in order to install the updated files.

The previously installed version of the software is backed up in the location that is specified in the Save updated files to field. You can reinstall the previously installed version by running the Online Update Performer in Rollback mode.

132

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

A
Goldfire services
This appendix describes the Goldfire services that interact with one another and with IIS through Windows Sockets (TCP/IP). Each service listens to one or more ports, which are specified during the Goldfire Server setup. Important: The Goldfire Application Service account, which is used to start and run all Goldfire services, must be a network account. In addition, the Application Service account must have access to the internet. GF Catalog Stores the KB tree, relationships between knowledge bases and source documents, and knowledge base descriptions. Manages all Goldfire Administrator tasks, including recurrence tasks. Located on the Application server. Connects to the User database, which can be hosted on the machine where the Goldfire Application components are installed, on a machine where the Goldfire Indexing components are installed, or on a remote server. The User database stores all user-related data, including enduser search access to corporate knowledge bases, saved queries, and saved reports. Furthermore, this service supports all collaboration Repository functionality for Goldfire users. Located on the Application server. Accesses source documents, creates links to documents (for local processing on the Windows network), or stores documents in a temporary location (for all other types of processing). Generates files for the GF Document Processor service. Located on the Application server. Creates a conv.exe process for the conversion of each document to plain text. This process calls the XPDF, HTMLconv, and the Oracle Outside-In modules to convert the documents to plain text (file extensions are not used to determine file type). Generates files for the GF Document Storage service and the GF WordIndex service. Located on all Indexing servers.

GF DBClient

GF DocGenerator

GF Document Processor

134

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

GF Document Storage

Takes data from the GF Document Processor service. Stores plain text of source documents, document summaries, and Topics. Located on all Indexing servers. The OUDnlService.exe periodically checks the Invention Machine hosting facility for Goldfire application online updates. Located on the Application server. The GF OUClient updates Indexing server application components. Located on all Indexing servers. Hosts the semantic database for the Natural Language interface, which semantically tags users queries. Located on the Application server. Stores words and their semantic tags from processed documents. Goldfire client programs search this index of semantic relationships. Located on all Indexing servers. Shows Goldfire administrators all Goldfire database objects that can be viewed, including the network user and group directory, Lotus Notes data, ODBC data, and Deep Web data. Located on the Application server.

GF Online Update Downloader GF OUClient

GF Searcher

GF WordIndex

GF World Object Viewer

B
Goldfire Server client programs
This appendix describes the various client programs that interact with the Goldfire Server. Which applications you have depends on the type of Goldfire package that you purchased. This appendix includes the following topics: Topic Invention Machine Goldfire Goldfire Researcher Goldfire Administrator Goldfire Deep Web Link Goldfire Knowledge Base Producer Goldfire Desktop See Page 135 136 140 144 148 150

Invention Machine Goldfire


The Invention Machine Goldfire client program (often referred to simply as Goldfire) is available if you have purchased the Goldfire package in addition to the Goldfire Server. Goldfire integrates rigorous innovation methodologies, problem analysis, knowledge-sharing, problem-sharing, and research capabilities to increase the efficiency and productivity of engineers and innovation specialists. With Goldfire, companies use a single user interface to systematically analyze, conceive, research, and validate more costeffective, higher-quality product and process configurations.

136

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Goldfire project files, reports, and analysis models are stored in the collaboration Repository on the Goldfire Server to enable team collaboration. With the Repository, Goldfire provides access control and version control for Goldfire data. In addition to making corporate and personal knowledge conveniently accessible, Goldfire provides access to databases containing worldwide patents & articles and to the largest library of cross-disciplinary scientific effects and examplespre-indexed for precise knowledge retrieval. Documentation The following Goldfire documentation is available on the Goldfire installation CD: Goldfire Installation and System Administration Guide (Connecting to a Goldfire Server), or Goldfire Installation and System Administration Guide (Connecting to Goldfire.com) (PDFs) Goldfire online help, accessed from the software

Requirements

Goldfire product requirements are listed in Goldfire Installation (Goldfire Server).pdf and Goldfire Installation (Goldfire.com).pdf, available on the Client Disc 1 installation CD. These requirements include the requirements for the Goldfire Knowledge Base Producer desktop program, which is shipped with Goldfire.

Starting Goldfire

For instructions on how to start Goldfire, see Goldfire Installation (Goldfire Server).pdf or Goldfire Installation (Goldfire.com).pdf on Client Disc 1.

Goldfire Researcher
The Goldfire Researcher web client program is available if you have purchased the Goldfire Researcher package in addition to the Goldfire Server. Goldfire Researcher enables precision research and analysis, from a single user interface, of corporate knowledge bases, personal knowledge bases, the Scientific Effects database, and Invention Machines collections of patents & articles. Documentation Goldfire Researcher comes with a comprehensive, context-sensitive online help system.

B Goldfire Server client programs Goldfire Researcher

137

Starting Goldfire Researcher


The following procedure describes how to start Goldfire Researcher. To facilitate user login, your companys Goldfire administrator might have enabled automatic sign-on. In this case, end users are authenticated behind-the-scenes with their network credentials as soon as they open the login page. Note: Automatic sign-on is supported only for NT Domain and Windows 2000 Active Directory. For more information, see Specifying the user directory on page 36. How to start Goldfire Researcher 1 In Internet Explorer, type the Goldfire Researcher URL in the Address bar, and then press Enter. The Goldfire Researcher login page appears. The Goldfire Researcher URL is the path to the Goldfire Server machine, followed by /gf. For example: http://gfserver/gf Your companys Goldfire administrator must provide you with this URL. 2 3 Required software components If prompted, enter your network user name and password in the User Name and Password boxes on the login page. On the login page, click Login.

The first time you log in to Goldfire Researcher, you might be prompted to install or upgrade one or more required software components. What to do next depends on what components of Goldfire are currently installed on your computer. If Goldfire is installed on your computer, use the Online Update utility to update it to the latest version. After Goldfire is successfully updated, click Continue to log in to Goldfire Researcher. If Goldfire is not installed on your computer, but Goldfire Knowledge Base Producer is installed on your computer, use the Online Update utility to update Goldfire Knowledge Base Producer to the latest version. After Goldfire Knowledge Base Producer is successfully updated, click Continue to log in to Goldfire Researcher. If neither Goldfire nor Goldfire Knowledge Base Producer is installed on your computer, do one of the following: Click Download to download and install both Goldfire Knowledge Base Producer and the Goldfire Plug-in. Click Download to download and install only the Goldfire Plugin.

You can then continue to log in to Goldfire Researcher.

138

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

If you have difficulty logging in, please contact your companys Goldfire administrator. Note: You must be an administrator or a member of the administrators group to install any of the required software components on your computer. If you cannot install the required software components, ask your companys Goldfire administrator to have the software installed for you.

Information flow during searches


Corporate knowledge bases When end users search corporate knowledge bases: All queries and search results are transferred inside the company firewall between the Goldfire Server and end users.

Personal knowledge bases

When end users search personal knowledge bases: Queries target personal knowledge bases that reside on the end users local computer. All search results from personal knowledge bases remain on the end users computer.

Patents & Articles Collections, & Scientific Effects

When end users search Patents & Articles collections, and Scientific Effects: All queries and search results are exchanged across the company firewall with Invention Machines Goldfire.com server. The connection to Goldfire.com is a secure connection that uses 128-bit encryption.

System Requirements for Goldfire Researcher


Hardware requirements The following hardware components are required for Goldfire Researcher. These requirements include requirements for the Goldfire Knowledge Base Producer client program. Requirement Type CPU Memory Description Pentium III 500 MHz or higher 512 MB RAM, or more, if you do not install the Language Pack 768 MB RAM, or more, if you install the Language Pack

B Goldfire Server client programs Goldfire Researcher

139

Requirement Type Hard Disk

Description 230 MB for Goldfire Knowledge Base Producer program files, if you do not install the Language Pack 367 MB for Goldfire Knowledge Base Producer program files, if you install the Language Pack 1 GB of free space to begin creating personal knowledge bases with Goldfire Knowledge Base Producer Hard-disk usage for personal knowledge bases depends on the size of the processed document. The size of the database is approximately 2:1 relative to the size of the original document in TXT format.

Display Intranet/internet

Super VGA 16-bit color monitor with 1024 x 768 resolution Access to: The corporate Goldfire Server (http://) Internet, in order to view source documents that are located on the web Intranet, in order to view source documents that are located on the local network.

Software requirements

The following software components are required for Goldfire Researcher. These requirements include the Goldfire Knowledge Base Producer client program. Requirement Type Operating System Description One of the following: Windows 2000 Windows XP, 32-bit and 64-bit versions Windows Vista, 32-bit and 64-bit versions Windows 7, 32-bit and 64-bit versions Browser Microsoft Internet Explorer 6.x, 7.0, or 8 Sun Java SE 1.6.x Note: Make sure that your version of Sun Java is compatible with your version of Internet Explorer. For information about Java compatibility, see the following: http://www.java.com

140

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Requirement Type

Description Enable the following browser features: JavaScript (for navigation, presentation or search and analysis results, and Goldfire Plugin use) Java (for advanced Boolean search and patent citation maps) Cookies In addition, the following Internet Explorer Security Internet Options should be enabled for medium security level (for Goldfire Plug-in use): Run ActiveX controls and plug-ins Script ActiveX controls marked safe for scripting Active scripting

Additional software

The following software is required for viewing original documents and patent PDFs from research results. Required for Document viewing Description Adobe Reader 6.n, 7.n, 8.0, 8.1, 8.1.1, 8.1.2, 9.0, or 9.1 is required for viewing PDF documents from research results. Microsoft Word 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft Word, RTF, or WordPerfect documents. Microsoft Excel 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft Excel documents. Microsoft PowerPoint 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft PowerPoint documents. Lotus Notes Client 5.0, 6.0, 6.5, 7.0, 8.0, or 8.5 is required to view Lotus Notes documents when the link type option selected during Goldfire Server setup is other than Use Domino server links. For more information, see Lotus Domino server settings on page 34 or on page 43.

Goldfire Administrator
The Goldfire Administrator web client program is available to customers who have purchased the Goldfire Server.

B Goldfire Server client programs Goldfire Administrator

141

Goldfire Administrator enables administrators to do the following: Create and manage corporate knowledge bases Define and manage synonym lists and ontology sets that are used during searches Define and manage end-user accounts for Goldfire Server client programs, including Goldfire Administrator, Goldfire, Goldfire Insight, and Goldfire Researcher Define and manage end-user access to corporate knowledge bases

Types of documents that Goldfire Administrator can index

Use Goldfire Administrator to submit document indexing tasks to the Goldfire Server from the following types of sources: Internet Intranet Network servers Lotus Domino databases Microsoft SharePoint Portal servers Livelink servers Documentum databases Windchill servers Teamcenter Enterprise servers Teamcenter servers ODBC-compliant databases

See Supported document formats on page 159 for a complete list of supported document formats. Documentation Goldfire Administrator comes with a comprehensive, context-sensitive online help system.

Starting Goldfire Administrator


Goldfire Administrator is available after you install the Goldfire Server. For more information about working with Goldfire Administrator, see its online help. If you already have a Goldfire administrator account The following procedure describes how to log in to Goldfire Administrator if you already have a Goldfire administrator account: 1 In Internet Explorer, type the Goldfire Administrator URL in the Address bar, and then press Enter. The Goldfire Administrator login page appears.

142

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

The Goldfire Administrator URL is the path to the Goldfire Server machine, followed by /gfadmin. For example: http://gfserver/gfadmin The Goldfire Administrator URL is specified during the installation of the Goldfire Server. See Goldfire client access on page 27. 2 Type your network user name and password in the Admin Name and Password boxes of the login page, and then click Login. The Goldfire Server is configured with your NT Domain, LDAP, or Windows 2000 Active Directory user directory. Therefore Goldfire Administrator users are authenticated with their network user name and password. If you do not have a Goldfire administrator account The following procedure describes how to log in to Goldfire Administrator if you do not have a Goldfire administrator account: 1 In Internet Explorer, type the Goldfire Administrator URL in the Address bar, and then press Enter. The Goldfire Administrator URL is specified during the installation of the Goldfire Server. See Goldfire client access on page 27. 2 On the Goldfire Administrator login page, type the following to log in to the default Goldfire Administrator account: Admin Name: keadmin Password: keadmin 3 4 Click Login. After you log in, create a new Goldfire administrator account for yourself. Then log out, and then log back in using your network user name and password. For more information about creating a Goldfire administrator account, see the Goldfire Administrator online help.

System Requirements for Goldfire Administrator


Hardware requirements The following hardware components are required for the Goldfire Administrator client. Requirement Type CPU Memory Hard Disk Description Pentium III 500 MHz or higher 256 MB RAM, or more 2 MB for Goldfire Plug-in installation

B Goldfire Server client programs Goldfire Administrator

143

Requirement Type Display Intranet/internet

Description Super VGA 16-bit color monitor with 1024 x 768 resolution Access to the following: The corporate Goldfire Server (http://) or Goldfire.com Internet, in order to view source documents that are located on the web, as well as for Deep Web and web site processing with Goldfire Knowledge Base Producer Intranet, in order to view source documents that are located on the local network

Software requirements

The following software components are required for the Goldfire Administrator client. Requirement Type Operating System Description One of the following: Windows 2000 Professional Windows 2000 Server Windows XP, 32-bit and 64-bit versions Windows Vista, 32-bit and 64-bit versions Windows 7, 32-bit and 64-bit versions Windows Server 2003, 32-bit and 64-bit versions Windows 2008 Server Note: Goldfire does not support IPv6 on Windows 2008 Server or on Windows Vista. Browser Internet Explorer 6.x, 7.0, or 8 Sun Java SE 1.6.x Note: Make sure that your version of Sun Java is compatible with your version of Internet Explorer. For information about Java compatibility, see the following: http://www.java.com 128-bit encryption, required for connection to Goldfire.com.

144

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Requirement Type

Description Enable the following browser features: JavaScript (for navigation, presentation of search and analysis results, and Goldfire Plugin use) Java (for advanced Boolean search, citation maps) Cookies In addition, the following Internet Explorer Security Internet Options should be enabled for medium security level (for Goldfire Plug-in use): Run ActiveX controls and plug-ins Script ActiveX controls marked safe for scripting Active scripting

Additional software

The following software is required for viewing original documents. Required for Document viewing Description Adobe Reader 6.n, 7.n, 8.0, 8.1, 8.1.1, 8.1.2, 9.0, or 9.1 is required for viewing PDF documents from research results, and for viewing patent PDF documents. Microsoft Word 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft Word, RTF, or WordPerfect documents. Microsoft Excel 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft Excel documents. Microsoft PowerPoint 2000, 2002 (XP), 2003, 2007, or 2010 is required for viewing Microsoft PowerPoint documents. Lotus Notes Client 4.6, 5.0, 6.0, 6.5, 7.0, 8.0, or 8.5 is required to view Lotus Notes documents when the link type option selected during Goldfire Server setup is other than Use Domino server links. For more information, see Lotus Domino server settings on page 34 or on page 43.

Goldfire Deep Web Link


Goldfire Deep Web Link is available to customers who have purchased the Goldfire Server.

B Goldfire Server client programs Goldfire Deep Web Link

145

Goldfire Deep Web Link is used to create custom links to the following: Public sites that are not included in the list of shipped Deep Web Servers Proprietary sites to which you have a subscription

For more information about the types of servers that Deep Web Link supports, and about how to create custom links, see the Deep Web Link online help. After you create custom links with Deep Web Link, you must use the Goldfire Server Link Manager to import the links into the Goldfire Server. In addition, if your custom links connect to sites that require authentication (user ID and password), you must use the Goldfire Administrator Options page to import this login data. If you do not create login data in Deep Web Link and import it, you must enter it manually into Goldfire Administrator (see Goldfire Administrator online help). Deep Web: definition The Deep Web refers to public web serversincluding government, academic, commercial, and professional databasesthat cannot be accessed by conventional web searches. Invention Machine has created and maintains interfaces (links) to over 3300 such servers, facilitating access to valuable innovation content in 26 different industries. When you specify Deep Web processing in Goldfire Administrator for selected Deep Web servers, your indexing criteria are automatically reformulated into syntax that is appropriate to each server. The Deep Web links that are shipped with the Goldfire Server include only those web sites that allow full public access, as prescribed by their robots.txt files.

System Requirements for Deep Web Link


Hardware requirements The following hardware components are required for the Goldfire Deep Web Link client. Requirement Type CPU Memory Hard Disk Display Internet Description Pentium III 500 MHz or higher 256 MB of RAM 20 MB 1024 x 768 resolution with 16-bit color or higher Internet connection is required

146

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Software requirements

The following software components are required for the Goldfire Deep Web Link client. Requirement Type Operating System Description One of the following: Windows 2000 Windows XP Windows Vista Windows 7 Browser Microsoft Internet Explorer 6.x, 7.0, or 8 Enable the following browser feature: Cookies

Downloading and installing Deep Web Link


The following procedure describes how to download and install Goldfire Deep Web Link. 1 In Goldfire Administrator, click Deep Web Link at the top of the window. The File Download dialog box appears:

Do one of the following: Click Open, and then run DWLSetup.exe, following the on-screen instructions. Click Save, and then choose a folder to save the DWLSetup.exe file to. In Windows Explorer, find the folder containing DWLSetup.exe, and then run DWLSetup.exe, following the onscreen instructions.

Documentation

Deep Web Link includes a comprehensive online help system.

B Goldfire Server client programs Goldfire Deep Web Link

147

Importing Custom Links


Important: Before you import the links, make sure that no Deep Web processing is currently in progress. Custom links are imported into the Goldfire Server by running the Link Manager utility on the Goldfire Server. The custom server links defined by Deep Web Link are stored in files with a .dle extension at the location that is specified during link creation. Note: If your Goldfire Server version is 2.2 or earlier, you do not have the Link Manager utility. You must upgrade to a newer version of the Goldfire Server. How to import custom links 1 2 From the Windows taskbar on the Goldfire Server machine, choose Start Programs Goldfire Server Link Manager. (Optional) If custom links already exist in your database, select one of the following options: Append existing links, which merges the imported links into the current custom link set that was previously imported into the Goldfire Server. Replace all links, which replaces the existing custom link definitions. Replacing the existing custom links on the Goldfire Server does not delete the Deep Web Server links that are shipped with the Goldfire Server.

Click OK to continue. 3 4 5 In the Import Links dialog box, navigate to the folder that contains the file that you want to import (*.dle extension), and then select it. Click Open. (Optional) If any existing links on the Goldfire Server have the same name as the ones being imported, you are prompted to rename each duplicate link that you are importing. Click OK after renaming each link. This is done to avoid confusion when you are selecting servers for processing. 6 7 (Optional) If you are currently logged in to Goldfire Administrator, you must log out and then log in again to apply your changes. After the import finishes, the Link Manager displays the status of the import operation and automatically exits.

Deleting Custom Links


Important: Before you delete the links, make sure that no Deep Web processing is currently in progress.

148

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

To delete the custom links defined with Deep Web Link, you run the Link Manager utility on the Goldfire Server machine. Deleting custom links on the Goldfire Server does not affect the list of Deep Web links that are shipped with the Goldfire Server. Note: If your Goldfire Server version is 2.2 or earlier, you do not have the Link Manager utility. You must upgrade to a new version of the Goldfire Server. How to delete custom links 1 2 3 From the Windows taskbar on the Goldfire Server machine, choose Start Programs Goldfire Server Link Manager. In the Link Manager dialog box, select Delete all links. Click OK to delete the links.

Goldfire Knowledge Base Producer


Goldfire Knowledge Base Producer is a standalone program that resides on each end users computer. It is provided to all end users of Goldfire client programs. Goldfire Knowledge Base Producer is available to all customers who purchase any of the following packages: Goldfire package Goldfire Insight package Goldfire Researcher package

Goldfire Knowledge Base Producer captures knowledge into personal semantic knowledge bases. Personal knowledge bases are stored on the user's local hard disk and can be searched with Goldfire, Goldfire Insight, and Goldfire Researcher. Goldfire Knowledge Base Producer indexes personal documents and e-mail messages from the following sources: Internet Deep Web Personal e-mail and attachments Documents on networked corporate servers

B Goldfire Server client programs Goldfire Knowledge Base Producer

149

Product requirements
Goldfire Knowledge Base Producer requirements are included with the type of end-user client that you purchase: Goldfire, Goldfire Insight, or Goldfire Researcher.

Where to get Goldfire Knowledge Base Producer


For Goldfire Goldfire Knowledge Base Producer is installed as part of the Goldfire installation. See Goldfire Installation (Goldfire Server).pdf or Goldfire Installation (Goldfire.com).pdf on Client Disc 1. To download Goldfire Knowledge Base Producer from the Goldfire Researcher Home page, click Install Knowledge Base Producer and Plug-in.

For Goldfire Researcher

Starting Goldfire Knowledge Base Producer


The following procedure describes how to start Goldfire Knowledge Base Producer. Note: If you start Goldfire Knowledge Base Producer after you log in to Goldfire or Goldfire Researcher, you are not prompted to log in again. If you cannot connect If you are unable to connect, the Connection Error dialog box appears. In this case, click Reconnect to reopen the Goldfire Knowledge Base Producer Login dialog box. Then click Preferences, verify your connection settings, and try again. If you continue to have difficulty, please contact your companys Goldfire administrator. 1 Do one of the following: Double-click the Goldfire Knowledge Base Producer icon on your Desktop From the Windows taskbar, choose Start Programs Invention Machine Goldfire Goldfire Knowledge Base Producer.

How to start Goldfire Knowledge Base Producer

In the Login dialog box, click Preferences to specify or verify your connection settings. This opens the Connection Preferences dialog box.

150

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

If your Goldfire administrator has enabled automatic sign-on, select Login using current network user credentials to log in automatically, without having to type in your user name and password. Click OK. If prompted, enter your User Name and Password, which are the same as your network user name and password. Depending on the configuration of your corporate Goldfire Server, your User Name might need to include the domain name. For example, DOMAINname\myusername, rather than just myusername.

4 5

Documentation

Goldfire Knowledge Base Producer includes a comprehensive online help system.

Goldfire Desktop
Goldfire Desktop is a sidebar application program that resides on an end users computer. It is provided to all end users of Goldfire and Goldfire Insight. Goldfire Desktop is available to all customers who purchase any of the following packages: Starting Goldfire Desktop Goldfire package Goldfire Insight package Goldfire for Researcher Users package

For instructions on how to start Goldfire Desktop, see Goldfire Installation (Goldfire Server).pdf or Goldfire Installation (Goldfire.com).pdf on Client Disc 1.

C
Installing the User database on a remote server
Note: The following procedures are required only if you want to install the User database on a remote server. Configuring a User database on a remote server Use the following table to determine what to do before and during the Goldfire Server setup, as well as what setup options to select. When Before installing Goldfire Server Before installing Goldfire Server Before installing Goldfire Server Where On the remote server On the remote server On the Goldfire Application server Do What Check that a compatible Microsoft server is installed. Create a new database.

Install the Management Tools and Client Connectivity client tools from the SQL Server CD. Note: If no compatible client software is installed, Goldfire Server setup prompts you to install Microsoft SQL Server 2005 Express Edition. In step 8 of the Beginning the installation procedure (page 19), choose an Existing database, and then choose Create new database objects.

During Goldfire Server installation

On the Goldfire Application server

Preparing the MS SQL database

1 2 3 4

On the remote server, create a new user account. Grant dbcreator and public server roles to this user. Create an empty MS SQL database. Make the user whom you created at step 1 the owner of the empty MS SQL database.

152

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

How to install the MS SQL User database on a remote server

You can exit the setup at any time by clicking Cancel. 1 2 On the remote server, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard. If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue. The Type of Installation screen appears.<new image>

Click Advanced.

C Installing the User database on a remote server

153

The second Type of Installation screen appears.

5 6

Click User database installation, and then click Next to continue. Wait while Setup checks for one of the following client components: Client for Microsoft SQL Server Oracle Client

The Setup wizard provides options based on the products that are already installed on this computer. Click Next to continue.

154

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

The Database Version screen appears:

Database version

Click one of the following: Micrososft SQL Server 2005 Express Edition Microsoft SQL Server 2000 Microsoft SQL Server 2005, 2008

The Database Type screen appears:

C Installing the User database on a remote server

155

Database type

Click Use an existing database

Enter the database parameters for your MS SQL Server configuration: a In the Server box, enter the name of the server (up to 64 characters). If you do not see the required server in the list, either the server might be disabled, or there might be problems with the network. Without quitting setup, try to fix the server or network problem. Then return to the Goldfire Server Setup, and click Refresh to update the server list. If the server name still does not appear in the list, type the server name in the Server box.

User database server

User database name

In the Database Name box, we recommend that you keep the default name. If you need to modify the database name (because it must conform to your companys naming conventions, for example), edit the Database Name (up to 64 characters).

Authentication type

Specify the account to use during the Goldfire Server Setup program to create database objects in an existing database on the SQL server. This account must have DBA privileges. Windows Authentication, which uses the current Application Service account to access the SQL server.

156

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

SQL Server Authentication, which uses an existing SQL server account. You must enter the Login and Password for this account.

Data file path

Click Create during setup. This option specifies that Goldfire Server Setup creates the required folder for the database.

Click Next to continue. You are prompted to recreate the database or to use the existing data. 10 Click Recreate. The User Authentication screen appears:

User Authentication

11 Specify the account that Goldfire services will use to access the SQL server after the Goldfire Server is installed and running. This account must have at least RESOURCE privileges: Windows Authentication, which will use the current Application Service account to access the SQL server. SQL Server Authentication, which will use an SQL server account. You must enter the Login and Password for this account.

C Installing the User database on a remote server

157

Path to Goldfire Server components

12 (Optional) If you want to change the default installation directory, click , and then select an installation folder.

13 (Optional) Review the list of Goldfire Server components to be installed. To change any installation settings, click Back to return to a previous screen and edit the settings. Note: This will not cause you to lose any information already entered. Begin to install 14 Click Next to begin the installation. You are notified if errors are encountered, and when the installation is complete.

158

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

D
Supported document formats
With the Goldfire Server installation, you can process over 100 wordprocessing, spreadsheet, and presentation formats in the following Goldfire client programs: Goldfire Administrator Goldfire Knowledge Base Producer

The Goldfire Server uses embedded Oracle Outside-In Viewer Technology, and XPDF modules. This appendix provides the complete list of supported file formats, including the following: HTM[L] (Hypertext Markup Language) PDF (Portable Document Format) RTF (Microsoft Rich Text Format) DOC (Microsoft Word documents) DOCX (Microsoft Word documents) PPT (Microsoft PowerPoint) XLS (Microsoft Excel) TXT (Text-only format) XML files

Although the Goldfire Server successfully processes all listed file types, highlighting of target sentences when users open the document from a page of search results is available only for HTML, RTF, DOC, DOCX, TXT, PDF, PPT, XLS, and WPD formats.

160

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

This appendix contains the following topics: Topic Word processing formats Desktop publishing format Spreadsheet formats Presentation formats Graphic formats E-mail format Compressed formats Other supported formats See Page 160 162 163 164 164 164 165 165

Word processing formats


The following word processing formats are supported: Document Format ANSI Text ASCII Text DEC WPS Plus (DX) DEC WPS Plus (WPL) DisplayWrite 2 & 3 (TXT) DisplayWrite 4 & 5 EBCDIC Enable First Choice Framework Hangul IBM FFT IBM Revisable Form Text IBM Writing Assistant Just System Ichitaro JustWrite Legacy Product Version 7 & 8 bit 7 & 8 bit Versions through 3.1 Versions through 4.1 All versions Versions through 2.0 All versions Versions 3.0, 4.0 and 4.5 Versions through 3.0 Version 3.0 Versions 97 and 2002 All versions All versions Version 1.01 Versions 4.x through 6.x, 8.x through 13.x and 2004 Versions through 3.0 Versions through 1.1

D Supported document formats Word processing formats

161

Document Format Lotus AMI/AMI Professional Lotus Manuscript Lotus Word Pro (non-Windows) Lotus Word Pro (Windows) MacWrite II MASS11 Microsoft Rich Text Format (RTF) Microsoft Word (DOS) Microsoft Word (Mac) Microsoft Word (Windows) Microsoft WordPad Microsoft Works (DOS) Microsoft Works (Mac) Microsoft Works (Windows) Microsoft Windows Write MultiMate Navy DIF Nota Bene Novell Perfect Works Novell/Corel WordPerfect (DOS) Novell/Corel WordPerfect (Mac) Novell/Corel WordPerfect (Windows) Office Writer OpenOffice Writer (Windows and UNIX) PC-File Letter PC-File+ Letter PFS:Write Professional Write (DOS)

Product Version Versions through 3.1 Version 2.0 Versions SmartSuite 97, Millennium, and Millennium 9.6 (text only) Versions SmartSuite 96, 97 and Millennium and Millennium 9.6 Version 1.1 Versions through 8.0 All versions Versions through 6.0 Versions 4.0 - 2004 Versions through 2007 All versions Versions through 2.0 Versions through 2.0 Versions through 4.0 Versions through 3.0 Versions through 4.0 All versions Version 3.0 Version 2.0 Versions through 6.1 Versions 1.02 through 3.0 Versions through 12.0 Versions 4.0 - 6.0 OpenOffice version 1.1 and 2.0 Versions through 5.0 Versions through 3.0 Versions A, B and C Versions through 2.1

162

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Document Format Professional Write Plus (Windows) Q&A (DOS) Q&A Write (Windows) Samna Word Signature SmartWare II Sprint StarOffice Writer Total Word Unicode Text UTF-8 Volkswriter 3 & 4 Wang PC (IWP) WordMARC WordStar (DOS) WordStar (Windows) WordStar 2000 (DOS) XyWrite

Product Version Version 1.0 Version 2.0 Version 3.0 Versions through Samna Word IV+ Version 1.0 Version 1.02 Versions through 1.0 Version 5.2 (text only) and 6.x through 8.x Version 1.2 All versions All versions Versions through 1.0 Versions through 2.6 Versions through Composer Plus Versions through 7.0 Version 1.0 Versions through 3.0 Versions through III Plus

Desktop publishing format


The following desktop publishing format is supported: Document Format Adobe FrameMaker (MIF) Product Version Versions 3.0, 4.0, 5.0, 5.5, and 6.0; and Japanese 3.0, 4.0, 5.0, and 6.0 (text only)

D Supported document formats Spreadsheet formats

163

Spreadsheet formats
The following spreadsheet formats are supported: Document Format Enable First Choice Framework Lotus 1-2-3 (DOS & Windows) Lotus 1-2-3 (OS/2) Lotus 1-2-3 Charts (DOS & Windows) Lotus 1-2-3 for SmartSuite Lotus Symphony Mac Works Microsoft Excel Charts Microsoft Excel (Mac) Microsoft Excel (Windows) Microsoft Multiplan Microsoft Works (Windows) Microsoft Works (DOS) Microsoft Works (Mac) Mosaic Twin Novell Perfect Works PFS:Professional Plan QuattroPro (DOS) QuattroPro (Windows) SmartWare II StarOffice/OpenOffice Calc (Windows and UNIX) SuperCalc 5 VP Planner 3D Product Version Versions 3.0, 4.0, and 4.5 Versions through 3.0 Version 3.0 Versions through 5.0 Versions through 2.0 Versions through 5.0 Versions 97 - Millennium 9.6 Versions 1.0, 1.1, and 2.0 Version 2.0 Versions 2.x - 7.0 Versions 3.0 - 4.0, 98, 2001, 2002, 2004, and v.X Versions 2.2 through 2007 Version 4.0 Versions through 4.0 Versions through 2.0 Versions through 2.0 Version 2.5 Version 2.0 Version 1.0 Versions through 5.0 (text only) Versions through 12.0 (text only) Version 1.02 StarOffice versions 5.2 through 8.x and OpenOffice version 1.1 and 2.0 (text only) Version 4.0 Version 1.0

164

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Presentation formats
The following presentation document formats are supported: Document Format Corel/Novell Presentations Harvard Graphics (DOS) Harvard Graphics (Windows) Freelance (Windows) Freelance (OS/2) Microsoft PowerPoint (Windows) Microsoft PowerPoint (Mac) StarOffice/OpenOffice Impress (Windows and UNIX) Product Version Versions through 12.0 Versions 2.x & 3.x Windows versions Versions through Millennium 9.6 Versions through 2.0 Versions 3.0 through 2007 Versions 4.0 through v.X StarOffice versions 5.2 (text only) and 6.x through 8.x (full support) and OpenOffice version 1.1 and 2.0 (text only)

Graphic formats
The following graphic formats are supported: Presentation Software Visio (preview) Visio Version Version 4 Versions 5, 2000, 2002, and 2003

E-mail format
The following e-mail formats are supported: Presentation Software Microsoft Outlook Folder (PST) Microsoft Outlook Message (MSG) Version Microsoft Outlook Folder files Microsoft Outlook Message files

D Supported document formats Compressed formats

165

Compressed formats
The following compressed formats are supported: Compressed Format GZIP LZA Self Extracting Compress LZH Compress Microsoft Binder Versions 7.0-97 (conversion of files contained in the Binder file is supported only on Windows) Product Version

UNIX Compress UNIX TAR ZIP PKWARE versions through 2.04g

Other supported formats


The following additional formats are supported: Document Format Executable (EXE, DLL) HTML MacroMedia Flash Microsoft Project MP3 vCard, vCalendar Windows Executable WML XML Yahoo! Instant Messenger Version 5.2 Text only. Versions 6.x and 7.x Versions through 3.0, with some limitations Macromedia Flash 6.x, Macromedia Flash 7.x, and Macromedia Flash Lite (text only) Versions 98 - 2003 (text only) ID3 information Version 2.1 Product Version

166

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

E
Advanced installation of the Goldfire Server
This appendix describes how to perform an advanced installation of the Goldfire Server, configuring it with a Microsoft User database. You can configure the Goldfire Server with any of the following: Microsoft SQL Server 2005 Express Edition Microsoft SQL Server 2000 Microsoft SQL Server 2005 Microsoft SQL Server 2008

For information about how to configure the Goldfire Server with an Oracle User database, see GF Server System Configuration (Oracle).pdf on Server Disc 1.

Installing the Goldfire Server


The Advanced installation of the Goldfire Server enables you to upgrade the Goldfire Server from earlier versions, and to perform nontypical installation configurations. The Advanced installation option enables you to do any of the following: Install the Goldfire Server in a single-server configuration on one computer. When you install the Goldfire Server in a single-server configuration, the application components and the indexing components are installed together. If you want to install one or more Indexing servers later, you must reinstall the Goldfire Server either in a multiple-server configuration or using the Typical Installation option. Install the Goldfire Server on two or more computers.

168

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

When you install the Goldfire Server on two or more computers, the Application server is installed on the first computer, and one or more Indexing servers are installed on the second and subsequent computers. If you want to install more Indexing servers later, you can do so easily using the Add Indexing Server option. Install the User database on a remote machine. For details about how to do this, see Installing the User database on a remote server on page 151.

IMPORTANT!

You must install the Goldfire Server from an account that has administrator privileges on the local installation computer. This account is the Goldfire Application Service account. The Application Service account must be registered with the local network domain, and the account must have access to the internet. In addition, we recommend that the Application Service account be assigned a password that does not change. The following components must already be installed before you begin the Goldfire Server setup program: Microsoft Internet Information Server (IIS) Microsoft Internet Explorer Microsoft .NET Framework 2.0

If these components are not installed, you cannot install the Goldfire Server. After you install the Goldfire Server, see What to do after you install the Goldfire Server on page 77.

Beginning the installation


You can exit the setup at any time by clicking Cancel. 1 2 On the Goldfire Application server machine, log in to the Goldfire Application Service account. Insert the Goldfire Server installation CD into the CD-ROM drive (for example, drive D). This automatically starts the Setup wizard. If the Setup wizard does not start automatically, you can start it manually as follows: a b c 3 From the Windows taskbar, choose Start Run. In the dialog box, enter the CD-ROM drive letter followed by :\SETUP.exe. For example, type D:\SETUP.exe Click OK.

On the Welcome screen of the Setup wizard, click Next to continue.

E Advanced installation of the Goldfire Server Installing the Goldfire Server

169

The Type of Installation screen appears.

Click Advanced. The second Type of Installation screen appears.

Click one of the following: Single-server configuration to install the Goldfire Server in a single-server configuration on one computer. Click Next, and then follow the on-screen prompts to complete the installation. Multiple-server configuration to install the Goldfire Application server on one computer and then install the Goldfire

170

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

Indexing server on a second computer. Click Next, and then follow the on-screen prompts to complete the installation. User database installation to install the User database on a remote server (that is, a server different from the machine where the Application server is installed). Click Next , and then proceed with step 6 on page 153.

Index
A
access rights 54, 58, 79 accounts Goldfire administrator 78 Active Directory 10, 79 administering federated Goldfire Servers 98 administrator accounts 78 Application Service account 12, 13, 81, 168 password 23, 43, 48, 81 authentication modifying 99 Automatic Diagnostic 90 automatic retrieval of end-user email 102 automatic sign-on 78

D
databases ODBC-compliant 54 Defines.xml configuration file 62, 63, 65, 71 Defines.xml configuration file 62 DFC 6, 61, 62 diagnostics 91 Direct3D, disabling 105 document processing 79 recurrent settings 113 document security 54, 58 Lotus Notes databases 58 document-level security 72 Documentum databases 61 Desktop 62 Foundation Classes 61, 62 Documentum Foundation Classes 6

C
classes (Teamcenter Enterprise) 66 configuration settings modifying 81?? configuring online update 123 connection settings 78 converting nontext files to plain text files 114 corporate knowledge bases 79 access rights 79 custom news publishing 105 custom variables 108 CustomConverter.ini file 114 customizing text of reports 109 CustomNews.xml file 105 CustomVars.xml file 108

E
e-mail automatic retrieval of enduser 102 end-user access to remote Goldfire Servers 99

F
federated Goldfire Servers 97 administering 98 security concerns 98 files converting nontext to plain text 114 CustomConverter.ini 114 format of teamcenterent.xml file 68

172

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

G
Goldfire administrator accounts 78 Goldfire Application Service account modifying 81 Goldfire license file 80 Goldfire Server connection settings 78 modifying configuration settings 81?? Repository 79 system requirements 3 uninstalling 122 Goldfire Servers federated 97 remote 97, 98 security concerns 98

Lotus Notes Client 6, 58 Lotus Notes databases document security 58 link type 59

M
mapping different user directories 72 Microsoft SharePoint Portal Server 2001 60 Microsoft SharePoint Portal Server 2003 60 Microsoft SharePoint Portal servers 60 Microsoft SQL Server 1, 5, 9 Microsoft SQL Server 2005 Express Edition 1 modifying Goldfire Application Service account 81 Goldfire Server configuration settings 81?? user authentication method 99 User database settings 83

H
HttpOnly flag 105

I
Indexing servers software requirements 8 installation new 1 upgrade 2 Invention Machine support 92

N
new installation 1 NT Domain 79 user directory 10

J
Java disabling Direct3D 105 HttpOnly flag 105 Java, upgrading to Version 6 104

O
ODBC requirements 54 ODBC-compliant databases 54 online update 2 configuring 123 performing 129 Oracle server 1

K
knowledge bases 79 access rights 54, 58, 79

P
password Application Service account 23, 43, 48, 81 performing online update 129 PKMCDO 60, 61 proxy server time-out setting 78 Publishing and Knowledge Management Collaboration Data Objects 60, 61 publishing custom news 105

L
Language Pack 97 LDAP 10 license file 80 Link Type 59 Livelink servers 61 LNClientPwd.exe 58 LNIniEditor.exe 58 Lotus Domino servers requirements 58

Index

173

R
recurrent document processing settings 113 remote Goldfire Servers 97, 98 configuring end-user access 99 reports customizing text 109 Repository 79 requirements Lotus Domino servers 58 ODBC 54 system 3 results tuning number of search 109

Teamcenter Community Collaboration servers 60, 72 Teamcenter Enterprise configuration file 66 servers 65 supported classes 66 teamcenterent.xml file 66 format 68 time-out setting (proxy server) 78 troubleshooting 91 tuning number of search results 109

U
uninstalling Goldfire Server 122 upgrade installation 2 Use_CRC variable 113 user authentication modifying 99 User database 1, 10, 151 modifying settings 83 user directories mapping 72 user directory 10

S
search results tuning number of 109 security (documents) 54, 58 Server Disk 1 setting custom variables 108 sign-on, automatic 78 software requirements Indexing servers 8 system information and log files 92 system requirements 3 Lotus Domino servers 58 ODBC 54

V
variables 108

W
Windchill servers 63

T
Teamcenter servers 70

174

Goldfire Server 6.1.1: System Configuration Guide (with Microsoft User Database)

You might also like