bomindex_admin

Adds structured content to the search index. Syntax bomindex_admin [-u=user-id {-p=password | -pf=password-file} -g=group] -logfile=location_of_logfile -function=[create | delete | list | upgrade] -inputfile=location_of_inputfile Arguments -u Specifies the user ID. This is a user with administration privileges. Note If Security Services single sign-on (SSO) is enabled for your server, the user and password 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. -pf Specifies the password file that holds the cleartext or encrypted password. For enhanced security, use a password file instead of the password. If the -pf argument is not used, the system uses the given password. -p Specifies the password. This argument is mutually exclusive with the -pf argument. -g Specifies the group associated with the user. If used without a value, the user's default group is assumed. -logfile Specifies the location of the log file written by the utilities. You can specify a different location for each utility. -function=function-name Performs the following functions: create Creates the BOMIndexAdminData objects based on the input file. delete Finds the BOMIndexAdminData objects in the input file and marks them as deleted. list Creates the input file for update or delete operations for existing BOMIndexAdminData business objects. The generated file also reports BOMIndexAdminData properties such as window-uid. upgrade Upgrades the definition of BOM index tables when the property set is modified. -inputfile Specifies the location of a file containing the list of structure objects to index. The input file line format is as follows: item-query-string | item-revision-ID | base-revision-rule | effectivity-unit | effectivity-end-item-query-string | effectivity-date (dd-mmm-yyyy hh:mm:ss) | variant-rules | subscribers | closure-rules An example of an input file (bomindex_admin_input.txt): Copy item_id=HDD-0527 | B | Any Status; Working | 5 | item_id=HDD-0527 | 31-May-2013 00:00:00 | vrule1:item_id=OwnItem1:B,vrule2:,vrule3:item_id=OwnItem3:A | MMV | closurerule1 effectivity-unit If you have multiple effectivity units, their numbers must be comma-separated. Also, you must repeat the effectivity end item query string for each effectivity unit, for example: Copy | 5,10,12 | item_id=HDD-0527,item_id=HDD-0527,item_id=HDD-0527 | The maximum number of effectivity units you can specify is 960. variant-rules The variant rules (also known as saved variant rules) are comma-delimited, and follow this format: SVR-name:owning-item-query-string:owning-itemrevision-ID The topline item revision is the default owner. The maximum number of saved variant rules you can specify is 960. subscribers (Optional) You may specify: VDS Specifies that this product configuration is indexed for viewing using the Visualization Data Server. This makes the structure available faster in visualization. VDS requires deployment of the Visualization Data Server. closure-rules (Optional) If a closure rule is applied for a configuration, content in the structure (excluded by the closure rule) does not appear in where used query results for top-level contexts. structure-type (Defunct) The type of structure that the product represents. OCC is the only valid value. owning-user (Optional) If Visualization for MMV is enabled for the product, specify the user who owns the MMV delta collection dataset. MMVIdxAccessControllers (Optional) Specify the users that control access to MMV index files. How to specify owning user and MMVIdxAccessControllers Each VDS site can be configured to run as a different user. BOMIndexAdminData table entries are returned according to the permission specified for the configured VDS user. This helps you implement export compliance using these attributes. Example Site owners configured for each VDS site: USA is VDSadmin Mexico is mex_VDSadmin Canada is can_VDSadmin China is chi_VDSadmin BOMIndexAdminData (BIAD) entries are defined as follows: BIAD Product Revision Rule Structure Type MMV Owning User MMV Access Users Biad1 Ship Latest Working BVR VDSadmin mex_VDSadmin can_VDSadmin Biad2 Truck Latest Working BVR VDSadmin mex_VDSadmin can_VDSadmin chi_VDSadmin Biad3 Car Latest Working BVR VDSadmin chi_VDSadmin To summarize the access for each VDS site: USA site user VDSadmin Access to Biad1, Biad2, and Biad3 because it is specified as the MMV owning user. Mexico site user mex_VDSadmin Access to Biad1 and Biad2 only. No access to Biad3. Canada site user can_VDSadmin user Access to Biad1 and Biad2 only. No access to Biad3. China site user chi_VDSadmin user Access to Biad2 and Biad3 only. No access to Biad1. Example The following command creates a search index of structures: Copy bomindex_admin -u=username -p=password -g=dba -logfile=C:\Scratch\log\log1.txt -function=create -inputfile=C:\Scratch\log\bomindex_admin_input.txt Overriding effectivity When you want to specify override effectivity, do not specify it in the input file containing the product configurations to index. The override effectivity in the input file is ignored during index generation, causing a discrepancy between the indexed BOM and the BOM in use. To set override effectivity during index generation, add the effectivity data to a Revision Rule. For example, the Revision Rule might contain: Z_ACE_DateOverride_Rule23_10Jan2020 which includes entries for the effective date 10-Jan-2020 00:00:00. The corresponding input file entry for bomindex_admin would have this corresponding effectivity override entry: item_id=ACE_KK_EC01 | A | Z_ACE_DateOverride_Rule23_10Jan2020 | | | | | |