Skip to main content

ATG Search Indexing - behind the scene steps explained

Read more about the search indexing @

ATG search indexing involves index file creation, deploying and copying the index file to the search engine's box. The steps can be divided into Initial stage, Preparing Content, Indexing and Deploying. Please find below the detailed analysis of each step.

1. Initial stage:
       a. Check whether the folder deployshare configured correctly @ LaunchingService.deployShare  ( \atg\search\routing\LaunchingService.deployShare ). Lets assume that it is configured to \Search2007.1\SearchEngine\i686-win32-vc71\buildedIndexFiles.
       b. Lets assume that the index file folder ( \Search2007.1\SearchEngine\i686-win32-vc71\indexFiles)  has the following segments (folders) currently :
                    66900009 @ index engine box
       66900010 @ search engine box
       c. Lets assume that the component SearchEngineService has the "Local Content Path" as following for the search and index environments :
                   Search  environment   --> ../indexFiles/66900010
        Indexing environment  --> ../indexFiles/66900009

2.Preparing Content
     a. start an indexing engine @ step "Load latest pre-index customizations"
     b. delete the folder "\indexFiles\66900009" and create a new folder "\indexFiles\66900011" @ location "SearchEngine\i686-win32-vc71\indexFiles" @ index engine box
     c. copy the files initial.index ( from SearchEngine\i686-win32-vc71\data ) and  LUIStore.stg to “indexFiles\66900011” --> done by indexing engine

     a. create a new index and stg files @ "SearchEngine\i686-win32-vc71\buildedIndexFiles". First create the index file and then the stg file.
     b. copy the new index and stg files to the folder indexFiles\66900011 --> done by indexing engine
     c. update the SearchEngineService.Local Content Path of the indexing environment to ../indexFiles\66900011
     d. kill the indexing engine

    a. start a new answer engine
    b. create the folder "indexFiles\66900012" @ answer engine box -->  done by the new engine
    c. copy the new index and stg files to the folder "indexFiles\66900012" -->  done be new engine
    d. update the SearchEngineService.Local Content Path of the search environment to ..\indexFiles\66900012
    e. delete the folder "indexFiles\66900010"
    f.  shutdown the previous running engine


  1. Hi Sony, I have a clarification in step 4, It will be great if you can help me understand : Will ATG create a new search engine with a new Port at this phase ? Say we have existing engine running in port 5010, will a new engine be created and assigned 5011 and engine at 5010 will be killed during this deploying step ?

  2. Yes. A new searhc engine will automatically started @ 4.a @ new port. When we create the search project, we can define the range of port numbers for the search engines amd the new port will be opened with in that range.


  3. Hi Sony,
    First of all, thanks for the post....

    I have some concerns. Why do we need the deploy share ?

    As far as i understood
    at step 3.a index and stg files are created in deployeshare folder.

    at step 3.b the index and stg from deploy share is copied to ndexFiles\66900011.

    at step 4.c the index and stg from deploy share is copied to indexFiles\66900012.

    Please correct me

  4. deploy share is the name of the folder we specify @ /atg/search/routing/LaunchingService. This is where the index files are placed for index deployment. Index deployment is the process when the index files are copied to search instances. so the deploy share will come into picture only @ index deployment.

  5. Hi Sony,

    I am a newbie to ATG..! I am really excited to learn ATG concepts...! I have a doubt in the above topic...what is the need for two segment (folders) you mentioned in the below step and why they are mentioned as Index engine box and search engine box..!

    b. Lets assume that the index file folder ( \Search2007.1\SearchEngine\i686-win32-vc71\indexFiles) has the following segments (folders) currently :
    66900009 @ index engine box
    66900010 @ search engine box

    Also please clarify me why the remote launcher is used..and where en all it should run..?

  6. Hi Sony,

    I have one query i hope you will be helping me in this,
    Is it possible to trigger the index deployment using shell script rather than from administration UI.

    Amit Kumar

  7. Can you give pointers to below error while searching for custoemr in CSC.(ATGProfile env is running)
    Error copying file null\data\initial.index to file ../indexFiles\500001\initial.index: boost::filesystem::copy_file: The system cannot find the path specified: "null\data\initial.index", "..\indexFiles\500001\initial.index"


Post a Comment

Popular posts from this blog

ATG CA - BCC home screen : how to add a new link

          Activity source is the property which controls the links on the left nav on the BCC home screen. All activity sources are registered with the ActivityManager component at /atg/bizui/activity/ActivityManager . When rendering the BCC home page, the ActivityManager cycles through all the registered ActivitySource components and displays left navigation links for each of them on the BCC home page. For example if I want to add a new link "My New Link" , below screen shots exaplins how this can be done 1. Add to specify the activityresources. In this  activityManager, I specified one MyActivitySource. 2. Add  to specify the name of the link and the other details . Here it refers to a bundle properties file.  3. Add  the bundle properties file  to specify the name of the link.  4. Now you could see the new link @ BCC home page . Each activity source has the following important functions:

Eclipse plug-in to create Class and Sequence diagrams

ModelGoon is an Eclipse plug-in avaiable for UML diagram generation from Java code. It can be used to generate Package Dependencies Diagram, Class Diagram, Interaction Diagram and Sequence Diagram. You coud get it from Read more about it and see some vedios about how to create the class and sequence diagram @ Find some snapshots below which gives an idea about the diagram generation.

ATG Search and startRemoteLauncher

If the search engine application is running in a separate box than the ATG CA-BCC deployed server, the search engine is invoked through a remoteLauncher running in these boxes. Means, a remoteLauncher needs to run in the host where SearchEngine is installed remotely to start the search engine. You could find the @ ATG/ATG2007.1/Search2007.1/SearchAdmin/bin/ Start remoteLauncher using the command   ./ –p <RMI Launcher service Port > & The Launcher Service Port on the host machine can be found in BCC @ Search Administration>Projects > Search Project: gmri_search_en_CA > Environments > Host Machine: > Advanced Settings. If the startRemoteLanucher reports a BindingException , then you need to find the process that is using the launchServicePort. For that run the netstat command like :   netstat -an |grep 10880 Then inorder to identify the process that uses this port run the command like : r

Search Facets - how to create a new search facets in ATG Search

A Facet is a search refinement element that corresponds to a property of a commerce item type. ATG supports the search result refinement using the Faceted Search concept. Read more about facted search @ . Facet can either be ranges or specific values. Each facet is stored in the RefinementRepository as a separate refineElement repository item. Facets are divided into Global and Local facets. Global facets apply to all the categories and local facets only to the category in which they are created. For example Price/Brand can be considered as the facets that are common for all skus and New Release/Coming Soon can be considered as the facets that are specific to Physical Media products like Vidoe/DVD/Blue-ray/Books. We can use the ATG BCC - Merchandising UI to create facets. The Faceting Property depends on the meta-properties defined in the \atg\commerce\search\product-catalog-output-config.xml ( the definitionFile of the \atg\commerce\s