7/10/2013

PAWAN MODI

ATG SITE AND SEARCH SETUP

ATG

Page 0

ATG Site & Search Setup

Preface
This document is a quick handbook for ATG Search Setup. This document is based on my hands-on ATG experience. Document details out ATG Site and Search Setup step by step. The target audience of this document is ATG application developers, Merchandiser and ATG search administrator. Search Engine serves user request for catalog, product and information search on the website. This document is step by step guide to setup production site and search engine from BCC. It is always recommended to run search engine on dedicated box. Search engine plays critical role in providing relevant information to users. Most of the initial http requests are served by search engine. In this document, I have covered production site creation, search engine setup, adding content, indexing, post index customization etc. The document is based on ATG9 libraries and ATG9-Search.

ATG

Page 1

ATG Site & Search Setup

Table of Contents
TABLE OF FIGURES ABBREVIATION ATG
Introduction ATG Search Architecture Pre-Requisite

3 3 5
5 5 6

PRODUCTION SITE SETUP

Create Production Site

7
7

ATG SEARCH SETUP

Create Search Project Adding Content Add Environment Search Indexing

10
10 11 12 14

ATG

Page 2

ATG Site & Search Setup

Table of Figures
FIGURE 1 ATG PUBLISHING HOME ................................................................................................................................7 FIGURE 2 ADMIN CONSOLE CONFIGURATION ...............................................................................................................7 FIGURE 3 ADMIN CONSOLE CONFIGURATION 2 ............................................................................................................8 FIGURE 4 ADMIN CONSOLE AGENT CONFIGURATION ..................................................................................................8 FIGURE 5 ADMIN CONSOLE OVERVIEW .........................................................................................................................8 FIGURE 6 ADMIN CONSOLE AGENT OVERVIEW.............................................................................................................9 FIGURE 7 ADMIN CONSOLE OVERVIEW DETAILS ...........................................................................................................9 FIGURE 8 ATG SEARCH ADMINISTRATION ...................................................................................................................10 FIGURE 9 ATG SEARCH PROJECT ..................................................................................................................................10 FIGURE 10 ATG SEARCH NEW PROJECT .......................................................................................................................10 FIGURE 11 ATG SEARCH PROJECT ADD CONTENT .......................................................................................................11 FIGURE 12 ATG SEARCH PROJECT ADD CONTENT 2 ....................................................................................................11 FIGURE 13 ATG SEARCH PROJECT ADD CONTENT 3 ....................................................................................................12 FIGURE 14 ATG SEARCH ENVIRONMENT .....................................................................................................................12 FIGURE 15 ATG SEARCH ENVIRONMENT 2 ..................................................................................................................13 FIGURE 16 ATG SEARCH ENVIRONMENT 3 ..................................................................................................................13 FIGURE 17 ATG SEARCH INDEXING ..............................................................................................................................14 FIGURE 18 ATG SEARCH INDEXING 2 ...........................................................................................................................14 FIGURE 19 ATG SEARCH INDEXING 3 ...........................................................................................................................15

ATG

Page 3

ATG Site & Search Setup

Abbreviation
DAS DAF DSS DPS DRP GSS LM CM RMI DCC SBS UDP Dynamo Application Server Dynamo Application Framework Dynamo Scenario Server Dynamo Personalization Server Dynamo Request Protocol Server Global Scenario Server Load Manager Connection Module Remote Method Invocation Dynamo Control Center Session Backup Server User Datagram Protocol alternative protocol to TCP/IP, (usually used for broadcasting)

SNMP Simple Network Management Protocol, MIB packet services

ATG

Page 4

ATG Site & Search Setup

ATG
Introduction
ATG is the worldwide leader in the E-commerce solutions. ATG product suite has enabled the vendors to enable their e-commerce commercial capabilities.

ATG Search Architecture

ATG Search runs within a standard ATG platform installation. Due to the heavy performance demands of indexing content and serving search responses, you must dedicate at least one machine in your network exclusively to Search. 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. You should have only one Search Administration instance in your installation. The SearchAdmin.AdminUI module is required to run Search Administration.

Search engine - Serves answers to end-user queries. Does not require a full ATG installation. Your installation can include any number of search engines, but should run only one search engine per processor core. A single search engine can use up to 1.4GB of memory, assuming a 32-bit operating system. Your hardware should be sized accordingly. The DAF.Search.Routing module starts the Search engine(s) either locally or remotely, and coordinates communication between the client application, Search engine(s), and the Search database. Runs within a standard ATG installation. You can run multiple instances of this module, but one should always run along with Search Administration.

The DAF.Search.Base module is a lightweight routing module that can be run independent of Search Administration. DAF.Search.Base is automatically included in Routing and contains base routing functionality. It is also used stand-alone in client applications. You can run multiple instances of this module. Client applicationThe application through which your end-users place their search queries. This application must include the DAF.Search.Base module, and must also include DAF.Search.Query if your application uses legacy form handlers.

ATG

Page 5

ATG Site & Search Setup 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 a content set configured in Search Administration. Each logical partition is composed of one or more physical partitions, each of which is served up by a search engine. Search database - consists of two repositories, one of which stores information about Search engines, index structure, and deployment information, the other of which stores information about users and Search Administration. Search Administration requires access to both repositories. Both Search Administration and your client application must have access to the routing repository.

The Search Administration, routing, and Search engines must all have access to the deployment share directory. This is a scalable, shared directory where master copies of indexes are stored. This directory should ideally be located on a high-performance machine separate from the Search Administration machine. Routing and Search engine components must have access to this directory in order for indexes to be deployed and searched.

Pre-Requisite
Going ahead with the setup, assuming following dependencies are in place. 1. 2. 3. 4. ATG9.1 installed and working. ATG9 Search installation is done. ATG9.1 Publishing is up and running. ATG9.1 Production Site is up and running.

ATG

Page 6

ATG Site & Search Setup

Production Site Setup

Before we proceed for search setup, we need to create production site in BCC. This step is required if site is not created yet. If you have target site and agent setup then you can directly move to ATG search setup.

Create Production Site

You need to create target site (production site) in BCC. By creating site in BCC, we are making sure that all further deployments will happened to configured production site. 1. First step is to create a site for a search project. 2. In BCC, click Content Administration from the home. 3. Go to Content Administration Admin Console.

Figure 1 ATG Publishing Home

4. In admin console, click on configuration add site and provide the details.

Figure 2 Admin Console Configuration

ATG

Page 7

ATG Site & Search Setup

Figure 3 Admin Console Configuration 2

5. Now click on agents tab add agent to site.

Figure 4 Admin Console Agent Configuration

6. Provide the details and click on save changes.

Figure 5 Admin Console Overview

ATG

Page 8

ATG Site & Search Setup 7. Validate your configuration once.

Figure 6 Admin Console Agent Overview

8. Now need to do full deployment once.

Figure 7 Admin Console Overview Details

ATG

Page 9

ATG Site & Search Setup

ATG Search Setup

Assuming site creation is done and full deployment to production site is successful. Deployment is important because unless we have catalog data in our LIVEA / LIVEB production database, indexing will not contain anything. Always remember, search engine perform indexing on production schema.

Create Search Project

1. Open Search Administration browse projects and click on New Search Project.

Figure 8 ATG Search Administration

Figure 9 ATG Search Project

2. Provide details to create new search project.

Figure 10 ATG Search New Project

ATG

Page 10

ATG Site & Search Setup

Adding Content
1. Add content set as ATG Repository.

Figure 11 ATG Search Project Add Content

Figure 12 ATG Search Project Add Content 2

ATG

Page 11

ATG Site & Search Setup 2. Validate your configuration after adding the contents.

Figure 13 ATG Search Project Add Content 3

Add Environment
1. Set up environment for indexing i.e. MyB2CCommerceProduction.

Figure 14 ATG Search Environment

ATG

Page 12

ATG Site & Search Setup 2. Click on the environments in left side panel.

Figure 15 ATG Search Environment 2

3. Update the host name where the engine will run.

Figure 16 ATG Search Environment 3

ATG

Page 13

ATG Site & Search Setup

Search Indexing
1. Start Indexing Process and do the full indexing first time on created environment.

Figure 17 ATG Search Indexing

2. Validate if your indexing is successful.

Figure 18 ATG Search Indexing 2

ATG

Page 14

ATG Site & Search Setup

Figure 19 ATG Search Indexing 3

3. After successful indexing, search engine is ready to serve on production site.

ATG

Page 15