Structure indexing using TcFTSIndexer

The TcFTSIndexer is used to orchestrate the required processing to create, synchronize, and eventually delete the indexes defined by the BOMIndexAdminData tables (BIADs). TcFTSIndexer can be run in a number of ways and is also used to perform object data indexing. The TcFTSIndexer has an extensibility model that allows different indexing types to define the processing required using a sequence of steps organized in flows.

Steps can be reused by multiple flows and different indexing types. This is different than the traditional QETL model where every action is plugged in as a part of query, extract, transform, or load. Key concepts of the extensibility model are: Type Specifies the name of the indexing type (for example, objdata, structure). Action Specifies a name that ties a command line option to start a flow (for example, sync starts the synchronization flow). Flow Specifies the flow to execute (for example, reindexflow, syncflow). Step Specifies a single step that is executed as part of a flow. With these concepts in mind, structure indexing is accomplished with: The structure indexing type. The test, show, sync, and recoverfailures actions. The testflow, showflow, syncflow, and recoverfailuresflow flows. A number of steps that are the building blocks of the various flows The general syntax for starting any action is using the runTcFTSIndexer utility is: Copy runTcFTSIndexer -task=type:action [additional-arguments] The -help argument lists all available actions. Do not use any actions described as Internal use only. Copy runTcFTSIndexer -help If you are using multiple types of indexing (for example, object indexing and structure indexing), the TcFTSIndexer process must first be started in service mode, for example: runTcFTSIndexer -background However, you can still run the -task=structure:show and -task=structure:help tasks without having to start it as a service first. The main -task actions for structure indexing are: -task=structure:test Performs basic tests, such as for Teamcenter log on, FMS connectivity, verifying or downloading of transform files, Solr schema, and so on. This command cannot be run concurrently with other structure indexing actions. -task=structure:show Shows a summary of all configured product configurations. -task=structure:sync Performs normal synchronization and delete actions for all product configurations. This command queues up all the synchronization actions for the product configurations. The queued synchronization actions are processed as resource permits. This command cannot be run concurrently with other structure indexing actions. The TcFTSIndexer must be running in service mode to run this command. -task=structure:syncone product-config-UID Performs normal synchronization and delete actions for a single product configuration UID. This command queues up all the synchronization actions for the product configurations. The queued synchronization actions are processed as resource permits. This command cannot be run concurrently with other structure indexing actions. -task=structure:recoverfailures Changes all product configurations with failed states to the last known good state. Structure indexing will resume from the recovery state and structure will not be re-indexed completely. For example: IndexGenFailure will be changed to ReadyToIndex IndexExportFailure or SolrIndexGenFailure will be changed to IndexExportRequested IndexSyncExportFailure or IndexGenSyncFailure will be changed to IndexSyncRequested IndexDelFailure or SolrIndexDelFailure will be changed to MarkedForDeletion -task=structure:resetall Downloads the latest transform and schema files, resets all active product configurations to the ReadyToIndex state, and resets all deleted product configurations to the MarkedForDeletion state. This command cannot be run concurrently with other structure indexing actions. -task=structure:reset product-config-UID Resets the given PRODUCT_CONFIG_UID setting to the ReadyToIndex or MarkedForDeletion state. This command cannot be run concurrently with other actions.