bom_expand

Description Expands the bill of materials (BOM) and generates a report on the BOM structure and expansion statistics. You can use this utility to find the total size and depth of a BOM structure as well as the number of lines at each level of the structure. Additionally, you can use this utility to assign in-context IDs to each line in a structure. This is necessary when comparing structures using the accountability check in manufacturing. This utility provides a bomset mode that can help you expand the BOM in equal-sized sets without encountering memory issues. Syntax bom_expand [-u=user-id -p=password | -pf=password-file -g=group] -item=item | -key=item-key [-revision_rule=revision-rule] [-rev=revision] [-saved_variant_rule=saved-variant-rule] [-use_packing] [-show_unconfigured] [-show_unconfigured_variants] [-props=comma-separated-list-of-property-names] [-level_props] [-output=output-filename] [-props= | -props_output= comma-separated-list-of-property-names] [-bom_report_file=report-file-name] [-report_mode= [TOP | LEVEL | FULL]] [-no_verbose] [-mem_debug] [-bom_closure_rule=closure-rule] [-bomset] [-bomset_criteria=[MEMORY | NUMLINES | PERCENT]] [-bomset_help] [-bomset_criteria_data=[Number-of-Lines | PERCENT]] [-bomset_override_data_complexity_preference=[true | false]] [-bomset_use_mem_percentage_preference=percent] [-create_absoccs] [-create_absocc_ids] [-h] Arguments -u Specifies the user ID. This is a user with or without 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 Specifies the item ID for which the associated BOM view revision (BVR) is traversed. (BVRs are associated with revisions corresponding to the specified item.) -key Specifies the key for which the associated BVR is traversed. (BVRs are associated with revisions corresponding to the specified item.) Copy [keyAttr1=keyVal1] [,keyAttr2=keyVal2]…[,keyAttrN=keyValN] To find the key of an object, use the get_key_string utility. For more information, see Introduction to multifield keys in BMIDE for Data Model Design. -revision_rule Specifies the revision rule to use when configuring the BOM window. If this argument is omitted, uses the default revision rule, Latest Working. -rev Specifies the item revision specified by the -item argument. The revision must have an associated BVR. -saved_variant_rule Specifies the variant rule to apply to the BOM window when configuring the BOM. -use_packing Indicates whether the packed lines in the BOM window should be packed or unpacked. -show_unconfigured Indicates whether unconfigured BOM lines are considered for BOM expansion. -show_unconfigured_variants Indicates whether to consider unconfigured BOM lines due to variant conditions for BOM expansion. -props Specifies the set of properties to fetch for BOM structure lines. If the value specified is RAC, fetches all properties required by the rich client. You can also specify a comma-separated list of properties. For example, if you want properties bl_formula and bl_variant_state, specify this argument as -props= bl_formula, bl_variant_state. -level_props Indicates whether to fetch all properties together for a BOM level during expansion. If this flag is absent, fetches properties once for the entire BOM after expansion. -output Directs the output to a specific file by specifying a file name. -props_output Lists BOM line properties separated by a comma that should be written to output. The -props and -props_output arguments are mutually exclusive. -bom_report_file Specifies the report file name, for example, report.csv (CSV file type is preferred). -report_mode Specifies report generation mode. Valid values are: TOP prints expansion report for top node of BOM only. LEVEL prints summary of expansion for all levels in BOM. FULL prints detailed expansion report for each node in BOM. The default mode is LEVEL. -no_verbose Indicates whether to write detailed output to the console. -mem_debug Indicates whether to print additional debug information related to memory usage during BOM expansion. -bom_closure_rule Specifies BOM closure rule to apply to BOM window during BOM expansion. -bomset Indicates whether expansion should be done in equal-sized sets of BOM lines. -bomset_criteria Specifies creation criteria of BOM sets for expansion. Valid values are: MEMORY The BOM is divided and expanded in sets that occupy the same memory. This memory is calculated based on the available system physical memory and BOM size. NUMLINES The BOM is divided and expanded in sets that contain the same number of BOM lines. Use the argument -bomset_criteria_data to specify the number of lines for each BOM set. PERCENT The BOM is divided and expanded in sets that contain the number of lines which are the same percent as the total number of BOM lines in the BOM. Use the argument -bomset_criteria_display to specify this percent. The default is MEMORY. -bomset_help Prints examples for using bomset options. -bomset_criteria_data Specifies data for BOM set creation to use with -bomset_criteria. Valid values are NUMLINES or PERCENT. This argument should be used when -bomset_criteria_data=NUMLINES or -bomset_criteria_data=PERCENT. For example, if you have a 10,000 item BOM and you want it to be divided and expanded in sets each having the size 1,000 items, include the following arguments in your command: -bomset -bomset_criteria=NUMLINES -bomset_criteria_data=1000 If you want a 10,000 item BOM to be divided and expanded in sets that are 10 percent of its size, include the following arguments in your command: -bomset -bomset_criteria=PERCENT -bomset_criteria_data=10 -bomset_override_data_complexity_preference Specifies whether BOM lines have complex data, such as incremental changes and absolute occurrences, which can decide the size of the BOM set when the -bomset_criteria value is set to MEMORY. The valid values are true or false. The default value is false. -bomset_use_mem_percentage_preference Specifies the percent of system memory available to use for expansion. Valid values must be set between 0 and 100. -create_absoccs Creates absolute occurrence appearance path node (APN) objects on a BOM structure during expansion. -create_absocc_ids Creates or uses existing absolute occurrence IDs on a BOM structure during expansion. -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. This utility can generate different output files based on the [-output=output-filename] or the -bom_report_file options. Restrictions This is a debug utility and should only be used for debugging purposes. Examples BOM expansion with properties, using revision rules and variant rules. Copy bom_expand -u=user-id -p=password -pf=password-file -item=item -rev=revision -revision_rule=revision-rule -saved_variant_rule= saved-variant-rule -bom_closure_rule=closure-rule -props=RAC -level_props BOM expansion with out properties, using revision rule and variant rule. Copy bom_expand -u=user-id -p=password -pf=password-file -item=item -rev=revision -revision_rule=revision-rule -saved_variant_rule= saved-variant-rule BOM expansion with properties, using revision rule and variant rule and closure rule. Copy bom_expand -u=user-id -p=password -pf=password-file -item=item -rev=revision -revision_rule=revision-rule -saved_variant_rule= saved-variant-rule -props=RAC -level_props bom_report_file=report-file-name -report_mode=FULL BOM expansion with properties, using revision rule and variant rule and providing output in a file (txt). Copy bom_expand -u=user-id -p=password -pf=password-file -item=item -rev=revision -revision_rule=revision-rule -saved_variant_rule= saved-variant-rule -props=RAC -level_props -output=output-filename BOM expansion with properties, using revision rule and variant rule and closure rule with properties, using revision rule and variant rule and providing BOM report file (csv) (BOM data). Copy bom_expand -u=user-id -p=password -pf=password-file -item=item -rev=revision -revision_rule=revision-rule -saved_variant_rule= saved-variant-rule -props=RAC -level_props bom_report_file=report-file-name -report_mode=FULL BOM expand with BOM set. Copy bom_expand -u=user-id -p=password -item=item_id -bomset bom_expand -u=user-id -p=password -item=item_id -bomset -bomset_criteria=PERCENT -bomset_criteria_data=% of bomlines in a set. Value between 0-100> bom_expand -u=user-id -p=password -item=item_id -bomset -bomset_criteria=NUMLINES -bomset_criteria_data=num of lines in a set bom_expand -u=user-id -p=password -item=item_id -bomset -bomset_override_data_complexity_preference=true/false -bomset_use_mem_percentage_preference=% of system mem which can be used for bomset/expansion. Value between 0 -100. Only valid when -bomset_criteria=Empty value of MEMORY Related Topics Structure Management on Rich Client ─ Usage