qsearch_process_queue

Updates or queries the spatial indexes used by the cacheless search mechanism. You can also use this utility to modify or query the state of the update queue process that updates these indexes. When using this utility, the term product refers to the item at the top of a structure. If you make the top-level item indexable, the entire structure is indexed. Conversely, the term item or object refers to any item at any level of the structure, for example, one that represents a subassembly. You can specify a product ID in the format -product=product or -product_uid=product. Specify an object ID in a similar format. Syntax qsearch_process_queue [-u=user-id -p=password | -pf=password-file -g=group] [-item_id=item-id-pattern1,item-id-pattern2,item-id-pattern3,... | @filename] {[-list_queue | -list_all_queue]} [-show_queue_oldest_date] [-process_queue] [-process_queue_repeatedly [-delay=N] [-repeat=M]] [-clear_queue] [-force_queue_update Objects] [-force_queue_substructure_update=Objects] [-force_queue_all_leaf_item_updates] [-force_queue_all_possible_updates] [-force_queue_all_necessary_updates] [-force_queue_all_inconsistent_updates [-tolerance=Percentage]] [-ask_global_search_box_delta] [-list_volumes=Objects] [-list_index_boxes=Objects] [-list_structure_index_boxes=Objects] [-list_all_index_boxes] [-clear_indexes] [-clear_structure_indexes=Objects] [-clear_all_indexes] [-clear_queue_processed] [-clear_all_queue] [-check_indexes=Objects] [-check_structure_indexes=Objects [-list_suggested_updates[=filename] | -force_queue_suggested_updates | -follow_only_check_failures [-find_cycles] [-count_occurrencesobjects] [-count_substructureobjects] [-list_legacy_transforms [products]] [-generate_dot_info objects [-nofollow] [-include_indexes] [-include_bboxes] [-include_transforms][-outfile= file]] [-find_datasets_below objects] [-enable_product_scoping] [-disable_product_scoping [-drop_tables]] [-list_products] [-make_indexable [products]] [-make_non_indexable [-silent ] {products | objects | -all }] [-list_indexable {products | objects | -all } [-additional_types=occthread,apn] [-outfile=file]] [-check_indexable {products | objects} [ -below]] [-clear_product_indexes products] [-check_product_indexes [products]] [-dump_substructure] [-task=task-list] [-verbose] [-print_names] [-h] Arguments -u Specifies the user ID. This is a user with Teamcenter administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the -u and -p arguments are authenticated externally through SSO rather than being authenticated against the Teamcenter database. If you do not supply these arguments, the utility attempts to join an existing SSO session. If no session is found, you are prompted to enter a user ID and password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. For more information about managing password files, see Manage password files. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -item_id Specifies a list of item ID patterns to process when you use product-scoped searches. Entries must be separated with commas. You can also supply the item ID patterns in a separate text file, with one item ID pattern per line. In this case, use the file name instead of the list of item ID patterns, preceding it with @. If you do not specify item IDs, all items in the database are processed. -list_queue Lists all unprocessed entries in the queue. -list_all_queue Lists all entries in the queue, including processed entries. -show_queue_oldest_date Shows the creation date of the oldest unprocessed entry in the queue. -process_queue Processes the unprocessed entries in the queue. -process_queue_repeatedly Processes the unprocessed entries in the queue repeatedly. Optionally, you can wait N seconds between process runs (default delay is 5 seconds). You can also specify a maximum of M times for the process to repeat (default is forever). -delay Specifies a delay of N seconds between process runs. -repeat Specifies a maximum of M times for the process to repeat (default is forever). -clear_queue Clears the unprocessed entries from the queue. -force_queue_update Adds an entry to the queue for the specified objects. -force_queue_substructure_update Adds a entry to the queue for the leaf items of the assembly beneath the specified objects. This action updates the entire assembly. -force_queue_all_leaf_item_updates Adds an entry to the queue for all leaf items. This action updates all assemblies. -force_queue_all_possible_updates Adds an entry to the queue for the primary of each TC_bounding_box relation. -force_queue_all_necessary_updates Adds an entry to the queue for the primary of each TC_bounding_box relation that lacks an index. -force_queue_all_inconsistent_updates Adds an entry to the queue for the primary of each TC_bounding_box relation with an apparently inconsistent index. You can optionally specify the percentage inconsistency to ignore, overriding the default value of 10%. -tolerance Specifies the percentage of inconsistency to ignore. -ask_global_search_box_delta Calculates the current global search box delta. -list_volumes For each specified object, lists the total volume occupied by all its contributing bounding-boxes and the total volume of all its index-boxes. -list_index_boxes Lists the index boxes for the specified objects. -list_structure_index_boxes Lists the index boxes for all possible configured structures for the given objects. -list_all_index_boxes Lists the index boxes for all objects. -clear_indexes Removes the indexes from the specified objects. -clear_structure_indexes Removes the indexes for all possible configured structures from the specified objects. -clear_all_indexes Removes the indexes from all objects. -clear_queue_processed Clears the processed entries from the queue. -clear_all_queue Clears all entries from the queue, that is, both processed and unprocessed entries. -check_indexes Checks the indexes for the specified objects. -check_structure_indexes Checks the indexes for all possible configured structures for the specified objects. If you specify -list_suggested_updates, the utility lists the objects for should be updated to fix any incorrect indexes detected for the structure. The list is written to the specified file or stdout if no file is specified. The file is written in a format suitable for qsearch_process_queue -force_queue_update -uid=@filename. If you specify -force_queue_suggested_updates, the utility adds entries to the queue to fix any incorrect indexes detected for the structure. If you specify -follow_only_check_failures, the utility assumes that if the indexes of the specified object are correct, the indexes for the entire substructure are also correct. -find_cycles Finds all cyclical structures. -count_occurrences Counts all occurrences in all structures of all items. Optionally, you can just count all occurrences of specified objects. -count_substructure Counts the substructure of all root items. Optionally, you can just count the substructure of specified objects. -list_legacy_transforms Lists all legacy transforms for all items in the database. Optionally, you can specify one or more products and the utility lists only legacy transforms for items in the specified products. -generate_dot_info Generates information about one or more specified objects and their ancestors in dot format suitable for post-processing to show cycles. Optionally, you can specify -nofollow to include only information about the specified objects' immediate ancestors. If you use the output dot file for post-processing to detect cycles, ensure you specify all items you expect to be part of the cycles in the objects argument, otherwise do not use this option. You can optionally include information about the indexes, bounding-boxes, and transforms in the dot file. You can optionally specify the name and location of the output file, otherwise the information is written to stderr. -find_datasets_below Return all datasets below one or more specified objects. -enable_product_scoping Limits searches to a specified product. -disable_product_scoping Disables the limiting of searches to a specified product. Optionally, you can also drop the indexability tables associated with the product scoped search. -list_products Lists all products available for scoped searches. -make_indexable Populates the indexability tables with data necessary to make the specified product or products searchable. -make_non_indexable Removes data associated with the specified products or objects from the indexability table, so making them unsearchable. You can also make all products and objects unsearchable. By default, you are prompted for confirmation but if you specifiy the -silent argument, no confirmation is necessary. -list_indexable Lists the contents of the indexability tables associated with the specified products or objects. You can also list the contents for all products and objects. By default, all indexable item IDs are listed. Optionally, you can generate a comma-separated list of occurrence threads, appearance path nodes (APNs), or both. By default, the list is written to stderr but you can optionally specify the name and location of an alternate output file. -check_indexable Checks the indexability tables contain all the data necessary to index the specified products or objects. Optionally, you can specify the -below argument to check everything below a specified object, rather than just the object. -clear_product_indexes Remove the indexes from the specified product or products. -check_product_indexes Checks the indexes for the specified product or products. -dump_substructure Displays a list of item UIDs under the item ID specified by the -item_id argument. -task Specifies a task list of multiple arguments. Omit the leading dashes and separate entries with commas. For example: -task=list_queue,process_queue -verbose Runs the utility in verbose mode to display the maximum amount of information. Typically, nonverbose utility sessions only display error messages. -print_names Prints item IDs and names as well as UIDs. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. Files As specified in Log files produced by Teamcenter. Restrictions Where appropriate, objects may be specified as a list of UIDs or a list of item ID patterns, as follows: A list of UIDs must be preceded by -uid= and entries separated with commas: Copy -uid=uid1,uid2,uid3,... You can also supply the UIDs in a separate text file, with one UID per line. In this case, use the file name instead of the list of UIDs, preceding it with @: Copy -uid=@filename A list of item ID patterns must be preceded by -item_id= and entries separated with commas: Copy -item_id=item-id-pattern1,item-id-pattern2,item-id-pattern3,... You can also supply the item ID patterns in a separate text file, with one item ID pattern per line. In this case, use the file name instead of the list of item ID patterns, preceding it with @: Copy -item_id=@filename Examples The following example lists all unprocessed entries in the queue: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -list_queue The following example adds an entry to the queue for each of the objects listed in the c:\temp\objfile.txt file: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -force_queue_update -uid=@c:\temp\objfile.txt The following example checks the indexes for all objects that have an item ID prefixed with 123: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -check_indexes -item_id=123* The following example lists the unprocessed entries in the queue and then processes them: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -task=list_queue,process_queue Resolving circular references Some assemblies may contain circular references (cycles). If cycles exist in an assembly, you may encounter poor performance when creating indexes and running searches. If so, use this utility with the find_cycles argument to identify all such cycles. You should then remove the cycles manually before executing other cacheless search utilities. You should also identify why these cycles are created and establish a process to prevent the creation of more cycles. You can run the utility with the find_cycles argument against a single item or the entire database, as shown in the following examples. Processing the entire database: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -find_cycles 2> c:\temp\list_of_cycles.txt Processing a single item: Copy qsearch_process_queue -u=Tc-admin-user -p=password -g=group -find_cycles -item_id=AKT75443 Note The utility output is written to standard error and you should redirect it to a file. For example, specify 2< c:\temp\list_of_cycles.txt, as shown in the first example. The output format is similar to the following example: Copy Cycle begins ============ Y31VRf_fQyYmUC AKY43846-LV2.X 1C PROFILE SECTIONS YW7VRf_fQyYmUC AKY43841-LV2.X 1C Y_SECTIONAL VIEW i7OlXf0fgzknZC ATR04589-T04A WS LWR AT CL h38NawpPQyYmUC AKT75443-TOTAL VEHICLE i01NNpCxQyYmUC AKU25433-VEHICLE INTEGRATION MODULE ii2NNpCxQyYmUC AKU25441-COMPARTMENT VEHICLE yP2Vwa5kQyYmUC AKY08647-LV2.X HYB CDH 1B GA XFwVwmjAQyYmUC AKY10317-LV2.X CDH STRUCTURE REF ASM LZ8Vw$FeQyYmUC AKY27566-LV2.X HYB CDH MIKE FRAEYMAN PART iiMl7dfigzknZC ATR05553-IA-CDH-REAR COMPT-MM VH1VB_7gQyYmUC AKY41691-CDH RR RAIL U/B SI aC6VRf_fQyYmUC AKY43866-LV2.X HYB CDH 1C GA

Cycle ends ============== To report cycles found when you execute an attribute search in Structure Manager or Design Context, set the QS_START_CIRCULAR_STRUCTURE_CHECK_SIZE and QSEARCH_DEBUG_TEXT user preferences to 1. The output report format in this mode is as follows: Copy >>>> Found cyclic structure.UnconfiguredStep: STUDY MODULE ( 68342) - 0 -- 0 - 76915 (VPPS_20 STUDIES CHASSIS) ( zMMNRX46gzknZC) -- 77314 (E1JNRX46gzknZC) -- 0 --- 75941 (STUDY-GMT172/7 SPARE TIRE) ( SQ$Jb7D_QyYmUC)-- 76845 ( zc6J7309QyYmUC) -- 0 --- 73558 (TOTAL VEHICLE) (xTw01mOJgzknZC) -- 75523 ( jh3Jd9saQyYmUC) -- 0 --- 70375 (STUDY MODULE) ( RXw01mOJgzknZC) -- 71949 ( RuEFkrRSgzknZC) -- 0 --- 68342 (STUDY MODULE) ( TEHNRX46gzknZC) -- 69364 ( U1ONRX46gzknZC) -- 0 --- 67615 (VPPS_40 STUDIES INTERIOR) ( zkMNRX46gzknZC) -- 67831 (ExNNRX46gzknZC) -- 0 --- 65940 (STUDY GMT172/177 FD SPEAKER PKG) ( THyJbqzAQyYmUC) -- 66630 (DVzNwd24QyYmUC) -- 0 --- 63228 (IA-FRT S/D HARDWARE LH 1&2LA00) (jEDBpNkogzknZC) -- 64916 ( lt4JbqzAQyYmUC) -- 0 --- 61430 (BOLT) ( wT1FNGA$QyYmUC) -- 62442 ( RdHFgSL$gzknZC) -- 0 --- To clean up the cycles, search for the associated item in My Teamcenter. Do not perform a where used search or browse in Structure Manager because the applied revision rule prevents you from finding the items. When you find the item, send the associated BVR to Structure Manager and manually remove the cycle. In the previous example, look in the My Teamcenter View folder for every revision of item AKY43866-LV2.X HYB CDH 1C GA and remove the cycles in Structure Manager as you find them. Related Topics Structure Management on Rich Client ─ Usage