item_report

Generates detail reports of an item or multiple items at the site level. The site level reports can be merged to generate a combined status output. Using this utility, a site can investigate item consistency and dual ownership. It also provides information about the last modified user, locked information and details about the checkout user (owning and remote checkout). Checkout information includes the checkout user, respective checkout date, and time information. Syntax item_report [-u=user-id {-p=password | -pf=password-file} -g=group] [-f=report | merge] [-itemidsfile=data-file | -itemKeyFile=file-name] | -grmtypefile=grm-file | [-item_id=itemids | -key=[keyAttr1=keyVal1] [,keyAttr2=keyVal2]…[,keyAttrN=keyValN]] [-mergelist=file1,file2,...] | [-mergefiles=merge-list-file-name] [-sites_list=site1,site2,...] | [-sites_file=site-list-file-name] [-file=file1] [-file=file2] [-file=file3] [-remove_consistent] [-show_rco] [-include_bom] [-includefoldercontent] [-delimiter=delimiter] [-anchorfile=anchor-file-name] [-traverseditemfile=outname] [-outfile=file-name] [-skipItem] {-start_creation_date=creation-date -end_creation_date=creation-date | [-start_modification_date=modification-date -end_modification_date=modification-date] | [-start_release_date=release-date -end_release_date=release-date] } [-sort_by=item_id | item_name | date] [-dataset_version=latest | all] [-out_item_revs_file=output-file] [-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. -function Specifies one of the following functions: report Parses object information to a report file. This is the default. merge Parses input from a set of input files as specified by the mergelist argument. -itemidsfile Specifies a data file containing comma-separated values (CSVs) or carriage return/line feed separated item IDs. -item_id Specifies a list of comma-separated values of item IDs. -key Specifies the keys of the items on which to 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 BMIDE for Data Model Design. -itemKeyFile Specifies the name of the file containing the keys on which to report. The file format is: Copy -key = [keyAttr1=keyVal1][keyAttr2=keyVal2]… -key =[keyAttr1=keyVal1][keyAttr2=keyVal2]… -key =[keyAttr1=keyVal1][keyAttr2=’keyVal2’]… -grmtypefile Specifies a data file containing comma-separated values (CSVs) or carriage return/line feed separated grmrelations. -mergelist Specifies a comma-separated list of files from individual sites in the same order as specified by the sites_list argument. -mergefiles Specifies a file containing a list of reports from individual sites in the same order as specified by the sites_list argument. -sites_list Specifies a comma-separated list of sites to be analyzed when using the report function. This option is ignored when using any of the date-range arguments. -sites_file Specifies a file containing a list of sites to be analyzed when using the report function. This option is ignored when using any of the date-range arguments. -remove_consistent Specifies that the utility does not output consistent items in the merged report. -show_rco Specifies that the utility displays remote checkout information. By default, this information is not displayed. -include_bom Specifies that the utility traverses to the end of the item revisions of PSOccurrences. By default, this action is not performed. -includefoldercontent Specifies that the utility includes the contents of folders. By default, folders are not processed. -delimiter Specifies the delimiter used in the output file. By default, the commercial at symbol (@) is used. Ensure the delimiter for site-based files matches the merge file input file. -anchorfile Specifies the output file of UIDs of revision anchors. This file is used as input to the purge_dataset utility. -traverseditemfile Specifies an output list of traversed item IDs when using the include_bom argument. -outfile Specifies an output file. -skipItem Specifies that items are to be skipped. -start_creation_date Specifies the creation from date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, 01-Jan-2007 00:00:00. This argument is used with the end_creation_date argument. -end_creation_date Specifies the creation to date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, Jan-2007 00:00:00. This argument is used with the start_creation_date argument. -start_modification_date Specifies the modification from date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, Jan-2007 00:00:00. This argument is used with the end_modification_date argument. -end_modification_date Specifies the creation to date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, Jan-2007 00:00:00. This argument is used with the start_modification_date argument. -start_release_date Specifies the released from date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, Jan-2007 00:00:00. This argument is used with the end_released_date argument. -end_release_date Specifies the released to date. The date is entered in dd-mmm-yyyy hh:mm:ss format, for example, Jan-2007 00:00:00. This argument is used with the start_released_date argument. -dataset_version Specifies whether all or the latest version of the dataset needs to be reported. If this argument is not specified, the utility uses the default value of all. -sort_by Specifies one of the following attributes by which the items are processed: date item_id item_name If this argument is not specified, the utility uses the default value of item_id. -out_item_revs_file Specifies an output file for item revisions. You can use this file as an input to the delete_pdm_data utility. The following is an example of an output item revision file: Copy ABC000075/A ABC000074/A ABC000092/A ABN000002/A ABN000011/A ABN000058/A -h Displays help for this utility. Restrictions None. Examples To create reports for the latest dataset versions created between 01-jan-2007 and 01-jan-2008, write the report file to c:\temp\reports.txt and write the reported item revisions to c:\temp\itemrevs.txt: Copy item_report -u=Tc-admin-user -p=password -g=group -start_creation_date="01-Jan-2007 00:00:00" -end_creation_date="01-Jan-2008 00:00:00" -outfile=c:\temp\reports.txt -out_item_revs_file=c:\temp\itemrevs.txt Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration