The goal of this roadmap is to install and configure Oracle ATG Web Commerce Search in an integrated environment with Oracle ATG Web Commerce, ATG Content Administration, and Oracle ATG Web Commerce Merchandising. It also includes the use of standalone search engines.
You will need three server instances for this product combination:
One runs the administrative interfaces, including Oracle ATG Web Commerce Merchandising and Search Administration; this is referred to as the asset management server in this roadmap.
The second runs your Oracle ATG Web Commerce sites for testing, and is referred to as the staging server.
The final instance runs your live sites, and is referred to as the production server.
The servers can be set up on separate machines, or can run as separate instances on one machine if it has plenty of memory. Do not use the latter option for live sites, but you may use such a configuration for evaluation or testing purposes. You may also want to dedicate resources for additional search engines.
Your configuration may also include a staging and preview server.
Some of the steps in this procedure can be performed using CIM. These steps are noted in the roadmap. See Configuring Search with CIM and the CIM online help for additional information.
Architecture Diagram
This section provides a visual explanation of the pieces involved in an installation. For each server, the diagram shows key modules and other components.
The diagram includes the following databases, each of which includes data for several repositories:
Management—Versioned data for ATG Content Administration and other non-catalog information.
Production—Catalog and other deployed asset information for your sites. Use 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 ATG Search.
Staging—Duplicates the part of your production database that is necessary for staging and testing. In this configuration, that includes at least your product catalog and refinements.
If you use Oracle ATG Web Commerce Business Intelligence, you also have a data warehouse, not included in this diagram. See the ATG Business Intelligence Installation and Configuration Guide for reporting information.
Servers, Products, and Databases for Search and Commerce
Basic Installation Steps
This section covers the actual installation of the components and database configuration.
Install your application server on all machines that will be used for Oracle ATG Web Commerce instances. See the ATG Installation and Configuration Guide for information on configuring your application server.
Note: If you are using standalone search engines, those do not need to have an application server.
Download and install Oracle ATG Web Commerce products. Some applications will be included in more than one EAR file during deployment.
Oracle ATG Web Commerce platform; select all components when installing
The platform includes the
DAF.Search.Routingmodule, which will run on the production and staging servers using local Routing (see the Oracle ATG Web Commerce Search Architecture section).Oracle ATG Web Commerce Merchandising
Oracle ATG Web Commerce 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).
If using standalone search engines, see Adding Search Engines.
Configure databases and data sources for all applications. See Configuring Search with CIM, or see the following documents for manual database configuration:
Oracle ATG Web Commerce Platform. See Configuring Databases and Database Access in the ATG Installation and Configuration Guide.
Oracle ATG Web Commerce Search. See Creating the Oracle ATG Web Commerce Search Database Tables and Configuring Data Sources for Oracle ATG Web Commerce Search in this guide.
Oracle ATG Web 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
SwitchingDataSourceif using one.ATG Content Administration. See Setting up the ATG Content Administration Database in the ATG Content Administration Programming Guide.
Oracle ATG Web Commerce Merchandising. See Configuring Database Tables in the ATG Merchandising Administration Guide.
Create your asset management, staging, and production ATG servers. See Configuring Search with CIM, or see the ATG Platform Programming Guide for manual server creation information.
Configure lock management. See Configuring Search with CIM, or see Configuring the Lock Manager in this guide for manual lock management configuration.
Asset Management Server Configuration Steps
Configure the asset management server. This server runs ATG Content Administration, Oracle ATG Web Commerce Merchandising, and Search Administration.
Configure the
/atg/search/serviceproperties for the administration server. See Configuring SearchSQLRepository Components in this guide.Configure Oracle ATG Web Commerce components. See Configuring the IndexingOutputConfig Component and Configuring Customization Adapters for Search Merchandising in this guide.
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.
Create a client application. See the ATG Commerce Programming Guide.
Configure your Oracle ATG Web Commerce client. See the ATG Search Query Guide.
Build and Deploy Applications
See Configuring Search with CIM, or see the Developing and Assembling Nucleus Applications chapter of the ATG Platform Programming Guide for manual application assembly information. If you are assembling manually, include the following modules:
Asset management server EAR file
DCS.Search.VersionedSearchAdmin.AdminUIDCS-UI.SearchPublishingDCS-UI.Versioned
Note: If you are going to run Search Administration as part of a standalone EAR, you must do the following:
Run the Oracle ATG Web Commerce 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.
Set the
engineDirproperty of the/atg/search/routing/Configurationcomponent to the new search engine’s<Searchdir>\SearchEnginedirectory. For example:engineDir=c:\\ATG\\ATG10.2\\Search10.2\\SearchEngine
Production and staging server EAR files
DCS.SearchDCS.PublishingAgentDAF.Search.RoutingDafEar.Admin
Post-Deployment Configuration
The following tasks are performed in your running Oracle ATG Web Commerce applications.
Use ATG 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 (facets), include the
RefinementRepositoryin your repository mappings for your production and staging deployment targets.After deploying your catalog from ATG 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.
Use the Oracle ATG Web Commerce Business Control Center to access Search Administration. See Accessing Search Administration in this guide.
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/ProductCatalogOutputConfigLocation—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 an ATG 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.
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.
Index your catalog, using the “Full” indexing option.
Configure Oracle ATG Web Commerce Merchandising as described in Structuring the Search Configuration Tree in the ATG Merchandising Administration Guide.
Testing Your Installation
To test your installation, you can use the Search Query Console (see the Sample Application section of the ATG Search Query Guide) or Oracle ATG Web Commerce Merchandising (see the ATG Merchandising Guide for Business Users). Use the following steps:
Deploy your content.
Index the content.
On your production sites, make sure you get search results
Use Merchandising to change the catalog.
Deploy the changes.
Reindex the content.
Verify the change on your production sites.
