generate_admin_data_report

Generates a report showing the specified administration data for the site where you run the utility or for an export package. The export package can be from a remote site. The report contains HTML pages for the administration data objects, showing their properties with hyperlinks to referenced objects. If an object is referenced by other objects, its HTML page contains a where-used table that indicates the categories and objects that have references to the current object. The report has a summary showing all the administration data types included in the report and the instances of each element present within the category. The report also has a glossary page with descriptions of the administration data categories and the elements available in each of the categories. Syntax generate_admin_data_report -u=user-ID {-p=password | -pf=password-file} -g=group -adminDataTypes=Admin-data1,Admin-data2,…,Admin-dataX | all [-inputPackage=input-package-path] -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 Teamcenter Utilities in Teamcenter help. This argument is mutually exclusive with the -p argument. -g Specifies the group associated with the user. -adminDataTypes Specifies the types of administrate data to include in the compare report. You provide the data types as a comma-separated list (no spaces). You may also specify the all value to include all data types defined in the local system or the specified input package. Tip Use the -listTypes argument 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. -inputPackage Specifies the full path, including the file name, of the export administration data package from the site for which the report is generated. If you do not specify this argument, the utility generates a report for the local site. -outputDir= Specifies the path to directory where you want the report saved. You must specify this argument. -listTypes Displays a list of the available administration data types that you can include in the report. -h Displays help for this utility. Environment As specified in Manually configure the Teamcenter environment in Teamcenter Utilities in Teamcenter help. 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_SCRIPT_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 Examples Generate a list of the administration data types that you can export: Copy generate_admin_data_report -u=admin-username -p=admin-password -g=dba -listTypes Generate a report containing the preferences and their values at the local site: Copy generate_admin_data_report -u=admin-username -p=admin-password -g=dba -adminDataTypes=Preferences -outputDir=C:\temp\admin_data\siteA\preferences_report Generate a report containing the Access Manager and Organization administration data from an export package of a remote site: Copy generate_admin_data_report -u=admin-username -p=admin-password -g=dba -adminDataTypes=AccessManager,Organization -inputPackage=C:\temp\admin_data\siteB\siteB.zip -outputDir=C:\temp\admin_data\siteB\am_and_organization_report Related Topics TC XML and PLM XML Configuration for Data Import and Export Multi-Site Collaboration