generate_admin_data_compare_report

Generates an interactive report of differences between administration data in two Teamcenter environments. To make the comparison, the utility requires an administration data export package from one environment as a source, and either the local environment or another administration data export package as a target. If data is the same in both the source and the target, the report shows that there are no differences. If an object is referenced by other objects, the report includes a where-used table that indicates the categories and objects that have references to the current object in both source and target environments. The report summary page shows all the administration data types included in the comparison and the number of differences for each element present within the category. The report includes a glossary of administration data categories and the elements available in each of the categories. Syntax generate_admin_data_compare_report -u=user-ID {-p=password | -pf=password-file} -g=group -sourcePackage=path-to-source-package -targetPackage=path-to-target-package | -extractAndCompare -adminDataTypes={Admin-data1,Admin-data2,…,Admin-dataX | all} -outputDir=path-to-directory-for-report-files [-listTypes] [-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. 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. -sourcePackage Specifies the full path, including the file name, of the source administration data package. -targetPackage Specifies the full path, including the file name, of the target administration data package. This argument is mutually exclusive with the -extractAndCompare argument. -extractAndCompare Extracts the administration data from the current environment and compares it with source package identified by the -sourcePackage argument. This argument is mutually exclusive with the -targetPackage argument. -adminDataTypes Specifies the types of administration data to include in the report. You provide the data types as a comma-separated list (no spaces) or you can specify all to get all supported data types in the report. Tip Use the -listTypes and -sourcePackage arguments to get a list of available administration data types. If the report contains multiple data types, it includes a where-used table showing where each object is referenced. -outputDir Specifies the path to directory where you want the compare report saved. You must specify this argument. -listTypes Displays a list of the administration data types at the source that you can compare to the target. You must specify the -sourcePackage argument. -h Displays help for this utility. Environment As specified in Setting up a Teamcenter command-line environment. This is a Java utility that, by default, has the maximum Java heap size set to 1024M. For reports that contain a large number of objects, you may need to increase maximum Java heap size to avoid out-of-memory errors or poor performance. If possible, set the maximum heap to at least to 4096M for large reports. You can set this value using the BMIDE_SCRIPT_ARGS environment variable, for example: Copy set BMIDE_SCRIPTS_ARGS=-Xmx4096M Note Java standards require that no more than 25 percent of total RAM be allocated to virtual memory (VM). If the amount allocated to the Java VM exceeds this percentage, degradation of performance can occur. Files As specified in Log files produced by Teamcenter. Examples Display a list of the administration data types that you can compare to the source environment package: Copy generate_admin_data_compare_report -u=admin-username -p=admin-password -g=dba -sourcePackage=C:\temp\admin_data\SiteA\siteA.zip -listTypes Generate a comparison report of the preferences at the source and target: Copy generate_admin_data_compare_report -u=admin-username -p=admin-password -g=dba -sourcePackage=C:\temp\admin_data\siteA\siteA.zip -targetPackage=C:\temp\admin_data\siteB\siteB.zip -adminDataTypes=Preferences -outputDir=C:\temp\admin_data\compare_sites_A_and_B_preferences Generate a comparison report of the organization data at the source and target: Copy generate_admin_data_compare_report -u=admin-username -p=admin-password -g=dba -sourcePackage=C:\siteA\siteA.zip -extractAndCompare -adminDataTypes=Organization -outputDir=C:\temp\admin_data\compare_organization_between_local_and_A Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration