atg search installation and configuration guide - product ...€¦ · 2 1 introduction more...

Search

Version 9.4

Installation and Configuration Guide

Oracle ATG

One Main Street

Cambridge, MA 02142

USA

ATG Search Installation and Configuration Guide

Product version: 9.4

Release date: 10-31-11

Document identifier: SearchInstallConfigGuide1307251603

Copyright © 1997, 2011 Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are

protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any

means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please

report them to us in writing. If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of

the U.S. Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS

Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial

computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific

supplemental regulations. As such, the use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and

license terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the Government contract, the

additional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). Oracle America, Inc., 500 Oracle

Parkway, Redwood City, CA 94065.

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended

for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or

hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures

to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are

trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or

registered trademarks of Advanced Micro Devices. UNIX is a registered trademark licensed through X/Open Company, Ltd.

This software or hardware and documentation may provide access to or information on content, products, and services from third parties.

Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party

content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to

your access to or use of third-party content, products, or services.

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/us/

corporate/accessibility/index.html.

Oracle customers have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/support/

contact.html or visit http://www.oracle.com/accessibility/support.html if you are hearing impaired.

ATG Search Installation and Configuration Guide iii

Table of Contents

1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

More Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

2. ATG Search Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

How ATG Search Works . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

ATG Search Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Security in ATG Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

3. Planning Your Search Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Defining ATG Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Recommended Search Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Search Architecture for Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Search Architecture for a Production Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

Search Installation Prerequisites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Search Installation Roadmaps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Search Evaluation Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Search with Commerce, Content Administration & Merchandising Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . 12

Search with Knowledge and Self Service Roadmap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

Search with Commerce, Content Administration, Merchandising and Customer Intelligence . . . . . . 20

Configuring Search with CIM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

4. Installing ATG Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Installing Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Installing HTMLFilter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Installing PDF Extract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Adding Search Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Configuring Remote Indexing Engines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Configuring a Multi-Server Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Configuring Search Routing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Configuring the DeployShare Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring the Lock Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

Configuring the IDGenerator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Configuring the IndexingOutputConfig Component . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Configuring Customization Adapters for Search Merchandising . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Configuring SearchSQLRepository Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Indexing Versioned Repositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Configuring Data Sources for Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Creating the Search Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Creating Base Search Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Importing Initial Search Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Creating Database Tables for Search with Merchandising . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Deleting Search Database Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Configuring Search for Customer Intelligence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Accessing Search Administration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

A. Migrating from ATG 2006.x Search Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Form Handler Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Architecture Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Terminology Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Procedural Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

Reporting Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Migration Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

B. ATG Search Component Ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

iv ATG Search Installation and Configuration Guide

C. Search CIM Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Installed Products Required . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Database Assumptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Module Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Database Schema Scripts Run . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Management Schema . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

Production Switching (catalog A or B) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Production Switching Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Production Non-Switching Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Data Import Details . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63

Production Switching Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Production Non-Switching Core . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Server Instance Creation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

CA instance: Non-Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

Production Instance: Non-Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

CA Instance: Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Production Instance: Switching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

5. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

1 Introduction 1

1 Introduction

This guide explains how to install and configure ATG Search, and how to integrate your Search installation

with other ATG applications. It is written for system administrators and other experienced persons involved

in planning and performing an ATG Search installation. Review this guide thoroughly before beginning your

installation.

If you are upgrading from ATG Search 2006.x, read Appendix A, Migrating from ATG 2006.x Search Versions (page

49), to familiarize yourself with changes in terminology and features before continuing with your installation.

This chapter includes the following sections:

Audience (page 1)

Document Conventions (page 1)

More Information (page 2)

Audience

This manual is intended for system and site administrators responsible for installing and configuring ATG Search.

To use this guide, you should be familiar with:

• Windows and/or UNIX administration

• ATG product architecture

• Server environments and security infrastructure in your organization

Document Conventions

This guide uses the following conventions:

• <ATG9dir> refers to your ATG 9.4 installation directory.

• <SearchEngineDir> refers to the directory where you have installed a standalone Search engine.

2 1 Introduction

More Information

For more information on ATG Search, see the following:

• ATG Search Administration Guide—Administering your Search installation.

• ATG Search Query Reference Guide—Detailed information on how content is indexed and how queries are

processed.

See the following documentation for making searchable content accessible to end-users of your ATG products:

• ATG Commerce Search Guide—Using Search with your ATG Commerce site.

• ATG Service Installation and Configuration Guide—Using Search as part of Knowledge.

2 ATG Search Overview 3

2 ATG Search Overview

ATG Search is an industry-leading search engine that lets users zero in on the information they need, regardless

of format, location or language. Multiple levels of analysis pinpoint answers and deliver them with sub-second

response times.

ATG Search features include:

• Natural language processing of end-user queries

• Multiple ways to find information (browse, keyword, etc.)

• Support for faceted navigation in client applications

• Multiple language support

• Industry-specific lexicons

• Automated indexing and categorization

• Predefined reports using ATG Customer Intelligence

Review this guide thoroughly before beginning your installation. This chapter includes the following sections:

How ATG Search Works (page 3)

ATG Search Components (page 4)

Security in ATG Search (page 6)

How ATG Search Works

“Searching” means retrieving information using an input query. Commonly, the information is textual, it is

retrieved from a collection of documents, and the queries are words or phrases entered by an end-user. The

search results are typically those documents most relevant to the query, plus some indication of why the

documents were retrieved. In order for searching to be efficient, the document collection is indexed by its terms

in a secondary storage component, typically called the index.

ATG Search generalizes documents and other content into an abstraction called an index item. An index item

can be an actual document such as an HTML file, a repository item such as an ATG Commerce product, or a

piece of structured data from a database such as Microsoft Access. An index item consists of two elements:

searchable text content and metadata. Metadata includes the title, summary, and other properties, and is used in

the following Commerce Search features:

4 2 ATG Search Overview

• Faceted navigation

• Rank configuration

• Secondary sorting

The index items are fed into ATG Search, which analyzes the content and stores a representation for each item

in the index. The index objects are organized into hierarchical sets much like a directory scheme. ATG Search

creates some sets from the physical organization of the items, some sets from the metadata of the items,

and other sets from topic categorization results. These item sets enable users to search within subsets of the

collection and browse the collection without query input.

Text content is processed through the natural language components, which identify the structural elements

(such as sentences, headers, and tables) as well as the terms in the content. This processing is driven by a

dictionary and other language data, which are also stored in the index. The terms are divided into statement

vectors representing the sequence of terms in a structural portion of the content. The terms are also added to an

index, similar to one found in the back of a large book. Thisback-of-the-book index allows for efficient searches

and provides a global view of all the content.

Rather than simple text queries, ATG Search accepts complexrequests that specify what actions should be

performed. A request may include parameters, processing options, constraints, security settings, and other

information. The two primary requests are the Search Query and the View Item request. ATG Search returns

responses that contain varied information depending on the type of request. For a Search Query, the response

contains a list of results plus other information to drive the search application or user interface.

For more information on how ATG Search processes content into a searchable index, see the ATG Search Query

Reference Guide.

ATG Search Components

ATG Search has the following components:

• Search Administration—The interface where you create projects, index content, deploy indexes, etc.

Runs within a standard ATG installation. The SearchAdmin.AdminUI module is required to run Search

Administration. Your ATG installation should include only one instance of Search Administration.

Project Administration is the part of the Search Administration interface dedicated to project-related tasks. The

Search project contains information about the searchable content set you define, such as its location, what

rules are followed for its indexing, and what customization data is applied.

Note: A Search project bears no relationship to a Content Administration project. Search projects do not

contain deployable assets or have an associated workflow, but are a means to organize and configure a given

set of indexable content.

The project links the index with Search environments. Environments define the available resources for

indexing content and deploying completed indexes. You can also use projects to associate an index with

customization data. Some customization data affects how topic is indexed; other data is applied when the

end-user submits a query.

When you install Search, a default environment is created automatically; this means that you don’t have to

create any environments before indexing your content for evaluation. You can add hardware resources to the

default environment, and create environments as required to handle end-user requests. See the ATG Search

Administration Guide for information on creating and configuring environments.

2 ATG Search Overview 5

The Search workbench is where you create and work with customization data and view information about

existing indexes. Customizations either add information to the index itself (such as additional dictionaries and

term weights) or affect the way your content is processed or accessed by end users (for example, Query Rules,

Topic Sets, and Facet Sets). Such customizations optimize your Search implementation for higher accuracy

and improved usability.

For information on Search Administration and customization data, see the ATG Search Administration Guide.

• Search engine—Engine instances can either index content or serve answers to end-user queries. The

DAF.Search.Routing module starts engine instances in the environments associated with a project as

needed.

Search engines do not require an ATG instance (and are therefore also called “standalone” engines). Your

installation can have any number of Search engines, but should run only one per CPU. A single Search engine

requires at least 1.5GB of memory on a 32-bit operating system.

• Routing—The DAF.Search.Routing module starts Search engines and coordinates communication among

all Search components. This module is included in Search Administration and in client applications.

• Client application—Interface through which your users place their search queries, such as an ATG Commerce

Web site. This application must include the DAF.Search.Routing and DAF.Search.Query modules.

• Search index—The searchable content deployed on your site. An index is composed of one or more logical

partitions, each of which is associated with content configured in Search Administration. Each logical partition

is composed of one or more physical partitions. Each physical partition requires a search engine to serve

answers from that partition. Each engine has its own copy of the physical partition it serves.

Search Index Concepts Related

• Search database—Search uses the following three repositories:

• Routing—Stores search engines, index structure, and index deployment information.

• Search Administration—Stores other Search Administration data.

6 2 ATG Search Overview

• IncrementalItemQueue—Stores incremental indexing data.

Search Administration requires access to all three repositories. Your client application requires access to the

IncrementalItemQueue and the routing repository.

See the Recommended Search Architecture (page 8) section for detailed information on how these

components can be arranged in your installation.

Security in ATG Search

ATG Search includes the Search Access role, which allows a user assigned that role to access Search

Administration and the Workbench. This role is granted by default to the admin user; in ATG Knowledge, by

default it is also assigned to the service user.

The role can be found in the SearchAdminRoles folder of the ATG Business Control Center. For information on

using the BCC, see the ATG Business Control Center Administration and Development Guide.

3 Planning Your Search Installation 7

3 Planning Your Search Installation

Before you start installing Search, consider the following questions:

• What ATG products do you plan to use along with Search? It’s a good idea to review all of the applicable

documentation before beginning any ATG installation.

• How will you apportion your hardware? Indexing and searching are resource-intensive functions that benefit

strongly from dedicated hardware with robust specifications.

• How will your applications be distributed? Some ATG applications can share an ATG server instance, while

others cannot. Will your system include clusters? See the ATG Multiple Application Integration Guide for

architectural information.

• How will administrative functions such as lock management be handled? With a dedicated ATG server

instance, or as part of some other function?

• What database software will you use? Where will the ATG platform and application schemas live? How will

they be accessed?

• Where will your ATG Search deployment share be located? The deployment share is a single, scalable, shared

directory where master copies of indexes are stored. Your installation can have only one deployment share,

which should be located on a dedicated high-performance disk, separate from the Search Administration

installation. The Search Administration installation and all Search engines must have access to this directory.

Note: The size of the index that is deployed does not bear any direct relationship to the size of the raw

information being indexed—dictionaries, topics, and other customization data can all add to the size of the

index, as can the nature of the content itself. For example, content consisting mostly of pictures with some

metadata might form a very small index relative to the raw content size, while a product catalog with many

small, unique pieces of information might be relatively large.

Review this guide thoroughly before beginning your installation. This chapter includes the following sections:

Defining ATG Servers (page 8)

Recommended Search Architecture (page 8)

Search Installation Prerequisites (page 10)

Search Installation Roadmaps (page 11)

Configuring Search with CIM (page 25)

8 3 Planning Your Search Installation

Defining ATG Servers

The term server can be confusing due to its multiple meanings. In this guide, server or ATG server refers to an

ATG application instance that is deployed to your application server in the form of an EAR file. Each server can

(and usually does) include multiple ATG products and a variety of modules depending on the server’s purpose.

Conversely, one product may require multiple ATG servers in order to be used effectively.

You can create any number of ATG servers, which are based on a single physical installation of ATG software, by

using Dynamo servers. Dynamo servers are a way to provide server-specific configuration information without

undue duplication; see the ATG Installation and Configuration Guide for information if you are not familiar with

this feature.

To reduce confusion, application servers and Dynamo servers are always specified as such in this guide, and the

term server never refers to hardware.

Recommended Search Architecture

The purpose of this section is to outline the principles involved in the Search architecture and enable you to

make the best decision for your site. The examples that follow deal solely with Search components; everything

else is represented as “Client Application.” For diagrams that show Search integrated with other ATG products,

see the Search Installation Roadmaps (page 11) section of this chapter.

In the diagrams that follow, the light gray boxes represent ATG servers, which can be, but are not necessarily,

analogous to hardware resources. Dark gray boxes, when present, represent standalone Search engines.

Search Architecture for Evaluation

This architecture runs all of your Search components within a single ATG instance. This is sufficient for basic

evaluation purposes and for estimating the size of your final architecture, but should never be used for

production.


A Self-Contained Search Installation

You may want to use this setup to estimate the size of your index using Search Administration, and then add

resources to support that index. The original installation can then be used solely for Search Administration.

Search Architecture for a Production Site

In a production environment, Search Administration and the client application run in separate ATG instances, on

separate machines, with two instances of the latter to provide redundancy. Communication between instances

is handled by the DAF.Search.Routing module. Note that this module must be able to communicate with the

Search database.

This recommended architecture uses the Search Administration instance for indexing content, with several

standalone engines to serve answers to end-user queries. The dark gray box in the lower right represents any

number of hosts you might assign to one or more production environments, running as many Search engines as

your hardware will support.

The diagram also includes ATG Customer Intelligence. Note that your data loaders must run in a dedicated ATG

instance, separate from your application and from Search.


Application Redundancy and Dedicated Engine Resources

If your content set is large enough, serving answers requires more than one Search engine, each of which should

have a dedicated CPU. An index is composed of one or more logical partitions, each of which is associated with

a content set configured in Search Administration. Each logical partition is composed of one or more physical

partitions. Each physical partition is served by a search engine. Each engine has its own copy of the physical

partition it serves.

Search Installation Prerequisites

This section addresses prerequisites and preliminary configuration procedures that must be followed before

installing ATG Search.

• If you are installing on AIX and must run Search using sudo, note that for security reasons, AIX removes

the LIBPATH environment variable when using sudo. To resolve this potential problem you can either set

LIBPATH as root before running Search, or set the LIBPATH in the application server’s startup script.

Note that running any ATG application as root is not recommended. If at any time you run Search as root

or using sudo, the file permissions in the installation change to root. Therefore, you must either continue

running Search as root or using sudo, or reset the file permissions.

• For any installation in which you are planning to run Search Administration, before you install ATG Search,

install your application server and the ATG platform. If you are only planning to run a standalone Search

engine, you do not need the ATG platform or an application server.


• You will need a scalable, shared network drive where indexes are initially created and from which they can be

retrieved by the Search engines. This directory is called the deployment share. All Search engines and Search

Administration instances must have access to this directory. Indexes can take up a great deal of disk space, so

be sure the directory selected has sufficient space (at least 100 GB, more if your index is large or you plan to

archive old indexes). This directory must be writable. In a production site, this directory should be located on

a dedicated, high-performance machine.

Note: The deployment share must be created and configured as a shared folder prior to installing ATG Search.

Search Installation Roadmaps

This section outlines what needs to be done to set up Search in a variety of configurations, and cross-references

to the appropriate sections in this guide and to additional documentation needed to perform each step.

Search Evaluation Roadmap

The goal of this roadmap is to install and configure a Search installation that does not integrate with any other

applications, but allows you to run Search Administration and index content for evaluation purposes.

Before you begin:

• Make sure you have your database information at hand, and that any necessary drivers are installed.

• Select a Search Deployment Share directory. See Configuring the DeployShare Directory (page 32) in this

guide. In a self-contained installation, this can be any local directory with enough room for your index.

To set up a Search environment for evaluation:

1. Install your application server. See the ATG Installation and Configuration Guide for information on configuring

your application server for ATG products.

2. Download and install ATG products:

• ATG platform; select all components when installing. See the ATG Installation and Configuration Guide.

• ATG Search; select the Full Search Install option. Install the HTML and PDF components if needed (see

Installing HTMLFilter (page 28) and Installing PDF Extract (page 28) in this guide). See Installing

Search (page 27) in this chapter.

3. Create the database tables. See the ATG Installation and Configuration Guide for platform database

configuration. See Creating the Search Database Tables (page 43) in this guide for Search-specific tables.

4. Assemble and deploy an ATG application EAR file. Include the SearchAdmin.AdminUI module in the EAR.

See the Assembling Applications section of the Developing and Assembling Nucleus-Based Applications chapter

in the ATG Programming Guide for details on application assembly.

5. Start your ATG application, log in, and navigate to Search Administration. See Accessing Search

Administration (page 46) in this chapter.

You can then create a Search project, index content, and create customization data as described in the ATG

Search Administration Guide. Note that without a client application, you will not be able to search your index.


Search with Commerce, Content Administration & Merchandising Roadmap

The goal of this roadmap is to install and configure Search in an integrated environment with ATG Commerce,

Content Administration, and Merchandising. This configuration is often referred to as Commerce Search. It also

includes the use of standalone Search engines.

You will need three ATG instances for this product combination:

• One runs the administrative interfaces, including Merchandising and Search Administration; this is referred to

as the asset management server in this roadmap.

• The second runs your Commerce site for testing, and is referred to as the staging server.

• The final instance runs your live site, and is referred to as the production server.

The servers can be set up on separate machines, or run as separate instances on one machine if it has plenty

of memory. The latter option is not recommended for a live site, but you may use such a configuration for

evaluation or testing purposes. You may also want to dedicate resources for additional Search engines.

Note that the staging server is not required for this product combination, though it is recommended. Your

configuration may also include a preview server.

Some of the steps in this procedure can be performed using ATG’s CIM tool. These steps are noted in the

roadmap. See Configuring Search with CIM (page 25) and the CIM online help for additional information.

Architecture Diagram

This section provides a visual explanation of the pieces involved in a Commerce Search installation. For each

server, the diagram shows key ATG modules and other components.

The diagram includes the following ATG databases, each of which includes data for several repositories:

• Management—Versioned data for Content Administration and other non-catalog information.

• Production—Catalog and other deployed asset information for your site. ATG recommends using the

switching database feature described in the ATG Content Administration Programming Guide. If you use

switching, the production database becomes in actuality three databases, two containing switched data and a

third containing information that does not benefit from switching, such as user profiles and Search.

• Staging—Duplicates that part of your production database that is necessary for staging and testing. In a

Commerce Search installation, that includes at least your product catalog and refinements.

If you use ATG Customer Intelligence, you also have a data warehouse, not included in this diagram. See the ATG

Customer Intelligence Installation and Configuration Guide for reporting information.


Servers, Products, and Databases for Commerce Search

Before You Begin

Before you begin installing Search with Commerce, CA, and Merchandising:

• Make sure you have your database information at hand, and necessary drivers are installed.


guide.

• Determine which server you want to designate as the lock manager. In this roadmap, the production server is

used for this purpose. Any server can be used for lock management, or you can dedicate a server to the task.

Basic Installation Steps

This section covers the actual installation of the components and database configuration.


1. Install your application server on all machines that will be used for ATG instances. See the ATG Installation and

Configuration Guide for information on configuring your application server for ATG products.

Note: If you are using standalone Search engines, those do not need to have an application server.

2. Download and install ATG products. Some applications will be included in more than one EAR file during

deployment.

• ATG platform; select all components when installing

The platform includes the DAF.Search.Routing module, which will run on the production and staging

servers using local routing (see the Recommended Search Architecture (page 8) section).

• ATG Merchandising


Installing HTMLFilter (page 28) and Installing PDF Extract (page 28) in this guide).

If using standalone Search engines, see Adding Search Engines (page 29).

3. Create your asset management, staging, and production ATG servers. See the ATG Programming Guide for

information.

Note: This step can be performed using CIM.

4. Configure database(s) and data sources for all applications.


Note that the documentation referenced is extensive; review it carefully before proceeding.

• ATG Platform. See Configuring Databases and Database Access in the ATG Installation and Configuration

Guide.

• ATG Search. See Creating the Search Database Tables (page 43) and Configuring Data Sources for

Search (page 43) in this guide.

• ATG Commerce. See the Configuring and Populating a Production Database chapter of the ATG Commerce

Programming Guide. This includes creating tables, importing data, and configuring data sources for both

the publishing and target databases, and configuring a SwitchingDataSource if using.

• ATG Content Administration. See Setting up the ATG Content Administration Database in the ATG Content

Administration Programming Guide.

• ATG Merchandising. See Configuring a Purchased Content Administration Database in the ATG Merchandising

User Guide.

Asset Management Server Configuration Steps

Configure the asset management server. This server runs Content Administration, Merchandising, and Search

Administration.

1. Configure the /atg/search/service properties for the administration server. See Configuring

SearchSQLRepository Components (page 37) in this guide.

2. Make sure that locking is enabled. The production server will be the ServerLockManager. See Configuring

the Lock Manager (page 32) in this guide.


3. Configure Commerce Components. See Configuring the IndexingOutputConfig Component (page 33) and

Configuring Customization Adapters for Search Merchandising (page 34) in this guide, and also the ATG

Commerce Search Guide.

4. Set up your asset management server. See the Setting Up an Asset Management Server chapter of the ATG

Content Administration Programming Guide.

Staging and Production Server Configuration Steps

Configure the production and staging servers.

1. Create a client application. See the ATG Commerce Programming Guide.

2. Make sure that locking is enabled and that the production server is configured to be the

ServerLockManager. See Configuring the Lock Manager (page 32) in this guide.

3. Configure your Commerce client. See the ATG Commerce Search Guide.

Build and Deploy Applications

For information on building EAR files, see the Assembling Applications section in the Developing and Assembling

Nucleus Applications chapter of the ATG Programming Guide. If using JBoss, you should also refer to the Using the

startDynamoOnJBOSS Script section of the ATG Installation and Configuration Guide.

Note: These steps can be performed using CIM.

See Appendix E: ATG Modules in the ATG Programming Guide for a list of modules and their features.

1. Build and deploy the asset management server EAR file. Include the following modules:

• DCS.Search.Versioned

• SearchAdmin.AdminUI

• DCS-UI.Search

• Publishing

• DCS.UI.Management

Note: If you are going to run Search Administration as part of a standalone EAR, you must do the following:

• Run the ATG Search installer and install a standalone Search engine on the machine to which you are going

to deploy your EAR. See Adding Search Engines (page 29) in this guide.

• Add an engineDir property to the /atg/search/routing/LaunchingService component, and set it

to point to the new Search engine’s <Searchdir>\SearchEngine directory. For example:

engineDir=c:\\ATG\\ATG9.4\\Search9.4\\SearchEngine

2. Build and deploy the production and staging server EAR files. Include the following modules:

• DCS.Search

• DCS.PublishingAgent

• DAF.Search.Routing

• DafEar.Admin


Post-Deployment Configuration

The following tasks are performed in your running ATG applications.

1. Use Content Administration to create your deployment topology, and initialize your deployment targets by

doing a full deployment. See the ATG Content Administration Programming Guide.

Note: If you are going to use Refinement Configurations (aka Facets), include the RefinementRepository in

your repository mappings for your production and staging deployment targets.

2. After deploying your catalog from Content Administration to the production server, make sure the Product

Catalog update and Catalog Maintenance services are run (this step is necessary in order to index your

catalog). See the ATG Commerce Programming Guide.

3. Use the ATG Business Control Center to access ATG Search Administration. See Accessing Search

Administration (page 46) in this guide.

4. In Search Administration, create a Search project and add content and any customizations, such as languages

and custom dictionaries. See the ATG Search Administration Guide. Use the following settings when you add

the content:

• Content Type—ATG Repository

• IndexingOutputConfigPath—/atg/commerce/search/ProductCatalogOutputConfig

• Location—Remote

Set the Host Machine and Port as appropriate for the content location.

At this point, you can use the default environments to estimate the size of your index and evaluate whether

you have dedicated sufficient resources for indexing and answer serving.

Note: A Search project bears no relationship to a Content Administration project. The Search project is a

persistent item that defines the content you want to include in your index, what type of index you want to

create and any customization data used during indexing. Search does not use workflows.

5. If using standalone Search engines, add those hosts to your Search environment. See the ATG Search

Administration Guide. Search environments associate a project with the physical resources that project uses to

index content and serve answers.

6. Index your catalog, using the “Full” indexing option.

7. Configure Merchandising as described in “Structuring the Search Configuration Tree” and the sections that

follow in the ATG Merchandising User Guide.

Testing Your Installation

To test your installation, you can use the Search Query Console (see the Sample Application section of the ATG

Commerce Search Guide) or Merchandising (see the ATG Merchandising User Guide). Use the following steps:

1. Deploy your content.

2. Index the content.

3. On your production site, make sure you get search results

4. Use Merchandising to change the catalog.


5. Deploy the changes.

6. Reindex the content.

7. Verify the change on your production site.

Search with Knowledge and Self Service Roadmap

The goal of this roadmap is to install and configure Search in an integrated environment with ATG Knowledge

and Self Service.

You will need at least three ATG servers for this product combination:

• One runs Search Administration, Content Administration, and can also run Response Management if you are

using that product; this is referred to as the asset management server in this roadmap.

• Another runs the Service Administration application and Knowledge, and is called the agent server.

• A third server runs Self Service, and is referred to as the production server.

The servers can be set up on separate machines, or could run as separate instances on one machine if it has

plenty of memory (the latter option is not recommended for a live site, but you may use such a configuration for

evaluation or testing purposes). You may also want to dedicate resources for additional Search engines.

Note: CIM is not yet available for use with a Knowledge/Self Service installation.

Architecture Diagram

This section provides a visual explanation of the pieces involved in a Search installation with Knowledge. In

addition to the three servers, the diagram includes the following ATG databases:

• Management—Versioned data for Content Administration, Search Administration, and other non-catalog

information.

• Production—Catalog and other deployed asset information for your site. ATG recommends using the

switching database feature described in the ATG Content Administration Programming Guide. If you are using

switching, the production database becomes in actuality three databases, two containing switched data

and a third containing information that does not benefit from switching, such as user profiles and Search

configurations for Merchandising.

• Agent—Versioned and non-versioned repositories including user profiles, internal and external user

segments, solutions, content groups, Search routing, Ticketing and topics.

If you are using ATG Customer Intelligence, you will also have a data warehouse, not included in this diagram.

See the ATG Customer Intelligence Installation and Configuration Guide for an overview.


Search with Knowledge

Before You Begin

Before you begin installing Search with Knowledge:



guide.

• Determine which server you want to designate as the lock manager. Any of the named servers discussed can

be used for lock management, or you can dedicate a server to the task.

Basic Installation


1. Install your application server on all machines that will be used for ATG instances. See the ATG Installation and


Note: If you are using standalone Search engines, those machines do not need to have an application server.

2. Download and install ATG products.





• ATG Service; select ATG Service Administration and Knowledge.

You can also install Response Management if you are planning to use that product. See the ATG Response

Management Installation and Configuration Guide for information.


3. Create your administration, agent, and production ATG servers. See the ATG Programming Guide for

information.

4. Configure database(s) and data sources for all applications. Note that the documentation referenced is

extensive; review it carefully before proceeding.


Guide.



• ATG Knowledge. See Configuring Databases for ATG Service and Configuring the ATG Service Servers in the ATG

Service Installation and Configuration Guide.

Server Configuration Steps

Configure the administration server. This server runs Search Administration and Content Administration.



2. Configure lock management for the administration server. See Configuring the Lock Manager (page

32) in this guide and Configuring the Lock Manager and SQL Repository in the ATG Service Installation and

Configuration Guide.

3. Run the create-atgservice-searchproject script against your Search database as described in the

Configuring Search Environment section in the ATG Service Installation and Configuration Guide.



5. Check that your data sources are properly configured, and configure components as described in the Using

ATG Search with ATG Service chapter in the ATG Service Installation and Configuration Guide.

Configure the production server. Content Administration publishes data to this server, which also runs your

customer-facing applications.

1. Create your client application.

2. Configure lock management for the production server. See Configuring the Lock Manager (page 32)

in this guide and Configuring the Lock Manager and SQL Repository in the ATG Service Installation and

Configuration Guide.

3. Check that your data sources are properly configured, and configure components as described in the Using

ATG Search with ATG Service chapter in the ATG Service Installation and Configuration Guide.

Configure the agent server. Search Routing runs on this server. See Configuring the Agent Server in the ATG Service

Installation and Configuration Guide.

http://www.atg.com/repositories/ContentCatalogRepository_en/manuals/ATG9.2/arminstallconfig/index.html

http://www.atg.com/repositories/ContentCatalogRepository_en/manuals/ATG9.2/arminstallconfig/index.html



Before continuing with configuration, you must build and deploy your applications.

1. Build and deploy the administration server EAR file. Include the following modules:

• DafEar.Admin SearchAdmin.AdminUI PubPortlet Service.ExternalUsers







2. Build and deploy the production server EAR file. Include the following modules:

• DafEar.Admin ARF.Base Service.SelfService

3. Build and deploy the agent server EAR file. Include the following modules:

• DafEar.Admin ARF.Base ARF.WSCP Service.Knowledge Service.admin

Service.SampleCRMClient Service.CRMIntegration







3. In Search Administration, add content to your project as described in the Configuring Search Environment

section in the ATG Service Installation and Configuration Guide.

Search with Commerce, Content Administration, Merchandising and Customer

Intelligence

The goal of this roadmap is to install and configure Search in an integrated environment with ATG Commerce,

Content Administration, Merchandising, and Customer Intelligence. It also includes the use of standalone Search

engines.

You will need four ATG instances for this product combination:

• One runs the administrative interfaces, including Merchandising and Search Administration; this is referred to

as the asset management server in this roadmap.

• The second runs your Commerce site for testing, and is referred to as the staging server.

• The third instance runs your live site, and is referred to as the production server.

• Finally, you should have an environment dedicated to running the data loaders for the ACI data warehouse,

which is the data loader server.


The servers can be set up on separate machines, or could run as separate instances on one machine if it has

plenty of memory. The latter option is not recommended for a live site, but you may use such a configuration for

evaluation or testing purposes. You may also want to dedicate resources for additional Search engines. For an

architecture diagram, see the ATG Multiple Application Integration Guide.

Note that a staging server is not required for this product combination, though it is recommended. Your

configuration may also include a preview server.

Some of the steps in this procedure can be performed using ATG’s CIM tool. These steps are noted in the

roadmap. See Configuring Search with CIM (page 25) and the CIM online help for additional information.

Before You Begin

Before you begin installing Search with Commerce, CA, and Merchandising:



guide.

• Determine which server you want to designate as the lock manager. In this roadmap, the production server is

used for this purpose. Any server can be use for lock management, or you can dedicate a server to the task.

Basic Installation Steps


1. Install your application server on all machines that will be used for ATG servers. See the ATG Installation and


Note: If you are using standalone Search engines, those do not need to have an application server.

2. Download and install ATG products. Some applications will be included in more than one EAR file during

deployment.


The platform includes the DAF.Search.Routing module, which will run on the production and staging

servers using local routing (see the Recommended Search Architecture (page 8) section).

• ATG Merchandising



• ATG Customer Intelligence. At this time you should configure the web server, create the content store, etc.

See Installing ACI in the ATG Customer Intelligence Installation and Configuration Guide.


3. Install reports and metadata for ATG Customer Intelligence. See Importing Reports and Metadata in the ATG

Customer Intelligence Installation and Configuration Guide.

4. Create your asset management, staging, production, and data loader ATG servers. See the ATG Programming

Guide for information.


5. Configure database(s) and data sources for all applications.



Note that the documentation referenced is extensive; review it carefully before proceeding.


Guide.



• ATG Commerce. See the Configuring and Populating a Production Database chapter of the ATG Commerce

Programming Guide. This includes creating tables, importing data, and configuring data sources for both

the publishing and target databases, and configuring a SwitchingDataSource if using.

• ATG Content Administration. See Setting up the ATG Content Administration Database in the ATG Content

Administration Programming Guide.

• ATG Merchandising. See Configuring a Purchased Content Administration Database in the ATG Merchandising

User Guide.

• ATG Customer Intelligence. See Configuring ACI

Asset Management Server Configuration Steps

Configure the asset management server. This server runs Content Administration, Merchandising, and Search

Administration.



2. Make sure that locking is enabled. The production server will be the ServerLockManager. See Configuring

the Lock Manager (page 32) in this guide.

3. Configure Commerce Components. See the ATG Commerce Search Guide.



Staging and Production Server Configuration Steps

Configure the production and staging servers.

1. Create a client application. See the ATG Commerce Programming Guide.

2. Make sure that locking is enabled, and that the production server is configured to be the

ServerLockManager. See Configuring the Lock Manager (page 32) in this guide.

3. Configure your Commerce client. See the ATG Commerce Search Guide.

Data Loader Server Configuration Steps

Configure your data loader server as described in the Configuring the Data Warehouse Loader Server section in

the ATG Customer Intelligence Installation and Configuration Guide.


For information on building EAR files, see the Assembling Applications section in the Developing and Assembling

Nucleus Applications chapter of the ATG Programming Guide. If using JBoss, you should also refer to the Using the

startDynamoOnJBOSS Script section of the ATG Installation and Configuration Guide.


Note: These steps can be performed using CIM.

See Appendix E: ATG Modules in the ATG Programming Guide for a list of modules and their features.

1. Build and deploy the asset management server EAR file. Include the following modules:

• DCS.Search.Versioned

• SearchAdmin.AdminUI

• DCS-UI.Search

• Publishing

• DCS.UI.Management

• ARF.base

• ARF.BIZUI

• ARF.WSCP







2. Build and deploy the production and staging server EAR files. Include the following modules:

• DCS.Search


• DAF.Search.Routing

• DafEar.Admin

• ARF.base

3. Build and deploy the data loader server EAR file. Include the following modules:

• B2CCommerce

• DCS.DW.Search


• SearchAdmin.datawarehouse

4. On the production server, start the /atg/commerce/search/ProductCatalogOutputConfig component

if it is not already running. This component is used for repository indexing, and should be started

automatically.

If you’re using triggered indexing (see Synchronizing Versioned Repository Deployment and Indexing (page

42)), the synchronization component will cause any IndexingOutputConfig components it


is configured to monitor to start up on the asset management instance. To start the component

automatically, you can add the IndexingOutputConfig components to an Initial.properties file or to

RmiServer.properties. For example:

/atg/dynamo/server/RmiServer.properties

exportedServices+=/atg/commerce/search/ProductCatalogOutputConfig





Note: If you are going to use Refinement Configurations (aka Facets), include the RefinementRepository in

your repository mappings for your production and staging deployment targets.

2. After deploying your catalog from Content Administration to the production server, make sure the Product

Catalog update and Catalog Maintenance services have been run (this step is necessary in order to index your

catalog). See the ATG Commerce Programming Guide.



4. In Search Administration, create a Search project and add content. See the ATG Search Administration Guide.

Use the following settings when you add the content:

• Content Type—ATG Repository

• IndexingOutputConfigPath—/atg/commerce/search/ProductCatalogOutputConfig

• Location—Remote

Set the Host Machine and Port as appropriate for the content location.

At this point, you can use the default environments to estimate the size of your index and evaluate whether

you have dedicated sufficient resources for indexing and answer serving.

Note: A Search project bears no relationship to a Content Administration project. The Search project is a

persistent item that defines the content you want to include in your index, what type of index you want to

create and any customization data used during indexing. Search does not use workflows.

5. If using standalone Search engines, add those hosts to your Search environment. See the ATG Search

Administration Guide. Search environments associate a project with the physical resources that project uses to

index content and serve answers.

6. Index your catalog, using the “Full” indexing option.

7. Configure Merchandising as described in Structuring the Search Configuration Tree and the sections that follow

in the ATG Merchandising User Guide.

Testing Your Installation

To test your installation, you can use the Search Query Console (see the Sample Application section of the ATG

Commerce Search Guide) or Merchandising (see the ATG Merchandising User Guide). Use the following steps:

1. Deploy your content.

2. Index the content.


3. On your production site, make sure you get search results

4. Use Merchandising to change the catalog.

5. Deploy the changes.

6. Reindex the content.

7. Verify the change on your production site.

Configuring Search with CIM

ATG’s Configuration and Installation Manager (CIM) helps to simplify ATG product configuration by walking

you through the required steps. This ensures that all necessary steps are completed and are done in the correct

order. You can use CIM to get a working installation running quickly and easily, but keep in mind that you will

most likely end up doing further configuration on your installation as your project evolves.

CIM handles the following configuration steps:

• Creates data sources according to the database connection information you supply, including those needed

for the ACI data warehouse.

• Creates database tables and imports initial data, including those for the ACI data ware house.

• Creates and configures ATG servers, including a lock manager and a data warehouse loader server.

• Assembles your application EAR files for each ATG server.

• Deploys EAR files to your application server.

See Appendix C, Search CIM Details (page 57) for a full listing of the database scripts and configuration files

CIM uses. See the CIM help and the ATG Installation and Configuration Guide for additional information on CIM.

To configure Search using CIM, do the following:

1. Install your application server.

2. Install your applications.

3. To start CIM, go to <ATG9dir>/home/bin and type:

cim

4. Select the products you want to configure.

5. Select add-ons, including Search.

6. Continue through CIM according to the prompts. Type H at any prompt for additional information.

Note that CIM does not configure the following:

• Standalone Search engines

• Any components for a staging environment to be used with Search, including:


• Your Content Administration topography. See the Setting Up an Asset Management Server chapter of the ATG


• Your Commerce store and IndexingOutputConfig component. See the ATG Commerce Search Guide. CIM

does handle some configuration options, such as whether you plan to index by product or by SKU, but you

will most likely have to do additional configuration.

• Automatic startup for the ProductCatalogOutputConfig components on either production or staging

servers. You must manually configure these components to start automatically.

• Configuration for deployment-triggered indexing (see Synchronizing Versioned Repository Deployment and

Indexing (page 42)). You must manually configure these components.

• Your Search project, indexing rules, and customizations. See the ATG Search Administration Guide.

4 Installing ATG Search 27

4 Installing ATG Search

This chapter explains how to install ATG Search and its related components, and how to configure your

installation.

Review this entire installation guide before beginning your installation. This chapter includes the following

sections:

Installing Search (page 27)

Installing HTMLFilter (page 28)

Installing PDF Extract (page 28)

Adding Search Engines (page 29)

Configuring a Multi-Server Installation (page 31)

Configuring Data Sources for Search (page 43)

Creating the Search Database Tables (page 43)

Configuring Search for Customer Intelligence (page 46)

Accessing Search Administration (page 46)

Installing Search

This section describes the actual installation process of ATG Search.

To install ATG Search:

1. Download the ATG Search installation executable.

2. Start the installer.

3. On the start page, click Next to begin the installation.

4. Read the license agreement. Select “I accept the terms of the license agreement” and click Next.

5. Select Search Administration + Search Engine for the installation type. Click Next.

Enter an installation location, or accept the default. Click Next.

28 4 Installing ATG Search

6. Select locations for product icons and shortcuts.

7. Review your selections, and click Install to begin the installation.

8. Enter a Deployment Share folder. This is the scalable, shared directory you created before beginning the

installation.

9. When the installation is finished, click Done.

Installing HTMLFilter

If the content you want to make searchable includes Word files and other rich-text formats, download and install

the HTML Filter component for ATG Search. This product only appears on the product download page if you

have purchased it.

1. Download the ATGSearchHtmlFilter executable.

2. Double-click the installer icon to start installing.


4. Accept the license agreement, and click Next.

5. Select an installation directory, or accept the default, and click Next. The directory must include a valid Search

installation.

6. Click Install to install the component.

No additional configuration is necessary to use the component.

Installing PDF Extract

If the content you want to make searchable includes documents in PDF format, download and install the PDF

Extract component for ATG Search. This product only appears on the product download page if you have

purchased it.

1. Download the ATGSearchPDFExtract executable.



4. Accept the license agreement, and click Next.

5. Select an installation directory, or accept the default, and click Next. The directory must include a valid Search

installation.

6. Click Install to install the component.

No additional configuration is necessary to use the component.


Adding Search Engines

A Search engine is a piece of software that performs the work of either indexing content or answering queries.

Engines are managed through Search Administration and are started and shut down automatically through a

service running on the engine location.

Note: A given partition on a given host should only have one Search engine associated with it. In order to add

engines to support that partition, additional hardware is required.

The process of adding engines is most easily understood through an example.

Say that you have installed Search and used the Search Administration’s estimation tool to determine the size of

your index. It is going to be large, with four physical partitions. You have two options:

• Run Search Administration on hardware robust enough to support four engines for answering queries in

addition to performing indexing tasks.

• Add hardware resources that will be dedicated to answering queries.

The first option does not require any additional installation work to add the engines. In Search Administration,

you create an indexing environment and specify the machine on which you are running Search Administration

as the host. Engines will be created as needed on this machine, up to the number specified in the environment

configuration. This is not a recommended solution, however, since indexing and answer serving functions could

compete for resources.

Instead, you add two machines to your Search installation. Each has four cores, providing for a robust

answering configuration. The machine on which you are running Search Administration will continue to handle

indexing. You run the ATG Search installer once on each machine, following the steps described below. In

Search Administration, you create a new environment, give it the type “production” and associate your two

new machines with that environment (see the ATG Search Administration Guide for detailed information on

environment configuration). When your site is up and answering user queries, engine instances will be started as

needed, up to the limit configured on each machine.

The following diagram summarizes the procedures involved. This diagram uses indexing engines as an example;

to add engines dedicated to server query answers instead, you would create a new environment in Search

Administration (see Step 2 in the diagram).


Note: All Search engines in your installation, including the indexing engine, must run on the same operating

system with the same bit size.

The Search Administration installation includes the Search engine and a default environment, which can be

used for indexing. For anything other than a basic evaluation environment with a very small index, you will

need additional, standalone Search engines on separate hardware. If you have multiple physical partitions in

your index, you need one Search engine per partition. See the Estimating Index Size section of the ATG Search

Administration Guide for information on sizing your index.

These standalone Search engines run on dedicated hardware; you must add hardware and install the Search

engine on them. Engines are in turn associated with Search environments. The environments are configured in

Search administration.

Standalone Search engines run without an ATG installation or application server. To add a standalone Search

engine to your installation:

1. Download the ATG Search installation executable.



4. Read the license agreement. Select “I accept the terms of the license agreement” and click Next.

5. Select Search Engine Only for the installation type.

6. Select an installation location.

7. Review your selections, and click Install to begin the installation.

8. On the machine where you have installed the standalone engine, navigate to the Search engine installation

and execute the <SearchEngineDir>/SearchAdmin/bin/startRemoteLauncher.sh or .bat script. The

startRemoteLauncher script starts up a launcher service, which is then used by the routing component to

start Search engines on that machine. Under normal use, you do not need to manually start or stop Search

engines.

Note: This step is required only for stand-alone Search engines. Engines running local to your Search

Administration installation do not need this script.

The startRemoteLauncher script includes two optional parameters –p and –o, which allow you to specify

the ports used for remote method invocation (RMI). For example:

startRemoteLauncher.bat -p 8860 -o 8861

If you do not specify a port, the second port is chosen randomly. The default for the first port is always 8860.

9. If you are adding engines for indexing purposes, see the Configuring Remote Indexing Engines (page 31)

section of this guide for additional steps.

In Search Administration, you can now create an environment that includes this machine. When Search indexes

content (if an indexing environment) or serves answers (if a staging or production environment), the Routing

module starts engine instances on that machine as needed. See the Managing Search Environments section of

the ATG Search Administration Guide for information on creating Search environments.

When you deploy a new index, the Search engines serving the old index continue to answer query requests until

new engines are started for the new index. Once the new engines are started, queries are directed to them by

the Routing module, and the old ones are shut down.


Configuring Remote Indexing Engines

If you are running Search engine instances on machines other than the Search Administration machine, and you

want to use those instances in an indexing environment, additional configuration is required.

In order to create a full index (see Note below) the indexing engine needs a clean partition, a file from which

all indexes are created. If the engine is not local to the Search Administration installation, you must make it

available. The clean partition is located in the <Searchdir>\SearchEngine\operatingsystem\data\

directory.

To make a clean partition available:

1. Either move the clean partition into your deployment share folder, or create a new share with read access for

the Search engine (for example, \\mymachine\sharedData).

2. Create a RoutingSystemService.properties file in your <ATG9dir>\home\localconfig\atg\search

\routing directory to point to the partition in the shared directory, using the full network path. The file

should contain a cleanPhysicalPartitionPath property as shown in the following examples.

Windows:

cleanPhysicalPartitionPath=\\\\server\\deploymentshared\\initial.index

UNIX:

/mount_location/deploymentshared/initial.index

The Search engines must also be able to access all directories that contain content to be indexed. When

indexing a file system, the Search engines receive paths to the files, for example, D:\CustomerDocs

\whitepaper.doc. If the Search engine is not on the same machine as Search Administration, then the D drive

is not accessible, and the engine cannot open the file to index it. In that case, you should share the content

location, for example as \\some_machine\CustomerDocs.

Note: Even if you use incremental indexing, you should recreate the full index every so often; see the ATG Search

Administration Guide for indexing suggestions.

Configuring a Multi-Server Installation

The Search installer assumes that all Search modules are running locally, as with the evaluation example in the

section; in real use, this will never be the case. This section of the guide addresses configuration that must be

done in order for Search to communicate with remote Search components, or with other ATG products. See the

Search Installation Roadmaps (page 11) section for some common multi-server arrangements.

Note: Before you begin, review the documentation for each of the products you plan to configure.

The sections that follow explain the configuration steps involved. Configure all components in the dynamo/

home/servers/servername/localconfig/ configuration layer. See “Creating Additional Dynamo Server

Instances” in the ATG Installation and Configuration Guide for information on creating ATG servers.

Configuring Search Routing

Routing refers to a group of services responsible for sending indexing and searching requests to Search engines

and processing the responses.


The default Search configuration assumes that all Search modules are running locally. In production, you will

have routing modules running in other locations (for example, in your client application). You must perform the

following configuration steps:

1. On each server on which you plan to run DAF.Search.Routing, configure the shared deployment directory.

See Configuring the DeployShare Directory (page 32).

2. Set the atg/search/routing/repository/SearchConfigurationRepository/

subscriberRepository property as shown:

subscriberRepository=/atg/Search/service/SearchSQLRepository

3. Configure server and client lock managers between your servers. See the Locked Caching section of the ATG

Repository Guide for information.

Configuring the DeployShare Directory

Search Administration and all Search engines must have access to the deployment share directory in order

to deploy and search indexes. This is a single, scalable, shared directory where master copies of indexes are

stored. Your installation can have only one deployment share. This directory should ideally be located on a high-

performance drive separate from the Search Administration machine. For all machines running Search engines,

the deployshare directory must be mounted at the same location, and the path must be exactly the same for all

components accessing this directory.

On each server on which you plan to run the DAF.Search.Routing module, configure the shared deployment

directory. To do this, change the deployShare property in the /atg/search/routing/LaunchingService

component on each server. Make sure the deployment directory is visible to all of the servers running Search

Engines. For example, a Windows path might be:

deployShare=\\\\yourSharedDirectory\\yourDeployShareDirectory

Configuring the Lock Manager

Configure server and client lock managers between your servers. The lock manager is used for locked caching

mode (see the Locked Caching section of the ATG Repository Guide).

Both Search Administration and Knowledge automatically point their SearchClientLockManager

components to the ClientLockManager_production component; SearchClientLockManager requires

no further configuration. If you are using other ATG applications with Search, you may need to perform this

configuration manually. You must also configure the following components:

• /atg/dynamo/service/ClientLockManager component on the production server

• /atg/dynamo/service/ClientLockManager_production component on the asset management server

• /atg/dynamo/service/ClientLockManager_production component on the staging server (if using)

In each of those components, perform the following configuration:

useLockServer=truelockServerPort=production_server_portlockServerAddress=production_host_name_or_IP


The address and port specified for this component on the asset management and staging servers must match

that of the ClientLockManager on the production instance.

Configuring the IDGenerator

An IDGenerator generates IDs for repository items. There should be only one per repository.

On the asset management and agent servers, by default the /atg/search/service/SearchIdGenerator

component points to the /atg/dynamo/service/IdGenerator_production component, which is the ID

generator for the production server. This ensures that Search Administration and all Search client applications

use the same ID generator for the Search repositories.

If you are adding a staging server to your configuration, you may need to configure this component as shown:

/atg/search/service/SearchIdGeneratorcomponentPath=/atg/dynamo/service/IdGenerator_production

Configuring the IndexingOutputConfig Component

This guide addresses only certain basic configuration options for IndexingOutputConfig components. See

the ATG Commerce Search Guide for detailed information on these components. By default ATG search includes

an instance of this component called ProductCatalogOutputConfig, which is intended for use in indexing

ATG Commerce catalogs.

To ensure that this component is started automatically, you must add your ProductCatalogOutputConfig to

the list of exported services in the /atg/dynamo/server/RmiServer.properties file (if you are using CIM,

this step is done automatically). For example:

exportedServices+=/atg/commerce/search/ProductCatalogOutputConfig

Additional configuration depends on your system architecture:

Architecture IndexingOutputConfig Component Configuration Required

Indexing production repository

from the asset management

instance

None

Indexing production repository

from the production instance

On the asset management instance, configure the following:

/atg/commerce/search/ProductCatalogOutputConfig

targetName=Production

The targetName value is the CA deployment target name for the

production instance

Indexing production and

staging repositories from the

asset management instance

None


Architecture IndexingOutputConfig Component Configuration Required

Indexing production and

staging repositories from the

asset management instance

On the asset management instance, configure the following:

/atg/commerce/search/ProductCatalogOutputConfig

targetName=Production

The targetName value is the CA deployment target name for the

production instance.

On the asset management server, configure the following:

/atg/commerce/search/ProductCatalogOutputConfig_staging

targetName=Staging

The targetName value is the CA deployment target name for the staging

instance.

For all servers, make sure that your IndexingOutputConfig component is started automatically (if you are

using CIM, this step is done automatically). You can do this by adding it to the initialServices list as shown:

/atg/commerce/InitialinitialServices+=\ /atg/commerce/search/ProductCatalogOutputConfig_staging

If you are using a staging server, you must also add the ProductCatalogOutputConfig_staging component

to the /atg/search/repository/IndexingDeploymentListener on the asset management server in order

for synchronized indexing (see Synchronizing Versioned Repository Deployment and Indexing (page 42)) to

work on that instance.

indexingOutputConfigs+=/atg/commerce/search/ProductCatalogOutputConfig_staging

Configuring Customization Adapters for Search Merchandising

The ATG platform uses customization adapters to submit post-indexing customization data to ATG Search. Each

customization adapter is a Nucleus component that is invoked by ATG Search Administration when it runs an

indexing job. When you set up a project in ATG Search Administration for indexing your Commerce catalog, you

can select the customization adapters to include in the project as part of specifying the indexing content.

There are three customization adapters commonly used to submit post-indexing customization data for ATG

Commerce sites:

• /atg/commerce/search/refinement/CatalogRefineConfigAdapter – Manages the process of

generating the refinement configuration files used for Dynamic Search and Navigation and submitting them

to ATG Search.

• /atg/commerce/search/config/CatalogRankConfigAdapter – Manages the process of generating the

search configuration files used for Search Merchandising and submitting them to ATG Search.

• /atg/commerce/search/config/SearchUpdateAdapter – Manages the process of collecting updated

inventory information used for Search Merchandising and submitting it to ATG Search.


Registering Adapters

To make the customization adapters available in ATG Search Administration, they must be registered with

the /atg/search/adapter/customization/CustomizationAdapterRegistry component. This

component has a nameToNucleusPath property that lists the registered adapters (if you are using CIM, this

step is done automatically). This property is a Map in which each key is the display name of an adapter and the

corresponding value is the actual Nucleus component.

The CustomizationAdapterRegistry component is in the DAF.Search.Index module, but by default

nameToNucleusPath is not set there. The DCS.Search.Index module adds the three ATG Commerce

customization adapters to the Map:

nameToNucleusPath+=\select_custsource_type.repository.rank_config=/atg/commerce/search/config/ CatalogRankConfigAdapter,\select_custsource_type.repository.staging_rank_config=/atg/commerce/search/config/ CatalogRankConfigAdapter_staging,\select_custsource_type.repository.search_update=/atg/commerce/search/config/Search UpdateAdapter,\select_custsource_type.repository.staging_search_update=/atg/commerce/search/ config/SearchUpdateAdapter_staging,\select_custsource_type.repository.refine_config=/atg/commerce/search/refinement/ CatalogRefineConfigAdapter,\select_custsource_type.repository.staging_refine_config=/atg/commerce/search/ refinement/CatalogRefineConfigAdapter_staging

In this configuration, each Map key (such as select_custsource_type.repository.rank_config), is a

resource bundle key that represents the displayName property of the corresponding adapter component,

rather than being the display name itself. Using the resource bundle key allows you to modify or translate the

displayName value without affecting the registration of the component.

Configuring Adapters

The customization adapters are invoked on the ATG Search Administration environment, but the processes they

execute run on the Commerce site environment. Therefore, you must have separate sets of adapter components

on each environment, and configure them to communicate over RMI.

The CatalogRefineConfigAdapter, CatalogRankConfigAdapter, and SearchUpdateAdapter

components are actually generic references that you configure to point to other components:

• On the Commerce site, these components point to local customization adapters that actually run the

processes.

• On the Search Administration environment, these components point to proxies that communicate remotely

with the customization adapters running on the Commerce site.

Configuring the Adapters on the Production Server

The customization adapters are configured by default, so you typically do not need change the configuration on

the Commerce site.

If for some reason you need to configure a customization adapter on the Commerce site, set its componentPath

property to the Nucleus pathname of the corresponding local adapter:

• For the CatalogRefineConfigAdapter, set the componentPath property to /atg/commerce/search/

refinement/LocalCatalogRefineConfigAdapter.


• For the CatalogRankConfigAdapter, set the componentPath property to /atg/commerce/search/

config/LocalCatalogRankConfigAdapter.

• For the SearchUpdateAdapter, set the componentPath property to /atg/commerce/search/config/

LocalSearchUpdateAdapter.

Configuring the Adapters on the Asset Management Server

In the asset management environment, set up the proxies that communicate with the customization

adapters on the Commerce environment. First, configure the CatalogRefineConfigAdapter,

CatalogRankConfigAdapter, and SearchUpdateAdapter components to point to their corresponding

remote proxies:

• For the CatalogRefineConfigAdapter, set the componentPath property to /atg/commerce/search/

refinement/RemoteCatalogRefineConfigAdapter.

• For the CatalogRankConfigAdapter, set the componentPath property to /atg/commerce/search/

config/RemoteCatalogRankConfigAdapter.

• For the SearchUpdateAdapter, set the componentPath property to /atg/commerce/search/config/

RemoteSearchUpdateAdapter.

Now configure the RemoteCatalogRefineConfigAdapter, RemoteCatalogRankConfigAdapter, and

RemoteSearchUpdateAdapter components to communicate with the adapters running in the production

server. Set the enabled property of these components to true, and set the remoteHost and remotePort

properties to the machine name and RMI port number of the ATG instance on which the Commerce site

application is running (if you are using CIM, this step is done automatically). For example:

enabled=trueremoteHost=production.host.comremotePort=28860

If your installation includes a staging server, you will need to give the asset management server access to those

configuration adapters as well. Configure the following components as indicated:

/atg/commerce/search/config/CatalogRankConfigAdapater_stagingcomponentPath=RemoteCatalogRankConfigAdapter_staging

/atg/commerce/search/config/RemoteCatalogRankConfigAdapter_stagingenabled=trueremoteHost=staging.host.comremotePort=18860

/atg/commerce/search/config/SearchUpdateAdapter_stagingcomponentPath=RemoteSearchUpdateAdapter_staging

/atg/commerce/search/config/RemoteSearchUpdateAdapter_stagingenabled=trueremoteHost=staging.host.comremotePort=18860


Invoking Adapters

Each time a catalog indexing job runs, ATG Search Administration invokes the specified post-indexing

customization adapters after the indexing itself is complete. Doing this ensures that ATG Search has up-to-date

search refinements, search configurations, and inventory information (assuming you specify the appropriate

adapters).

Depending on the needs of your site, you may want to run the customization adapters more frequently than

you re-index the product catalog. This is particularly true if your inventory information changes rapidly, and your

search configurations include rules based on inventory status. For example, for rules that exclude out-of-stock

items, you want to make sure the data that triggers these rules is up to date.

When you set up scheduled indexing jobs for your project in the ATG Search Administration UI, you can also

set up post-indexing customizations jobs and schedule them to run more frequently than the indexing jobs.

For more information about creating and scheduling post-indexing customizations jobs, see the ATG Search

Administration Guide.

Configuring SearchSQLRepository Components

The SearchSQLQLRepository and SearchSQLRepositoryEventServer components are used by the

subscriber table needed for GSA distributed cache invalidation.

These components are located in the DAF.Search.Base module, in the atg/search/service component

directory. By default, these components point to the local, default JDBC connection and the related services. If

your environment has both production and internal-facing ATG instances, you must change these components

to point to the _production versions of the target components on the internally-facing machines.

Note: ATG Knowledge sets these components to point to their _production equivalents automatically, and you

do not need to configure them further.

Component Default Setting Production Setting

/atg/search/service/

SearchSQLRepository

/atg/dynamo/service/

jdbc/

SQLRepository

/atg/dynamo/service/jdbc/

SQLRepository_production

/atg/search/service/

SearchSQLRepositoryEventServer

The

SQLRepositoryEventServer

used by Search. Should

always match the data

source configuration of

SearchJTDataSource

/atg/dynamo/server/

SQLRepositoryEventServer

/atg/dynamo/server/

SQLRepositoryEventServer_production

Note: There should only be one SQLRepositoryEventServer per data source. It’s important that /atg/

dynamo/server/SQLRepositoryEventServer_production on the asset management server and /atg/

dynamo/server/SQLRepositoryEventServer on the production server are connected to the same database

account.


If you want to use something other than the production server as the target, clone the _production

components and configure them to point to components on your alternative server. Most installations should

not require this.

Indexing Versioned Repositories

This section addresses configuration options for indexing versioned data managed by ATG Content

Administration, such as a product catalog. Repository indexing relies on the IndexingOutputConfig

component. This installation guide discusses this component in terms of configuring your installation

architecture; for other information on this component, see the ATG Commerce Search Guide.

Selecting a Data Loading Location

You will have to decide whether you want data loading to run on your asset management server or your

production server (see the Loading the Data into ATG Search section of the ATG Commerce Search Guide for

information on this process). Consider the following factors when making your decision:

• Size of your site. The main benefit to loading data on the asset management server is that it relieves load

on the production server; asset management-side loading may be appropriate if you have a relatively small

site. Alternatively, data loading on production is more appropriate if you have a large site and can dedicate

additional non-DRP servers to handle the load.

• Data availability. You may have data that is available to production, but not to the asset management server,

such as inventory information.

When you add repository content to a Search project in Search Administration, you specify local or remote

location. If Search Administration is running on your asset management server, select Local to load data on the

asset management server. To load data on a production server, select Remote, and specify a production server as

the host. See the ATG Search Administration Guide for details on Search projects.

The two diagrams that follow show the arrangement of components in both configurations. For simplicity, these

diagrams omit the staging server and database.


Data Loading on the Asset Management Instance

Notice the connector in the second diagram that runs between the Asset Management Instance and the

IndexingOutputConfig component on the Production Instance:


Data Loading on the Production Instance

Using Incremental Loading with ATG Content Administration

If you are using incremental indexing of your versioned content, whenever you modify and redeploy your

content, the incremental loading system needs to be notified about the changes in order to reflect them in

the next incremental index. Therefore, an IndexingOutputConfig component must run in the ATG Content

Administration environment (asset management server) and listen for change events on the deployment

repository (production server).

You can actually load the content using an IndexingOutputConfig component running on either server,

as explained in the previous section. If you want to load content on the production server, configure the

targetName property of the IndexingOutputConfig component on the management server to the name of

the Content Administration deployment target. However, if you are loading content on the asset management

server, you must not configure this property, or loading will not work.


If you are using a secure product catalog (for instance, as part of a B2B Commerce installation), you must change

the indexing configuration on the asset management server, so that it can listen for change events on the on the

deployment target repository. By default, this is configured to point to the non-secure catalog repository. To do

this, in the /atg/commerce/search/IndexedItemsGroup.properties file, change the following property:

repository=/atg/commerce/catalog/ProductCatalog_production

The new value should be as shown:

repository=/atg/commerce/catalog/SecureProductCatalog

Configuring the IndexingOutputConfig Component for Versioned Repositories

If you are indexing a versioned repository and are running your indexing process on the asset management

server, make sure that the IndexingOutputConfig component and the related /atg/commerce/search/

IndexedItemsGroup are configured to point to the production repository, rather than the versioned repository.

If this configuration is incorrect, your index may not accurately reflect your published repository. This example

describes how things could go wrong:

1. A project is checked in to Content Administration, and the IndexingOutputConfig component on the asset

management server records the change in the incremental item queue.

2. The project is deployed to production.

3. Another project is checked in, and these changes are also recorded in the incremental item queue.

4. When incremental indexing runs, both sets of changes are processed, although the second set has not

actually been deployed to production.

The result is an index that does not accurately reflect your repository, in ways for which it is difficult to test.

By default, the IndexingOutputConfig component is configured to load product catalog data, and to be

used on either the asset management or the production server. The IndexingOutputConfig component’s

repository property refers to the catalog repository as ProductCatalog:

repository=/atg/commerce/catalog/ProductCatalog

In DCS.Search.Versioned, this value is overridden to point to ProductCatalog_production:

repository=/atg/commerce/catalog/ProductCatalog_production

The IndexingOutputConfig component may also use a repositoryItemsGroup property:

repositoryItemsGroup=/atg/commerce/search/IndexedItemsGroup

By default, IndexedItemsGroup also points to /atg/commerce/catalog/ProductCatalog, and is

overridden by DCS.Search.Versioned to ProductCatalog_production.


If you are using similar components to index non-catalog repository data, be sure they are configured to point to

the correct repository.

Note: You will see a warning during indexing if the IndexingOutputConfig and IndexedItemsGroup

components’ repositories don’t match.

Synchronizing Versioned Repository Deployment and Indexing

You can configure Search components to synchronize your repository deployments with the indexing process,

ensuring that changes deployed from Content Administration are reflected in your Search index as soon as

possible. This means that you do not have to schedule indexing for your versioned repositories in Search

Administration. You will still have to schedule indexing for any other data, such as files or other repositories that

are not part of synchronized deployment.

To use synchronized deployment indexing:

1. If indexing a repository other than the product catalog, append your IndexingOutputConfig

component to the list in the indexingOutputConfigs property of the /atg/search/repository/

IndexingDeploymentListener component.

Note: The ProductCatalogOutputConfig is in this list by default.

2. In Search Administration, create a Search project.

3. Add the appropriate IndexingOutputConfig component as a Content Set to the search project.

4. Create automatic indexing rules for your Search project. See the ATG Search Administration Guide for

information on automatic indexing rules.

5. When you deploy your catalog, indexing starts.

Note: While indexing takes place, the repository and search index are in an inconsistent state.

The IndexingOutputConfig component includes a list of repositories to track for synchronization purposes in

the synchronizedRepositories property. For each repository, you can specify item descriptors to watch for.

In the default configuration, the DCS.Search.Versioned configuration layer adds the following configuration

to the ProductCatalogOutputConfig:

synchronizedRepositories+=\ /atg/search/repository/RefinementRepository_production=*

The asterisk tells the deployment synchronization listener that when any item type in the production refinement

repository is deployed, with no catalog repository changes, run the CA_deployment_target_name-

Customizations indexing rule.

If you want to synchronize only on certain item types, you can specify the types to watch by listing them as

shown:

synchronizedRepositories+=\ /atg/search/repository/RefinementRepository_production=\ itemTypeA,\ itemTypeB,\ itemTypeC

In this case, the CA_deployment_target_name-Customizations indexing rule runs only when changes to the

specified item types are deployed.


Configuring Data Sources for Search

ATG data source components are wrappers that provide the connection information that applications use to

connect to the repositories that represent your databases. The database tables used by Search fall by default

into two schemas:

• management (also called publishing), which contains some versioned data used by Search

• production, which contains most of the Search data

Though your DBA may configure your database differently, ATG documentation assumes the default

arrangement.

Note: The startSQLRepository script, which is used to import initial data into ATG application databases,

uses a FakeXADataSource, while JBoss uses a JNDIReference JTDataSource. To work around this, you define a

FakeXADataSource in home/localconfig/atg/dynamo/service/jdbc (which startSQLRepository uses)

and the JNDIReference in home/servers/server_name/localconfig/atg/dynamo/service/jdbc (which

JBoss uses). The JNDI name must match the JBoss name for the management schema. In order for JBoss to use

the server, you must specify that server when you issue the startDynamoOnJBOSS command.

Note: All servers that share a data source need to use a common server lock manager.

You do not need to do any Search-specific datasource configuration for the management schema. For the

production schema, you need to configure the following datasource for all of your ATG servers:

/atg/search/service/SearchJTDatasource

Configure the componentPath property of the SearchJTDataSource component on each of your ATG servers

(asset management, production, staging).

/atg/search/service/SearchJTDatasourcecomponentPath=/atg/dynamo/service/jdbc/JTDataSource_Production_Core

Each of these SearchJTDataSource components must ultimately point to the same (production) database

schema, but each might refer to a different datasource in the componentPath property, depending on how

your data sources are configured and named.

By default the SearchJTDataSource component on the asset management server is configured to point to

JTDataSource_Production, which is typically a switching data source. You must change this configuration

to use a non-switching datasource that points to the production database.If you are using switching, you can

configure the componentPath to point to either datasource that makes up your switch configuration, but do

not use the switching datasource itself.

Creating the Search Database Tables

Your Search Administration installation and all routing installations must have access to the Search databases.

Search components rely on two database schemas, one internal, which is used by management applications

such as Search Administration and Merchandising (referred to in the sections that follow as the management


schema), and one external, which is used by Search client applications such as the routing module, Commerce

and Knowledge (referred to as the production schema). Most of the Search tables are installed in the production

schema so they are available at runtime to Commerce or Service applications.

Creating Base Search Database Tables

After installing ATG Search, create the database tables.

1. Run SQL scripts to create the Search routing tables in your production database schema:

• <ATG9dir>\DAF\Search\Routing\sql\db_components\db_type\

routing_ddl.sql

• <ATG9dir>\DAF\Search\Index\sql\db_components\db_type\

search_ddl.sql

• <ATG9dir>\DAF\Search\common\sql\db_components\db_type\

refinement_ddl.sql

• <ATG9dir>\DAF\Search\Topics\sql\db_components\db_type\

search_topics_ddl.sql

The search_ddl.sql script creates the tables used by the IncrementalLoader to track changes

to the indexed repository. The refinement_ddl.sql script creates the tables used by the

RefinementRepository.

2. Run the scripts to create the Search Administration tables in administration/management database schema.

The following script is located in the <ATG9dir>\Search9.4\SearchAdmin\common\sql\db_components

\db_type\ directory:

• searchadmin_admin_ddl.sql

The following scripts are located in the <ATG9dir>\Search9.4\SearchAdmin\customizations\sql

\db_components\db_type\ directory:

• searchadmin_dictionary_ddl.sql

• searchadmin_termweights_ddl.sql

• searchadmin_queryrules_ddl.sql

• searchadmin_tpo_ddl.sql

• searchadmin_facet_ddl.sql

3. If you have not already done so for any of your other ATG applications, run the following script to create ATG

Business Control Center tables:

• <ATG9dir>\BIZUI\sql\install\db_type\bizui_all_ddl.sql

Importing Initial Search Data

Having created your database tables, they must be populated with initial data before using Search.

Note: The import scripts import data using StartSQLRepository. Make sure your JTDataSource and

FakeXADatasource are configured to permit this in home/localconfig. JTDataSource should automatically


point to FakeXADataSource. FakeXADataSource should point to the administration database, and

FaxeXADataSource_production should point to the production database. Note that some product

installation processes, including ATG Self Service, need FakeXADataSource pointed at the production database,

so you may need to change the FakeXADataSource between installations.

If you haven’t already done so for other ATG applications, run the following scripts to import initial data for the

ATG Business Control Center:

<ATG9dir>\Publishing\base\install\importPublishing.bat

<ATG9dir>\BIZUI\install\importBizui.bat

To import initial data into your Search schema, run the following commands:

<ATG9dir>\home\bin\startSQLRepository.bat|sh -m DAF.Search.Topics -repository /atg/searchadmin/TopicRepository -import<ATG9dir>\DAF\Search\Topics\data\initial\topics-data.xml

<ATG9dir>\home\bin\startSQLRepository.bat|sh -m SearchAdmin.AdminUI-m DPS.InternalUsers -repository/atg/userprofiling/InternalProfileRepository-import<ATG9dir>\Search9.4\SearchAdmin\common\data\initial\searchadmin-profile.xml

<ATG9dir>\home\bin\startSQLRepository.bat|sh -m SearchAdmin.AdminUI -repository /atg/searchadmin/SearchAdminRepository -import<ATG9dir>\Search9.4\SearchAdmin\common\data\initial\searchadmin-data.xml

Creating Database Tables for Search with Merchandising

If you are running Search with Merchandising, see Configuring a Purchased Content Administration Database in

the ATG Merchandising User Guide, skipping any steps that you have already performed.

Deleting Search Database Tables

Each table creation script noted in the previous sections has a corresponding drop script located in the

component_path\sql\uninstall\db_type directory. For example, the routing_ddl.sql table creation

script for Oracle has a corresponding drop script at:

<ATG9dir>\DAF\Search\Routing\sql\uninstall\oracle\drop_routing_ddl.sql


Configuring Search for Customer Intelligence

See the ATG Customer Intelligence Installation and Configuration Guide for information on creating Search data

warehouse tables and importing Search reports into the Reporting Center.

For information on Search metadata and the data warehouse infrastructure, see the ATG Customer Intelligence

Data Warehouse Guide.

For information on the provided Search reports, see the Reporting chapter in the ATG Search Administration

Guide.

Accessing Search Administration

To access Search Administration:

1. Make sure your database is running.

2. Deploy the EAR to your application server. See the Search Installation Roadmaps (page 11) section of the

Planning Your Search Installation (page 7) chapter for details on how to build EAR files for different Search

combinations.

3. In your Web browser, access the ATG Business Control Center on your administration server. The default

location is hostname:port/atg/bcc.

4. Enter your login and password.

5. In the left navigation area, click ATG Search Administration.


6. Click a menu option to begin working with Search Administration.

Note: If you are familiar with ATG Content Administration, bear in mind that Search Projects are not related to

Content Administration Projects.

The ATG Search Administration interface is loaded into the current browser window. See the ATG Search

Administration Guide for administration tasks.

Appendix A. Migrating from ATG 2006.x Search Versions 49

Appendix A. Migrating from ATG 2006.x

Search Versions

This appendix is for users of previous versions of ATG Search. It highlights changes in the user interface and

terminology, and provides instructions for changing to the new version. It includes the following sections:

Form Handler Changes (page 49)

Architecture Changes (page 49)

Terminology Changes (page 50)

Procedural Changes (page 51)

Reporting Changes (page 52)

Migration Procedures (page 52)

Form Handler Changes

The Search API and dependent form handlers have changed. Any application pages that use these form

handlers must be rewritten to account for the changes. See the ATG Commerce Search Guide for information on

using Search form handlers.

Architecture Changes

Search no longer needs to run on a dedicated server, but can be included in an ATG instance.

See the Planning Your Search Installation (page 7) chapter for architecture information.

50 Appendix A. Migrating from ATG 2006.x Search Versions

Terminology Changes

This section describes where terms used in the user interface have changed between Search 2006.x and Search

9.4.

9 Term Definition Replaces 2006.x Term

content item A unit of indexable material. document

content source A location in which content is stored, such as a

file system or a database.

content connector

data extractor

data renderer

web spider

db forum resource

content template

content set A logical grouping of related content. A content

set can contain any number of content sources.

document repositories/sets

customizations Blanket term for topic sets, query rules,

dictionaries, refinement configurations,

languages, parsing options, and query rules.

n/a

index Content that has been processed and can be

searched.

IdeaMap

indexing Indexing content and deploying to either a

staging or production environment

job script actions

deployment

indexing

environment

Search environment that performs indexing. indexing server

physical partition A section of an index. Partition size is limited

based on the Search product architecture, so

it may be necessary to have more than one in

an index for large amounts of content. Search

automatically calculates how many partitions

are required.

n/a

Search project Projects represent the top-level organizing

container for indexed content: one or more

sets of content are gathered in a project and

collectively referred to as the project’s Index.

The project associates customization data,

search environments, and physical machines

with an index.

Job scripts


9 Term Definition Replaces 2006.x Term

Search Administration The ATG Search user interface, including both

Project Administration and the Workbench.

Management Console

search engine A standalone Search executable that both

indexes content and processes end-user

searches.

Answer Server

Search environment A combination of one or more machines and

search engines which either index content or

search indexes. Environment types are:

Indexing environment – Performs the indexing

of content for eventual deployment to

production or staging servers.

Staging environment – For demonstration and

evaluation purposes, not intended for heavy

load.

Production environment - Used to run end-user

facing search services under heavy load.

Content clusters

topic sets A hierarchy of topics. taxonomies

Workbench Part of the user interface where users verify their

indexes, and edit customization data.

Management Console (partial)

Procedural Changes

The biggest change in how Search works comes from the new concept of the Search Project and the elimination

of the old Content Template taskflow in favor of a simpler configuration process.

The process for adding content to your searchable data has been simplified. Many seldom-used UI options have

been moved so that while still accessible, if you do not need them they are easily skipped over.

ATG Search 2006.3 and earlier releases only allowed one indexing job to run per ATG Search installation. This

generally required a separate ATG Search installation per site to work around this limitation. ATG Search 9.4

allows concurrent indexing jobs.

After identifying the content you want to make searchable, the procedures can be compared thus:


Step ATG Search 2006.3 ATG Search 9

Create a project N/A The new Search Project provides

a central place to keep track of

everything you need to index and

deploy content: the content itself,

associated configuration, information

about where and how it should be

deployed, etc.

Acquire content Create content connectors using data

extractors and data renderers.

Add content directly to your Search

Project.

Customize content Build topics, dictionaries, and other

tools to help end-users find answers

successfully.

The new Search Workbench provides a

centralized, standardized way to create

and test customizations, which can

then be associated with one or more

projects.

Index content Create a job script and procedures, and

run the script.

Index your project, either immediately

or by creating schedule rules.

Note: A customization data type in previous versions of ATG Search known as “File Handling Options”, which

specified how file extensions were interpreted with respect to file types, has been replaced by Advanced

Settings options on the content itself.

Reporting Changes

Search reports cannot be migrated to Search 9.4. Reports in Search 9.4 will include only data collected after the

upgrade.

The following reports, which were once included in ATG Search, have been moved to ATG Self Service:

• Ratings Trend Report

• Ratings Detail Report

• Ratings Distribution Report

See the Reporting chapter of the ATG Search Administration Guide for information on Search 9.4 reports.

Migration Procedures

Direct migration from previous Search versions is not possible. You can export the following from your Search

2006.x installation as XML files, and then import it into your Search 9.4 installation:


• Dictionaries

• Term Weight Sets

• Taxonomies (called Topic Sets in Search 9)

Note: Be sure to export topic sets from 2006.x so that the topic IDs are included, and import them into Search

9 the same way. If you do not include topic IDs, topic references are broken.

• Query Rules

• Document Parsing Options (called Text Processing Option Sets in Search 9)

• Refinement Configurations (called Facet Sets in Search 9)

Warning: All data must be exported using the 2006.x Management Console. Make sure to export your data

before uninstalling Search 2006.x.

Appendix B. ATG Search Component Ports 55

Appendix B. ATG Search Component

Ports

The default ports used by ATG Search components may conflict with your organization’s current port

assignments. This appendix describes the ports used.

If you are using Search with Knowledge or Self Service, the RMI IIOP port must be opened so that Search can

extract content from the Knowledge/Self Service installation. By default, the RMI port is 8860.

Knowledge, Self Service and Search Administration communicate with the search engines using HTTP. One port

per search engine is by default allocated from the 6070—6100 range.

The following table summarizes the locations where ports are set and used:

Component Default

Port(s)

Locations

Search Engines 6072-6100 Search Administration: Host Machine Details for each machine.

56 Appendix B. ATG Search Component Ports

Appendix C. Search CIM Details 57

Appendix C. Search CIM Details

This appendix lists in full the steps CIM performs when doing a Search installation.

Installed Products Required

• Platform

• Commerce

• DCS-UI

• ATG Search

Database Assumptions

CIM assumes that you have either two database (CA, Core) if you are using non-switching datasources, or four

databases (CA , SwitchA, SwitchB, Core) for switching datasources.

Module Lists

Management Base Module list: BIZUI, PubPortlet, DafEar.Admin, B2CCommerce.Versioned,

DCS.Versioned, DAF.Search.Versioned, DAF.Search.Routing, SearchAdmin.AdminUI,

DCS.Search.Versioned

Production Base Module list: DafEar.Admin, B2CCommerce, DCS.PublishingAgent,

DAF.Search.Routing, DAF.Search.Topics, DAF.Search.Query, DCS.Search

If commerce and ‘Index by SKU’ add module: DCS.Search.Index.SKUIndexing

58 Appendix C. Search CIM Details

Datasources

For switching datasources:

• management versioned schema - jndi = atgpub_ds

• production core schema - jndi = atgcore_ds

• switching A production schema - jndi = atgcataloga_ds

• switching B production schema - jndi = atgcatalogb_ds

For non-switching datasources:

• management versioned schema - jndi = atgpub_ds

• production core schema - jndi = atgcore_ds

Database Schema Scripts Run

This section lists the SQL scripts CIM runs to create Search databases.

Management Schema

• DAS:sql/db_components/dbVendor/id_generator.sql

• DAS:sql/db_components/dbVendor/dms_limbo_ddl.sql

• DAS:sql/db_components/dbVendor/cluster_name_ddl.sql

• DAS:sql/db_components/dbVendor/create_sql_jms_ddl.sql

• DAS:sql/db_components/dbVendor/create_staff_ddl.sql

• DAS:sql/db_components/dbVendor/create_gsa_subscribers_ddl.sql

• DAS:sql/db_components/dbVendor/create_sds.sql

• DAS:sql/db_components/dbVendor/integration_data_ddl.sql

• DAS:sql/db_components/dbVendor/nucleus_security_ddl.sql

• DAS:sql/db_components/dbVendor/media_ddl.sql

• DAS:sql/db_components/dbVendor/deployment_ddl.sql

• DAF.Search.common:sql/db_components/dbVendor/searchtesting_ddl.sql

• DPS:sql/db_components/dbVendor/user_ddl.sql

• DPS:sql/db_components/dbVendor/logging_ddl.sql


• DPS:sql/db_components/dbVendor/logging_init.sql

• DPS.InternalUsers:sql/db_components/dbVendor/internal_user_ddl.sql

• DSS:sql/db_components/dbVendor/business_process_rpt_ddl.sql

• DSS:sql/db_components/dbVendor/das_mappers.sql

• DSS:sql/db_components/dbVendor/dps_mappers.sql

• DSS:sql/db_components/dbVendor/dss_mappers.sql

• DSS:sql/db_components/dbVendor/markers_ddl.sql

• DSS:sql/db_components/dbVendor/profile_bp_markers_ddl.sql

• DSS:sql/db_components/dbVendor/scenario_ddl.sql

• DCS:sql/db_components/dbVendor/commerce_user.sql

• DCS:sql/db_components/dbVendor/inventory_ddl.sql

• DCS:sql/db_components/dbVendor/user_promotion_ddl.sql

• DCS:sql/db_components/dbVendor/order_ddl.sql

• DCS:sql/db_components/dbVendor/user_giftlist_ddl.sql

• DCS:sql/db_components/dbVendor/dcs_mappers.sql

• DCS:sql/db_components/dbVendor/order_markers_ddl.sql

• DSS.InternalUsers:sql/db_components/dbVendor/internal_scenario_ddl.sql

• Publishing.base:sql/db_components/dbVendor/internal_user_profile_ddl.sql

• Publishing.base:sql/db_components/dbVendor/publishing_ddl.sql

• Publishing.base:sql/db_components/dbVendor/versioned_file_repository_ddl.sql

• Publishing.base:sql/db_components/dbVendor/versioned_process_data_ddl.sql

• Publishing.base:sql/db_components/dbVendor/versionmanager_ddl.sql

• Publishing.base:sql/db_components/dbVendor/workflow_ddl.sql

• DAF.Search.Versioned:sql/db_components/dbVendor/versioned_refinement_ddl.sql

• DCS.Versioned:sql/db_components/dbVendor/versioned_claimable_ddl.sql

• DCS.Versioned:sql/db_components/dbVendor/versioned_priceLists_ddl.sql

• DCS.Versioned:sql/db_components/dbVendor/versioned_product_catalog_ddl.sql

• DCS.Versioned:sql/db_components/dbVendor/versioned_promotion_ddl.sql

• DCS.Search.Versioned:sql/db_components/dbVendor/versioned_commerce_refinement_ddl.sql

• DPS.Versioned:sql/db_components/dbVendor/versioned_personalization_ddl.sql


• BIZUI:sql/db_components/dbVendor/viewmapping_ddl.sql

• Portal.paf:sql/install/dbVendor/alert_ddl.sql

• Portal.paf:sql/install/dbVendor/membership_ddl.sql

• Portal.paf:sql/install/dbVendor/paf_mappers_ddl.sql

• Portal.paf:sql/install/dbVendor/portal_ddl.sql

Production Switching (catalog A or B)



• DAF.Search.common:sql/db_components/dbVendor/refinement_ddl.sql


• DCS:sql/db_components/dbVendor/priceLists_ddl.sql

• DCS:sql/db_components/dbVendor/product_catalog_ddl.sql

• DCS:sql/db_components/dbVendor/promotion_ddl.sql

• DCS.Search.common:sql/db_components/dbVendor/commerce_refinement_ddl.sql

Production Switching Core
















• DPS:sql/db_components/dbVendor/personalization_ddl.sql








• DCS:sql/db_components/dbVendor/claimable_ddl.sql









• DAF.Search.Routing:sql/db_components/dbVendor/routing_ddl.sql

• DAF.Search.Index:sql/db_components/dbVendor/search_ddl.sql

• DAF.Search.Topics:sql/db_components/dbVendor/search_topics_ddl.sql

• SearchAdmin.common:sql/db_components/dbVendor/searchadmin_admin_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_dictionary_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_facet_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_queryrules_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_termweights_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_tpo_ddl.sql

Production Non-Switching Core
















• DPS:sql/db_components/dbVendor/personalization_ddl.sql








• DCS:sql/db_components/dbVendor/claimable_ddl.sql








• DCS:sql/db_components/dbVendor/priceLists_ddl.sql

• DCS:sql/db_components/dbVendor/product_catalog_ddl.sql


• DCS:sql/db_components/dbVendor/promotion_ddl.sql

• DAF.Search.common:sql/db_components/dbVendor/refinement_ddl.sql



• DAF.Search.Routing:sql/db_components/dbVendor/routing_ddl.sql

• DAF.Search.Index:sql/db_components/dbVendor/search_ddl.sql

• DAF.Search.Topics:sql/db_components/dbVendor/search_topics_ddl.sql

• SearchAdmin.common:sql/db_components/dbVendor/searchadmin_admin_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_dictionary_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_facet_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_queryrules_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_termweights_ddl.sql

• SearchAdmin.customizations:sql/db_components/dbVendor/searchadmin_tpo_ddl.sql

Data Import Details

This section lists the data import scripts CIM runs while creating Search databases.

Management

• repository:/atg/userprofiling/InternalProfileRepository import:/Publishing/base/install/epub-role-data.xml

• repository:/atg/epub/file/PublishingFileRepository import:/Publishing/base/install/epub-file-repository-

data.xml

• repository:/atg/userprofiling/PersonalizationRepository import:/DCS/install/data/initial-segment-lists.xml

• repository:/atg/portal/framework/PortalRepository import:/BIZUI/install/data/portal.xml

• repository:/atg/userprofiling/InternalProfileRepository import:/BIZUI/install/data/profile.xml

• repository-path:/atg/bizui/viewmapping/ViewMappingRepository import:/BIZUI/install/data/

viewmapping.xml

• repository:/atg/userprofiling/InternalProfileRepository import:/Search9.4/SearchAdmin/common/data/initial/

searchadmin-profile.xml

• repository:/atg/bizui/viewmapping/ViewMappingRepository import:/AssetUI/install/data/viewmapping.xml

• repository:/atg/bizui/viewmapping/ViewMappingRepository import:/AssetUI/install/data/

assetManagerViews.xml


• repository:/atg/bizui/viewmapping/ViewMappingRepository import:/DPS-UI/install/data/viewmapping.xml

• repository:/atg/bizui/viewmapping/ViewMappingRepository import:/DPS-UI/install/data/examples.xml

• repository-loader (Files:DSS:atg/registry/data/scenarios/DSS/.sdl, DSS:atg/registry/data/scenarios/recorders*/

*.sdl) File-mapping:/atg/epub/file/typemappers/ScenarioTypeMapping Folder-mapping:/atg/epub/file/

typemappers/FileFolderTypeMapping

Production Switching Core

• repository-path:/atg/searchadmin/TopicRepository import-file-path:/DAF/Search/Topics/data/initial/topics-

data.xml

• repository:/atg/searchadmin/SearchAdminRepository import:/Search9.4/SearchAdmin/common/data/initial/

searchadmin-data.xml

Production Non-Switching Core

• repository-path:/atg/searchadmin/TopicRepository import-file-path:/DAF/Search/Topics/data/initial/topics-

data.xml

• repository:/atg/searchadmin/SearchAdminRepository import:/Search9.4/SearchAdmin/common/data/initial/

searchadmin-data.xml

Server Instance Creation

This section lists the properties files CIM creates and the configuration it provides while creating Search server

instances.

CA instance: Non-Switching

\atg\dynamo\service\jdbc\JTDataSource.propertiesdataSource=/atg/dynamo/service/jdbc/DirectJTDataSource

\atg\dynamo\service\jdbc\JTDataSource_production.propertiesdataSource=/atg/dynamo/service/jdbc/DirectJTDataSource_production

\atg\dynamo\service\jdbc\DirectJTDataSource.propertiesJNDIName=(JNDI of Management Datasource)$class=atg.nucleus.JNDIReference

\atg\dynamo\service\jdbc\DirectJTDataSource_production.properties


JNDIName=(JNDI of Switching Core Datasource)$class=atg.nucleus.JNDIReference

\atg\search\service\SearchSQLRepository.propertiescomponentPath=/atg/dynamo/service/jdbc/SQLRepository_production

\atg\search\service\SearchClientLockManager.propertiescomponentPath=/atg/dynamo/service/ClientLockManager_production

\atg\search\service\SearchSQLRepositoryEventServer.propertiescomponentPath=/atg/dynamo/server/SQLRepositoryEventServer_production

\atg\search\service\SearchIdGenerator.propertiescomponentPath=/atg/dynamo/service/IdGenerator_production

\atg\search\routing\LaunchingService.propertiesengineDir=(Path to SearchEngine)deployShare=(Path entered in UI)

\atg\search\config\LanguageDimensionService.propertieslocales=enlanguageMap=english=en

\atg\search\repository\IncrementalItemQueueRepository.propertiesdataSource=/atg/dynamo/service/jdbc/JTDataSource_production

\atg\search\service\SearchJTDataSource.propertiescomponentPath=/atg/dynamo/service/jdbc/DirectJTDataSource_production

\atg\search\testing\SearchTestingService.propertiessearchEnvironments=/atg/search/testing/ProductionEnvironment

/atg/dynamo/Configuration.propertieshttpsPort=(Port from UI)drpPort=(Port from UI)rmiPort=(Port from UI)httpPort=(Port from UI)

\atg\commerce\search\IndexedItemsGroup.propertiesrepository=/atg/commerce/catalog/ProductCatalog_production


\atg\commerce\search\config\RemoteCatalogRankConfigAdapter.propertiesremoteHost=(Hostname from UI)enabled=trueremotePort=(Port from UI)

\atg\commerce\search\config\RemoteSearchUpdateAdapter.propertiesremoteHost=(Hostname from UI)enabled=trueremotePort=(Port from UI)

atg\commerce\search\config\CatalogRankConfigAdapter.propertiescomponentPath=/atg/commerce/search/config/RemoteCatalogRankConfigAdapter

\atg\commerce\search\config\SearchUpdateAdapter.propertiescomponentPath=/atg/commerce/search/config/RemoteSearchUpdateAdapter

atg\commerce\search\refinement\RemoteCatalogRefineConfigAdapter.propertiesremoteHost=(Hostname from UI)remotePort=(Port from UI)invokerNucleusPath=/atg/search/adapter/RemoteCustomizationInvokerServiceremoteCustomizationDataAdapterNucleusPath=/atg/commerce/search/refinement/CatalogRefineConfigAdapter

\atg\commerce\search\refinement\CatalogRefineConfigAdapter.propertiescomponentPath=RemoteCatalogRefineConfigAdapter

\atg\search\testing\ProductionEnvironment.propertiessearchEnvironmentName=commerceavailableLocaleNames=en_US

Production Instance: Non-Switching


\atg\dynamo\service\jdbc\DirectJTDataSource.propertiesJNDIName=(JNDI of Non-switching core)$class=atg.nucleus.JNDIReference

\atg\search\routing\LaunchingService.propertiesdeployShare=(Path from UI)


\atg\dynamo\service\GSAInvalidatorService.propertiesenabled=true

atg\search\config\LanguageDimensionService.propertieslocales=en,en_USlanguageMap=english=en

/atg/dynamo/Configuration.propertieshttpsPort=(Port from UI)drpPort=(Port from UI)fileDeploymentPort=(Port from UI)rmiPort=(Port from UI)httpPort=(Port from UI)

\atg\epub\DeploymentAgent.propertiesswitchableDataStores^=/Constants.null

\atg\commerce\search\config\CatalogRankConfigAdapter.propertiescomponentPath=LocalCatalogRankConfigAdapter

CA Instance: Switching


\atg\dynamo\service\jdbc\JTDataSource_production.propertiesdataSource=/atg/dynamo/service/jdbc/DirectJTDataSource_production

\atg\search\service\SearchSQLRepository.propertiescomponentPath=/atg/dynamo/service/jdbc/SQLRepository_production

\atg\search\service\SearchClientLockManager.propertiescomponentPath=/atg/dynamo/service/ClientLockManager_production

\atg\search\service\SearchSQLRepositoryEventServer.propertiescomponentPath=/atg/dynamo/server/SQLRepositoryEventServer_production

\atg\search\service\SearchIdGenerator.propertiescomponentPath=/atg/dynamo/service/IdGenerator_production


\atg\search\routing\LaunchingService.propertiesengineDir=(Path to SearchEngine)deployShare=(Path from UI)

\atg\search\config\LanguageDimensionService.propertieslocales=enlanguageMap=english=en

\atg\search\repository\IncrementalItemQueueRepository.propertiesdataSource=/atg/dynamo/service/jdbc/JTDataSource_production

\atg\search\service\SearchJTDataSource.propertiescomponentPath=/atg/dynamo/service/jdbc/DirectJTDataSource_production

\atg\search\testing\SearchTestingService.propertiessearchEnvironments=/atg/search/testing/ProductionEnvironment

/atg/dynamo/Configuration.propertieshttpsPort=(Port from UI)drpPort=(Port from UI)rmiPort=(Port from UI)httpPort=(Port from UI)

\atg\dynamo\service\jdbc\DirectJTDataSource.propertiesJNDIName=(JNDI of Management DS)$class=atg.nucleus.JNDIReference

\atg\dynamo\service\jdbc\DirectJTDataSource_production.propertiesJNDIName=(JNDI of Switching Core)$class=atg.nucleus.JNDIReference

\atg\commerce\catalog\ProductCatalog_production.propertiesdataSource=/atg/commerce/jdbc/ProductCatalogSwitchingDataSource

\atg\commerce\jdbc\ProductCatalogDataSourceA.propertiesJNDIName=(JNDI of Switching A)$class=atg.nucleus.JNDIReference

\atg\commerce\jdbc\ProductCatalogDataSourceB.propertiesJNDIName=(JNDI of Switching B)$class=atg.nucleus.JNDIReference


\atg\commerce\search\IndexedItemsGroup.propertiesrepository=/atg/commerce/catalog/ProductCatalog_production

\atg\commerce\search\config\RemoteCatalogRankConfigAdapter.propertiesremoteHost=(Host from UI)enabled=trueremotePort=(Port from UI)

\atg\commerce\search\config\RemoteSearchUpdateAdapter.propertiesremoteHost=(Host from UI)enabled=trueremotePort=(Port from UI)

\atg\commerce\search\config\CatalogRankConfigAdapter.propertiescomponentPath=/atg/commerce/search/config/RemoteCatalogRankConfigAdapter

\atg\commerce\search\config\SearchUpdateAdapter.propertiescomponentPath=/atg/commerce/search/config/RemoteSearchUpdateAdapter

\atg\commerce\search\refinement\RemoteCatalogRefineConfigAdapter.propertiesremoteHost=(Host from UI)remotePort=(Port from UI)invokerNucleusPath=/atg/search/adapter/RemoteCustomizationInvokerServiceremoteCustomizationDataAdapterNucleusPath=/atg/commerce/search/refinement/CatalogRefineConfigAdapter

\atg\commerce\search\refinement\CatalogRefineConfigAdapter.propertiescomponentPath=RemoteCatalogRefineConfigAdapter

\atg\search\testing\ProductionEnvironment.propertiessearchEnvironmentName=commerceavailableLocaleNames=en_US

Production Instance: Switching


\atg\search\routing\LaunchingService.propertiesdeployShare=(Path from UI)


\atg\dynamo\service\GSAInvalidatorService.propertiesenabled=true

\atg\search\config\LanguageDimensionService.propertieslocales=en,en_USlanguageMap=english=en

/atg/dynamo/Configuration.propertieshttpsPort=(Port from UI)drpPort=(Port from UI)fileDeploymentPort=(Port from UI)rmiPort=(Port from UI)httpPort=(Port from UI)

\atg\dynamo\service\jdbc\DirectJTDataSource.propertiesJNDIName=(JNDI of Switching Core)$class=atg.nucleus.JNDIReference

\atg\commerce\catalog\ProductCatalog.propertiesdataSource=/atg/commerce/jdbc/ProductCatalogSwitchingDataSource

\atg\commerce\pricing\priceLists\PriceLists.propertiesdataSource=/atg/commerce/jdbc/ProductCatalogSwitchingDataSource

\atg\commerce\jdbc\ProductCatalogDataSourceA.propertiesJNDIName=(JNDI of Switching A)$class=atg.nucleus.JNDIReference

\atg\commerce\jdbc\ProductCatalogDataSourceB.propertiesJNDIName=(JNDI of Switching B)$class=atg.nucleus.JNDIReference

\atg\commerce\search\config\CatalogRankConfigAdapter.propertiescomponentPath=LocalCatalogRankConfigAdapter

5 Glossary 71

5 Glossary

The glossary provides a description of the terms used in ATG Search.

Term Definition

content Raw data for indexing, such as html files, Word documents, or ATG

repositories.

content set Bundles content into a single organizational unit that can be indexed as

one.

customizations Blanket term for topic sets, query rules, dictionaries, facet sets, languages,

parsing options, query rules, and preferred answers.

deploying The action of moving indexes and/or customization data from a staging to

a production environment

dictionary Contains definitions of special words and the relationships between them.

Users can add terms to improve the search responses.

expansion A synonym for a term, either defined in a custom dictionary or in the

default language files

facet set Allows end-users of your site to search within an existing result set.

index Used to refer to both the process of making content searchable, and the

aggregate form of the searchable content itself.

indexing environment Search environment that indexes content.

learning files Rules that automatically apply topics to a content collection.

partition An index is divided into one or more Logical Partitions, which have a one-

to-one relationship with content sets. Each Logical Partition is composed of

one or more Physical Partitions, depending on the amount of content.

project Projects represent the top-level container for managing and indexing

content. The project associates customization data and search

environments with an index.

query rules Link actions in ATG Search to certain types of user queries.

72 5 Glossary

Term Definition

Search Administration The ATG Search user interface, including both project administration and

the workbench.

search engine A standalone Search executable that both indexes content and processes

end-user searches.

search environment A combination of one or more machines and search engines which either

index content or search indexes. Environment types are:

indexing environment – Dedicated environment indexing content.

staging environment – Largely used for demonstration and evaluation

purposes. A web site can be pointed to a staging Search Environment for

demo or proof-of-concept purposes, but staging sites are not intended for

heavy load.

production environment – Used to run end-user facing search services

under heavy load. These typically include a large number of multi-CPU

machines to support high degrees of fault-tolerance and parallelism.

term Individual entry within a dictionary.

term weight set/stop words A set of term/weight pairs, in which the weight describes the amount of

influence a term has in a search.

topics User-defined classification system that can be applied to indexes, allowing

end-users to refine their search by finding related information.

topic set A hierarchy of topics.

Workbench Part of the user interface where users create and edit customization data.

Index 73

Index

Aarchitecture, 8

ATG Commerce, 12, 20

ATG Content Administration, 12, 20

ATG Customer Intelligence, 20, 46

ATG Knowledge, 17

ATG Merchandising, 12, 20, 45

ATG Search, installing, 27

ATG Self Service, 17

ATG server, 8

audience, 1

Bback-of-the-book index, 4

Business Control Center, 6

CCatalogRankConfigAdapter, 35

CIM, 25

clean partition, 31

client application, 5

Commerce Search, 12

components, 4

Content Administration, 4

conventions, 1

customization adapters, 34

configuring, 35

invoking, 37

local access, 35

registering, 35

customization data, 4

Ddata loading location, selecting, 38

data sources

configuring, 43

database, 5

configuring, 43

importing intial data, 44

database tables

deleting, 45

deployment share directory, 11

deployment, synchronized with indexing, 42

deployShare property, 32

dictionaries, 4

documents, 3

Ffeatures, 3

HHTMLFilter, 28

IIDGenerator, configuring, 33

index, 3, 4

customizing, 5

index item, 3

indexing

synchronizing with deployment, 42

IndexingOutputConfig component, 33

for versioned repositories, 41

installing, 27

Llock managers, 32

Mmulti-server installations, configuring, 31

Nnatural language components, 4

PPDF Extract, 28

physical partition, 5

prerequisites, 10

Project Administration, 4

Rrequests, 4

routing, 5, 9

configuring, 31

SSearch Administration, 4

accessing, 46

Search engine, 5

Search engines

adding, 29

configuring remote, 31

74 Index

Search Merchandising

customization adapters, 34

Search projects, 4

Search Query request, 4

Search workbench (see workbench)

SearchAdmin role, 6

searching, definition, 3

SearchSQLRepository component, 37

SearchSQLRepositoryEventServer component, 37

SearchUpdateAdapter, 35

security, 6

Vversioned repositories

indexing incrementally, 40

View Item request, 4

Wworkbench, 5

atg search installation and configuration guide - product ...€¦ · 2 1 introduction more...

Documents