bom_roll_up_report

Creates BOM properties rollup reports. The reports can be created systematically by a task scheduler to generate weekly or daily reports to track property changes of assembly structures. Syntax bom_roll_up_report [-u=user-id -p=password | -pf=password-file -g=group] {[-item=item | [-key=[keyAttr1=keyVal1] [,keyAttr2=keyVal2…,keyAttrN=keyValN]]]} [-rev=revision] [-revrule=revision-rule]} [-effdate=mm:dd:yyyy:HH:MM:SS | now | today] [-varrule=variant-option] [-name=name] [-desc=description] -template=name:scope-context [-folder] [-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 Specifies the item to be used as the root line for the BOM properties rollup report. -key Specifies the key to be used as the root line for the BOM properties rollup report. Use the following format: 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. -rev Specifies the item revision to be used as the root line for the BOM properties rollup report. If this argument is omitted, the report is based on the latest revision of the item. -revrule Specifies the revision rule to use when creating the BOM properties rollup report. If this argument is omitted, the default revision rule, LATEST_WORKING, is used. -effdate Specifies the date to use when configuring the effectivity of the assembly structure. If this argument is omitted, no effectivity date is set. mm specifies the month (01–12) dd specifies the day (01–31) yyyy specifies the year (0001–9999) HH specifies the hour (00–23) MM specifies the minute (00–59) SS specifies the second (00–59) -varrule Specifies the variant option set to use when setting the variant options of the assembly structure. If this argument is omitted, default variant options are used or no options are set. -name Specifies the name of the BOM properties rollup report. If this argument is omitted, an auto-generated name is created. -desc Contains a description of the BOM properties rollup report. If this argument is omitted, an autogenerated description is created. The autogeneration occurs only if a default description is defined in the BOM properties rollup template that was used to create the report. -template Specifies the name and scope context of the BOM properties rollup template to use when creating the BOM properties rollup report. Scope context is the user, group, or site scope identifier. -folder Indicates that the system is to place the new BOM properties rollup report dataset into the users Newstuff folder. If user privileges do not allow for BOM properties rollup report datasets to be attached to item revisions, the report is placed in the user's Newstuff folder. -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 None. Examples The following example creates a BOM properties rollup report with autologin, autogeneration options, and attaches the report to the item revision: Copy bom_roll_up_report -item=12345678 -template="masstemplate:engineering" The following example creates a BOM properties rollup report with autologin, autogeneration options, and attaches the report to the Newstuff folder: Copy bom_roll_up_report -item=12345678 -template="masstemplate:engineering" -folder The following example creates a BOM properties rollup report with autologin, but with no autogeneration options: Copy bom_roll_up_report -item=12345678 -rev=B -name="My Report" -desc="Validating mass values." -template="masstemplate:engineering" The following example creates a BOM properties rollup report with autologin and configures the assembly: Copy bom_roll_up_report -item=12345678 -rev=B -revrule="Released" -effdate=02:20:2006 -varrule="High performance option set" -name="My Report" -desc="Validating mass values." -template="masstemplate:engineering" Related Topics Structure Management on Rich Client ─ Usage