The order and profile search configuration is administered using the Dynamo Server Admin and is comprised of the following components:

Full Text Search Components

The following primary classes and interfaces are used for order and profile searches.

Location and Name

Description

/atg/textsearch/client/
  SearchClientService

This component sets the LiveIndexingSupported
and LiveSearchingSupported properties. It also delegates all the calls to the defined database client and indexing session.

/atg/textsearch/client/
  CSCDB2Client.properties
,
  CSCMSSQLClient.properties
,
  CSCMySQLClient.properties
,
  CSCOracleClient.properties

Identifies the database that is installed, the column of the search table that contains search tokens, and other database specific configurations. It also is used to identify the databaseToTextLanguage property, which identifies the databases used:

oracle=ORACLE_CONTEXT
db2=DB2_TEXT_EXT
msSQL=MSSQL_TSQL
MySQL=MYSQL_TEXT_SQL

/atg/textsearch/indexing/
  session/DatabaseIndexing
  Session

Configures indexing functions that construct operations maps. Operation maps are built using resource keys that link messages and SQL statements together.

/atg/textsearch/indexing/
operation/common/
 NumberOfItemsToIndex.properties
 PopulateStaging.properties
 TruncateStaging.properties

Contains information detailing generic SQL that can be executed against any database. SQL can have placeholders that identify common tables, index names, etc., and are resolved by the IndexingOutputConfig file. The NumberOfItemsToIndex defines the SQL that obtains the total number of items that will be indexed as part of the baseline index process. PopulateStaging defines the SQL and placeholder values that are needed to produce the tokens used when performing searches. TruncateStaging defines the SQL and place holder values used to clear the staging table.

/atg/textsearch/indexing/
  operation/DatabaseOperation

Executes the SQL for the indexing process, and maps the SQL place holder values.

/atg/textsearch/indexing/
 operation/
database-vendor/
 MergeStagingToTokens.properties

Contains database-specific SQL information needed to merge data from staging tables into the token tables. Only items that have been changed or are not in the token table will be merged. This file also defines messages that are displayed in the UI, and a map of placeholder values that link to properties used in the IndexingOutputConfig file.

/atg/textsearch/indexing/
  session/IndexingSession

Provides the interface for all types of indexing:

baseline – Wipes all data and reloads it.
manual – Allows definition of specified re-indexing criteria.
increment – Performs scheduled live updates of items.

/atg/textsearch/indexing/
DB2IndexingSession
,
MSSQLIndexingSession
,
MySQLIndexingSession
,
OracleIndexingSession

The necessary methods to build the database vendor-specific SQL needed to perform bulk, incremental and live updates on a specific database type. Each database type has a properties file that provides configuration information as well as the following properties:

indexingOperations – A key=value format that defines the steps involved in the indexing operations. The key links the SQL and the UI messages used when performing the database operation. The value defines the SQL to run during the operation.
baselineOperations
– Defines the list of database operations to perform, such as NumberOfItemsToIndex, PopulateStaging, TruncateStaging and MergeStagingToTokens.

/atg/textsearch/indexing/
  IndexingOutputConfig

Specified output options defining properties for indexing along with SQL to generate the necessary search tokens.

/atg/textsearch/indexing/schedule/
  BaseIndexingOutputConfigScheduleImpl

The base class for scheduling indexing operations. Extends the SingletonScheduleService.

Order Search Components

The following components are used when performing order searches. These components reside in the DCS.TextSearch module.

Location and Name

Description

OrderIndexingAdditional
  Information

Used to provide any additional information for each database vendor type. For example, if your database type requires specific numbering formats, etc.

OrderIndexingSQL

Identifies the database SQL to perform order indexing.

OrderManualIndexRequestByCreation
  DateRange

Allows an administrator to re-index orders by creation date range. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

OrderManualIndexRequestById

Allows an administrator to re-index orders by ID. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

OrderManualIndexRequestByLas
  tModifiedDateRange

Allows an administrator to re-index orders by the last modified date range. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

OrderManualIndexRequestBySubmitted
  DateRange

Allows an administrator to re-index orders by the submitted date range. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

OrderModifiedListenerConfig

Sets the repositoryItemName to listen to for changes, and the modifiableProperties that trigger a re-index. By default, changes to the lastModifiedDate property trigger a re-index.

OrderOutputConfig

The OrderOutputConfig configures data and components needed for performing indexing of order items.

The component class IndexingOutputConfig creates the AdminServlet, which drives the UI in the Dynamo Server Admin. The UI is used to perform indexing operations, as described earlier in this table.

The OrderOutputConfig in the /LiveIndex directory allows you to identify the indexing sessions that perform baseline, incremental or manual indexing of orders by setting the order /atg/commerce/
textsearch/indexing/session/indexingSession
property.

OrderBaselineScheduleConfig

Contains the order baseline scheduling and lock management information.

Profile Search Components

The following components are used when performing profile searches. These components reside in the DPS.TextSearch module.

Location and Name

Description

ProfileContactInfoModified
  Listener  Config

Identifies the repository item to listen to for changes, the RQL details that indicate an index can be performed and properties that, when modified, trigger an index.

ProfileIndexingAdditional
  Information

Used to provide any additional information for each database.

ProfileIndexingSQL

Database SQL for profile searches.

ProfileManualIndexinRequestByID

Allows an administrator to re-index profiles by ID. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

ProfileManualIndexRequestByLast
  ModifiedDateRange

Allows an administrator to re-index profiles by the last modified date range. For information on performing manual indexing, refer to the Performing a Manual Re-Index section.

ProfileModifiedLIstenerConfig

Sets the repositoryItemName to listen to for changes, and the modifiableProperties that trigger a re-index. By default, changes to the following properties trigger a re-index:

login
firstName
lastName
email
shippingAddress
billingAddress
secondaryAddresses
creditCards

ProfileOutputConfig

The ProfileOutputConfig configures data and components needed for performing indexing of profile items.

The component class IndexingOutputConfig creates the AdminServlet, which drives the UI in the Dynamo Server Admin. The UI is used to perform indexing operations, as described earlier in this table.

The ProfileOutputConfig in the /LiveIndex directory allows you to identify the indexing sessions that perform baseline, incremental or manual indexing of profiles by setting the profile /atg/userprofiling/textsearch/
indexing/session/indexingSession
property..

ProfileBaselineScheduleConfig

Contains the profile baseline scheduling and lock management information.


Copyright © 1997, 2015 Oracle and/or its affiliates. All rights reserved. Legal Notices