data_report

Gathers data from participating Multi-Site sites in the federation and generates reports on data inconsistencies. Reports are generated for individual sites and for the overall Multi-Site federation. This data is presented in the Active Workspace Multi-Site Assistant. (When working with the data_report utility, sites in the federation are the sites defined by MS_Dashboard_Supported_Sites.) Syntax data_report -u=user-ID {-p=password | -pf=password-file} -g=group [-site=site-name] [-dir=report-directory] [-format=report-format] [-sql_file=sql-file-name] [-include=included-report-categories] [-exclude=excluded-report-categories] [-date_format=date-filter-type [-from=start-date] [-to=end-date]] [-object_type=type] [-f={collect_data | generate_report}] [-h] Arguments -u Specifies the user ID. The user must have administrative privileges. 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 user's password. This argument is mutually exclusive with the -pf argument. -pf Specifies the password file. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. -site Specifies the name of a specific site for which data is gathered and a report is generated. If no site is specified, reports are generated for all sites and the overall Multi-Site federation (as defined by MS_Dashboard_Supported_Sites). -dir= Specifies directory in which reports are saved. By default, reports are saved in the location specified by TC_TMP_DIR. -format Specifies the format for reports. Valid values are csv (the default) and json. -sql_file Specifies a JSON file containing custom SQL data queries or predefined filters. -include Specifies the categories of issues to include in reports. Valid values are itemOwnershipReports, duplicateIDReports, and objectOwnershipReports. By default, all listed categories are included. Multiple values must be separated by commas. The objectOwnershipReports analysis uses the external closure rules defined in MSA_ObjectOwnershipCR. As the objectOwnershipReports analysis may take significant time, consider first running data_report excluding objectOwnershipReports, and then later running only the objectOwnershipReports. -exclude Specifies the categories of issues to be excluded from reports. Valid values are itemOwnershipReports, duplicateIDReports, and objectOwnershipReports. Multiple values must be separated by commas. -date_format When specifying a reporting date range, -date_format specifies the date type. Valid values are creation (the date the object was created) and last_modified (the date the object was last modified). -from Used with -date_format to specify, inclusively, the start date and time for reporting. The format of the date is “YYYY-MM-DD HH:MM:SS” and must be inside the double quotes due to the space between the year and the hour. -to (Optional) Used with -date_format to specify, inclusively, the end date and time for reporting. The format of the date is “YYYY-MM-DD HH:MM:SS” and must be inside the double quotes due to the space between the year and the hour. If not given, the current date and time is used. -object_type Specifies an object type to be included in the report. All item and item subtypes are included. -f Specifies the function that data_report should perform. Valid values are collect_data (gather updated data from sites) and generate_report (generate reports based on gathered data). By default, data_report performs both actions. -h Displays help for this utility. Examples Required log-in information is omitted from the following examples. Gather data and generate reports for all sites defined by MS_Dashboard_Supported_Sites: Copy data_report Gather data for a specific site: Copy data_report -site=site01 -f=collect_data Generate reports for all sites and the Multi-Site federation using data previously collected: Copy data_report -f=generate_reports Generate reports for all sites and the Multi-Site federation for only specific categories of issues: Copy data_report -include=itemOwnershipReports,duplicateIDReports Gather data and generate reports for a specific site for a specific time period: Copy data_report -site=site01 -date_format=creation -from="2020-06-01 00:00:00" -to="2020-06-30 23:59:59" Gather data and generate reports for all sites and the Multi-Site federation using custom SQL data queries: Copy data_report -dir=d:\reports -sql_file=d\reports\msPredefinedSQLs.json