runTcFTSIndexer

Indexes data into the Solr indexing engine. Run this command from the FTS_INDEXER_HOME directory, for example, TC_ROOT\TcFTSIndexer\bin. This command is not required to be run in a specific environment. Syntax runTcFTSIndexer -debug -maxconnections -status -stop -service -shutdown -task=[objdata | multisite | structure | fourgd]:flow-action -h Note Operating system considerations: Linux A .sh extension is required, for example, ./runTcFTSIndexer.sh. If a UID contains a special character, you must enclose it in straight, single quotation marks. UIDs can contain A-Z, a-z, 0-9, $, and _. Windows The .bat extension is not required for runTcFTSIndexer. For UIDs on Windows, do not enclose in straight, single quotation marks. Arguments -debug Reports a summary of the flow in progress, including connections and the logs associated with them, to the command window and to the TcFTSIndexer logs in TcFTSIndexer\logs. Run -debug in a separate command window. Copy runTcFTSIndexer -debug -maxconnections Sets a new value for maximum tcserver connections to use at any given time, for example: Copy runTcFTSIndexer -maxconnections=5 -status Checks the status of the indexer and reports the flows running in the indexer. For example, the following shows the status for all the flows: Copy runTcFTSIndexer -status This argument can also be used with the -task argument. For example, the following command shows the status of the objdata:index flow: Copy runTcFTSIndexer -status -task=objdata:index -stop Stops indexing flows that use an interval. Copy runTcFTSIndexer -stop This argument can also be used with the -task argument. For example, the following command stops the objdata:sync flow with intervals: Copy runTcFTSIndexer -stop -task=objdata:sync -service Starts the indexer as a Java Remote Method Invocation (RMI) service in a console, for example: Copy runTcFTSIndexer -service This argument can also be used with the -task argument to run a flow when starting the service, for example: Copy runTcFTSIndexer -service -task=objdata:index -shutdown Shuts down the service after stopping all the flows. Copy runTcFTSIndexer -shutdown -task Runs an indexing task in this format: Copy -task=type:flow-action Flow actions are specific to the type of task. objdata Indexing actions to support object data indexing admin Administrative actions to support clone and merge indexing fourgd Indexing actions to support 4GD multisite Indexing actions to support multi-site published records structure Indexing actions to support structured content indexing -h Displays the help for this utility. objdata flow actions objdata:build_suggester Rebuilds the suggestions dictionary for Solr. This flow is separate from the sync flow. Run objdata:build_suggester if the objdatasyncstep.build_suggester_inline property in the TcFtsIndexer_objdata.properties file is set to false. This action can use the -interval=seconds argument, for example, to rebuild the suggestions dictionary every five minutes (300 seconds): Copy runTcFTSIndexer -task=objdata:build_suggester -interval=300 The interval value must be 300 or greater. Running this flow action with an interval is recommended. You can rebuild the suggestions dictionary once, for example: Copy runTcFTSIndexer -task=objdata:build_suggester objdata:clear Clears existing indexed data, records, and cached files. This option is most often used prior to running objdata:index. When you run -task=objdata:clear, specify one of these options when you are prompted: 1 clears the indexer cache. 2 clears the Solr index. 3 clears the object data indexing records from the Accountability table. 4 clears the data covered by options 1, 2, and 3. 5 clears the UIDs passed in from the Accountability table. When you specify 5, provide the full path to the text file containing the UIDs. 6 cancels the clear flow. 7 cleans up the scratch table records, where the last saved date precedes the last processed date of the subscription table. If you run -task=objdata:clear in an environment that is set to Clone Ready, it fails in order to prevent accidentally clearing the index. Example To clear a list of UIDs, run the command: Copy runTcFTSIndexer -task=objdata:clear At the prompt: Copy Please provide a clear option from above list [1-7]: Enter 5. The prompt returns: Copy Provide full path to input uid text file. Enter the full path and file name: Copy c:\my_uid_directory\uids.txt objdata:clearembedindex Clears data from the Vector database index. objdata:deleteembedindex Deletes the Vector database index. objdata:embed Embeds the indexed file contents included in the configured knowledge bases for use in Teamcenter Copilot. objdata:embed-image Embeds the indexed parts datasets included in the configured knowledge base for use in parts search. objdata:embed_metadata_sync Embeds the already indexed object properties recently marked for embedding according to the Awp0PropIsEmbedded property constant. objdata:embedschema Embeds the indexed object data for use in Natural Language Search. objdata:update_embeddings Updates the Vector schema when upgrading from Teamcenter version 2512 or earlier to Teamcenter version 2606 or later and have embedded documents in the earlier version. objdata:errors Returns the errors for indexing failures to a specified directory. The directory must be empty. You can optionally specify the number of errors to be returned. The default is 50 errors. The error directory contains a directory for each UID of the failed object. Each UID directory contains the following information: Properties such as object name and type provide information on the failed objects. The TC XML and Solr XML files are generated and saved for debugging. Syslog information. TcFTSIndexer log files with the errors. In this example, the first 100 errors are sent to the specified output directory: Copy runTcFTSIndexer -task=objdata:errors d:\TcFTSIndexer\errors 100 objdata:filecontentrecover Indexes pending file contents during file content indexing. objdata:index Indexes data for the time period specified in TC_ROOT\TcFTSIndexer\conf\TcFTSIndexer_objdata.properties without clearing the existing index. For a clean start, first use objdata:clear to clear indexed data and cached files. However, if you run it in a Clone Ready environment, it fails in order to prevent accidentally clearing the index. objdata:indexclone Indexes the specified time period without clearing the existing index. The start time is set to when the Clone Ready state was set. The end time is set in the conf\objdata.properties file. This indexing flow supports the clone and merge indexing approach, which is a method to manage upgrades and patches more efficiently by reindexing a cloned environment and then merging it to an updated production environment. The objdata:indexclone task picks up the delta of indexing changes in the production environment that occurred while the cloned environment was being indexed. This flow depends on the administrative flow actions. objdata:indexdeletionfailures Triggers the sync flow to identify any objects that were deleted from Teamcenter but are still in Solr. objdata:indexfilecontentsyncfailures Indexes synchronization file content failures that required manual intervention. objdata:indexlargeload Queries, stages, and indexes data in chunks for the time period specified in TC_ROOT\TcFTSIndexer\conf\TcFTSIndexer_objdata.properties without clearing the existing index. Use this flow to better handle larger data that may pose challenges for the indexer due to Java heap limitations. objdata:indexsyncfailures Indexes synchronization failures that required manual intervention. objdata:recover Recovers failed indexed objects. If failures are reported during initial indexing, run the recover flow action after initial indexing completes. Recover failures from the initial index by running objdata:recover repeatedly until there are no failures reported or the failures are consistent and need to be fixed. You can choose to fix the errors or leave them for later and proceed with the synchronization flow. If you leave them, these errors are logged as failures during synchronization. You can return at a later time to fix them. The recover flow action operates by time slice. The recover flow action processes all failed objects together. objdata:recoverlargeload Recovers failed indexed objects. If failures are reported during indexlargeload flow action, run the objdata:recoverlargeload flow action after the indexlargeload action completes. Recover failures from the indexlargeload action by running objdata:recoverlargeload repeatedly until there are no failures reported or the failures are consistent and need to be fixed. You can choose to fix the errors or leave them for later and proceed with the synchronization flow. If you leave them, these errors are logged as failures during synchronization. objdata:savedquery Sample flow that indexes data based on uids returned by a saved query. objdata:show Returns objects that are in a specified indexing state in two text files. Specify the state code and a directory for the output files using the form -task=objdata:show n uid_file_dir. The show number to specify the state is 1, 2, or 3: 1 returns objects in the replication pending state. 2 returns objects in the indexing complete state. 3 returns objects in the indexing failed state. In this example, the output files contain the objects that failed indexing: Copy runTcFTSIndexer -task=objdata:show 3 d:\TcFTSIndexer\uid_output The output returns two text files: uid.txt Contains the UIDs of the objects that match the specified state. Each UID is on one line. You can synchronize the objects again using objdata:sync uid_file_dir. Specify the directory containing the uid.txt file, for example: Copy runTcFTSIndexer.bat -task=objdata:sync d:\TcFTSIndexer\uid_output uid_prop.txt Contains UIDs in the output format UID|object_string|object_type, for example: Copy TRa3S5qdSDyB | Breaker Panel Anchor Plate/AP02-A | Physical Part Revision objdata:sync Updates the index with changes to data between the previous run and the current run. The sync action can take the -interval=seconds argument. For example, to synchronize object data using the stand-alone indexer every 300 seconds (5 minutes): Copy runTcFTSIndexer -task=objdata:sync -interval=300 The value must be greater than 0. To run sync once, omit -interval=seconds. The sync action can take a file path to a uid.txt file. You can synchronize the objects again using objdata:sync filepath. Specify the directory containing the uid.txt file, for example: Copy runTcFTSIndexer.bat -task=objdata:sync d:\TcFTSIndexer\uid_output objdata:test Verifies whether the environment is set up correctly prior to running the indexer. Administrative flow actions admin:cloneready Sets the production environment to Clone Ready in preparation for creating a cloned environment. After this action is applied, the cloned environment can be upgraded or patched and then indexed using objdata:index. admin:clonevalidate Confirms that the indexing information in the upgraded production environment and the upgraded cloned environment are the same. Run this flow action to determine whether the production environment is ready for the indexing system to be merged. After the merge, pick up the delta of indexing changes in the upgraded production environment using objdata:index clone. admin:clonecomplete Removes the Clone Ready setting on the indexing system in the upgraded production environment. The environment must have been previously set to Clone Ready. admin:status Provides the means to verify the current clone status of the production environment. Multi-site flow actions multisite:clear Clear indexed data and cached files for existing multi-site published records. Use prior to running multisite:index. multisite:index Without clearing the existing indexed multi-site published records, index for the time period specified in the TC_ROOT\TcFTSIndexer\conf\TcFTSIndexer_multisite.properties file. For example: Copy runTcFTSIndexer -task:multisite:index During indexing, duplicate published records are removed. For a clean start, use multisite:clear to clear indexed data for multi-site published records and cached files. multisite:indexuids Index the UIDs for a specific Object Directory Services (ODS) site. Specify the ODS site name and the directory containing the uid.txt file, for example: Copy runTcFTSIndexer -task=multisite:indexuids ODS_Site_name D:\UID_dir multisite:indexsyncfailures Index synchronization failures that required manual intervention. multisite:sync Updates the index with changes to published record data between the previous run and the current run. The sync action can take the -interval=seconds argument to repeat the sync action at the specified interval. For example, to synchronize multi-site published record data every 300 seconds (5 minutes): Copy runTcFTSIndexer -task=multisite:sync -interval=300 The value must be greater than 0. To run multisite:sync once, omit -interval=seconds. multisite:recover Recovers failed indexed published record objects. If some published records fail during indexing, run the recover flow action after multi-site indexing completes. Recover failures by running multisite:recover repeatedly until there are no failures reported or the failures are consistent and need to be fixed. multisite:test Verify whether the environment is set up correctly prior to running the multi-site indexer. structure flow actions structure:recoverfailures Changes all product configurations with failed states to the ReadyToIndex state or the MarkedForDeletion state. For example: Copy runTcFTSIndexer -task=structure:recoverfailures structure:reset product-configuration-UID Resets the given product configuration UID setting to the ReadyToIndex state or the MarkedForDeletion state. For example: Copy runTcFTSIndexer -task=structure:reset 'goZRkWxoqd$DyB' structure:resetall Downloads the latest transform and schema files, resets all active product configurations to the ReadyToIndex state, and resets all deleted product configurations back to the MarkedForDeletion state. For example: Copy runTcFTSIndexer -task=structure:resetall structure:show Shows a summary of all configured product configurations, for example: Copy runTcFTSIndexer -task=structure:show structure:sync Queues synchronization and delete actions for all product configurations, for example: Copy runTcFTSIndexer -task=structure:sync structure:syncone product-configuration-UID Queues synchronization and delete actions for a single product configuration UID, for example: Copy runTcFTSIndexer -task=structure:syncone goZRkWxoqd12DyB structure:test Verifies that the environment is set up correctly prior to running the indexer, for example: Copy runTcFTSIndexer -task=structure:test 4GD flow actions The 4GD product structure is initially indexed using the bomindex_admin utility. fourgd:reset product-configuration-UID Resets the given 4GD product configuration UID setting to the ReadyToIndex state. For example: Copy runTcFTSIndexer -task=fourgd:reset goZRkWxoqd$DyB fourgd:resetall Downloads the latest transform and schema files, resets all active 4GD product configurations to the ReadyToIndex state. For example: Copy runTcFTSIndexer -task=fourgd:resetall fourgd:show Shows a summary of all 4GD configured product configurations, for example: Copy runTcFTSIndexer -task=fourgd:show fourgd:sync Queues synchronization and delete actions for all 4GD product configurations, for example: Copy runTcFTSIndexer -task=fourgd:sync fourgd:syncone product-configuration-UID Queues synchronization and delete actions for a single 4GD product configuration UID, for example: Copy runTcFTSIndexer -task=fourgd:syncone goZRkWxoqd12DyB Copy ./runTcFTSIndexer.sh -task=strcture:syncone 'Abed$b8dBhGXHA'