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:
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 in this 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
This section covers the actual installation of the components and database configuration.
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 machines do not need to have an application server.
Download and install ATG products.
ATG platform; select all components when installing
ATG Search; select the Full Search Install option. Install the HTML and PDF components if needed (see Installing HTMLFilter and Installing PDF Extract in this guide).
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.
If using standalone Search engines, see Adding Search Engines.
Create your administration, agent, and production ATG servers. See the ATG Programming Guide for information.
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. Note: If you are using the SOLID evaluation database, platform database tables are already loaded.
ATG Search. See Creating the Search Database Tables and Configuring Data Sources for Search in this 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.
Configure the
/atg/search/serviceproperties for the administration server. See Configuring SearchSQLRepository Components in this guide.Configure lock management for the administration server. See Configuring the Lock Manager in this guide and Configuring the Lock Manager and SQL Repository in the ATG Service Installation and Configuration Guide.
Run the
create-atgservice-searchprojectscript against your Search database as described in the Configuring Search Environment section in the ATG Service Installation and Configuration Guide.Set up your asset management server. See the Setting Up an Asset Management Server chapter of the ATG Content Administration Programming Guide.
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.
Create your client application.
Configure lock management for the production server. See Configuring the Lock Manager in this guide and Configuring the Lock Manager and SQL Repository in the ATG Service Installation and Configuration Guide.
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.
Build and Deploy Applications
Before continuing with configuration, you must build and deploy your applications.
Build and deploy the administration server EAR file. Include the following modules:
DafEar.Admin SearchAdmin.AdminUI PubPortlet Service.ExternalUsers
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 in this guide.
Add an
engineDirproperty to the/atg/search/routing/LaunchingServicecomponent, and set it to point to the new Search engine’s<Searchdir>\SearchEnginedirectory. For example:engineDir=c:\\ATG\\ATG9.3\\Search9.3\\SearchEngine
Build and deploy the production server EAR file. Include the following modules:
DafEar.Admin ARF.Base Service.SelfService
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
Post-Deployment Configuration
The following tasks are performed in your running ATG applications.
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.
Use the ATG Business Control Center to access ATG Search Administration. See Accessing Search Administration in this guide.
In Search Administration, add content to your project as described in the Configuring Search Environment section in the ATG Service Installation and Configuration Guide.
