bmide_generate_datamodel_doc_report

Generates an HTML data model report of business objects, business rules, and LOVs of the current Teamcenter version. The data model for the report is built using the Business Modeler IDE templates found in the target templates directory specified by the user (for example, TC_ROOT/bmide/templates). You can also generate this report using the Business Modeler IDE. For more information, see Run data model reports in BMIDE for Data Model Design. The data model report consists of the following sections: Overview Provides an overview of the data model report. Template Data Model Provides a list of the template names that contribute to the report. What’s New Provides a list of what has changed in the data model since a previous version. Glossary Provides a glossary of all the data model elements managed by the Business Modeler IDE. Deprecated Provides a list of all libraries and operations that are deprecated. Syntax bmide_generate_datamodel_doc_report -targetTemplatesDir=target-file-path-name [-sourceReleaseVersions=[Tcrelease | all] -outputDir=directory-for-generated-reports [-skip=XML-file-excluded-templates] [-h] Arguments -targetTemplatesDir Specifies the full path to the directory containing all templates from the target version for which the data model report must be generated, such as TC_DATA/model or TC_ROOT/bmide/templates. -sourceReleaseVersions Specifies a comma-separated list of Teamcenter versions to generate a comparison, for example, -sourceReleaseVersions=Tc820,Tc830. For a complete list of the Teamcenter versions to use with the argument, use the -h argument to see the help text for the utility. To generate a report for all versions, specify -sourceReleaseVersions=all. -outputDir Specifies the full path to the directory where the reports must be generated. -skip Specifies a list of templates in the target templates directory to skip during processing. This argument should specify the full path to the XML file that has the list of templates. Following is an example of the XML file format: Copy -h Displays help for this utility. Restrictions Following are the limitations of this utility: This report only generates business objects and classes that are under the Item, ItemRevision, Form, Dataset, and Folder business objects or classes. This report also generates classes that are the form storage classes of any item master form or item revision master form business object. All other classes and business objects are not shown as they are considered internal to the product. Therefore, if you supply your own template in the target directory, only the business objects and classes that fall into these categories are shown in the report. The reporting tool contains a record of all Teamcenter templates that are included with Teamcenter for each prior version. Therefore, when generating the What’s New section, the report is able to accurately generate a comparison of all elements in a target version against a designated former source version. This results in the What’s New comparison displaying new, changed, and removed for each element. Because the reporting tool does not include a record of any other templates, including third-party and customer templates, the report automatically lists all elements from these templates as new in the What’s New section. Disregard the new status because it does not reflect whether the element was really new, changed, or removed. Examples To generate an HTML data model report, enter a command like the following on a single line: Copy bmide_generate_datamodel_doc_report   -targetTemplatesDir=C:\Siemens\config1\tcdata\model   -sourceReleaseVersions=all –outputDir=C:\datamodelreports\tc9.0   -skip=C:\skiplist.xml To generate the What’s New section of the report, choose one or more source versions to compare with the current version, as shown in the following examples: To generate a report that compares the data model, use the following command: Copy bmide_generate_datamodel_doc_report -targetTemplatesDir=C:\Siemens\config1\tcdata\model -sourceReleaseVersions=Tc810 –outputDir=C:\datamodelreports\tc9.0 To skip templates during generation, provide a list of templates in a file. For example, to skip the hrn_template and erp_template templates, use the following skiplist.xml file: Copy To use the skiplist.xml file, run the following command: Copy bmide_generate_datamodel_doc_report -targetTemplatesDir=C:\Siemens\config1\tcdata\model -sourceReleaseVersions=all –outputDir=C:\datamodelreports\tc9.0 -skip=C:\skiplist.xml If a template is skipped, all the templates dependent on it are also be skipped. For example, if template2 is dependent on template1, and template1 is specified in the skip list file, template1 and template2 are both be skipped in the generation of the report. Related Topics BMIDE for Data Model Design