Teamcenter s manufacturing process management 8.3 Report Generator Guide Publication Number PLM00064 E
Proprietary and restricted rights notice This software and related documentation are proprietary to Siemens Product Lifecycle Management Software Inc. 2010 Siemens Product Lifecycle Management Software Inc. All Rights Reserved. All trademarks belong to their respective holders. 2 Report Generator Guide PLM00064 E
Contents Proprietary and restricted rights notice......................... 2 Getting started............................................ 1-1 Before you begin............................................. 1-1 Report Generator interface..................................... 1-2 Basic concepts for using Report Generator.......................... 1-4 Basic tasks using Report Generator............................... 1-4 Generating and working with reports.......................... 2-1 Generate a new report......................................... 2-1 Viewing reports............................................. 2-1 Export a report.............................................. 2-2 Regenerate a report.......................................... 2-2 Saving a report.............................................. 2-3 Viewing a saved report........................................ 2-3 Print a report............................................... 2-4 Customizing reports.......................................... 2-4 Creating custom report layouts.................................. 2-4 Using default reports....................................... 3-1 Creating cost reports.......................................... 3-1 Glossary.................................................. A-1 Index................................................. Index-1 PLM00064 E Report Generator Guide 3
Chapter 1 Getting started Before you begin............................................. 1-1 Report Generator interface..................................... 1-2 Report Generator list...................................... 1-2 Report Generator buttons................................... 1-2 Teamcenter rich client perspectives and views..................... 1-3 Basic concepts for using Report Generator.......................... 1-4 Basic tasks using Report Generator............................... 1-4 PLM00064 E Report Generator Guide
Chapter 1 Getting started Use Report Generator to generate reports from the Manufacturing Process Planner or Part Planner application. You can view the generated reports in HTML using a Web browser. Because the reports are displayed in a Web browser, you can share them for viewing with others in your organization who may not have access to the Manufacturing Process Planner or Part Planner application. Some default reports are available in Report Generator and are intended to represent an introduction to the types of reports that can be generated. Use the XSL files provided with the software as examples for creating your own customized reports to better meet your business objectives. Before you begin Prerequisites Enable Report Generator Configure Report Generator Start Report Generator Confirm that your system administrator has completed configuration of the Java environment for your system and set up the JT viewer, as described in Getting Started with Manufacturing. You must have Microsoft Internet Explorer 6.0 or Firefox 2.0 or later installed to view the reports. Report Generator is installed when you install the rich client. Report Generator does not need to be enabled. If it is installed and meets the prerequisites, the application is available and ready to use. Report Generator does not need to be configured. After it is installed, it is ready for use. You can start Report Generator by performing either of the following: In the navigation pane, click the Report Generator button. In Manufacturing Process Planner, perform the following steps: 1. Select an object in the tree hierarchy and ensure the data pane is visible. 2. Perform one of the following: PLM00064 E Report Generator Guide 1-1
Chapter 1 Getting started Click the Report data pane. Send the object to the Report Generator application by choosing Report Generator from the shortcut menu. In the navigation pane, select an object and drop the object on the Report Generator button. Note You must transfer data from Manufacturing Process Planner, Part Planner, or Plant Designer to Report Generator to enable the function buttons in Report Generator. If you click the Report Generator button from the navigation pane without first selecting an object from Manufacturing Process Planner, Part Planner, or Plant Designer, no function buttons are available in the Report Generator window. Report Generator interface All Report Generator menus are standard Teamcenter rich client menus except for those described here. For additional information, see the Rich Client Interface Guide. Report Generator list List name Type Description Helps select the type of report to generate. The type of object currently selected in the Manufacturing Process Planner or Part Planner determines which default reports are available. Report Generator buttons Button Generate Report Export Report Description Generates the report and displays it in the HTML browser. When you generate the report, XML data is generated and all related datasets are downloaded. Prompts for a location to save both the report and its associated files. Then it produces the report and displays it in the HTML browser. 1-2 Report Generator Guide PLM00064 E
Getting started Button Regenerate Report Save Current Report View Existing Report Description Regenerates a report that was previously generated with the Generate Report button. This provides a faster method for displaying a previously generated report because no new XML data is created. The XML data from the original generation is used. This function is available only for reports that are already generated. Saves the report of the type currently selected in the Type list. It is saved as a CME_Report data item to the selected process, product, or plant object. This function is available only for reports that are already generated. Displays the latest saved report of the type currently selected in the Type list. Teamcenter rich client perspectives and views Within the Teamcenter rich client user interface, functionality is provided in perspectives and views. Use perspectives and views to rearrange how the functionality is presented. Perspectives Are containers for a set of views and editors that exist within the perspective. A perspective exists in a window along with any number of other perspectives, but only one perspective can be displayed at a time. You can add and rearrange views to display multiple sets of information simultaneously within a perspective. You can save a rearranged perspective with the current name, or create a new perspective by saving the new arrangement of views with a new name. Note Your administrator can use the HiddenPerspectives preference to prevent the display of some Teamcenter perspectives in the rich client. For information about editing preference values, see the Preferences and Environment Variables Reference. Views Enable you to navigate a hierarchy of information, display information about selected objects, open an editor, or display properties. Views that work with related information typically react to selection changes in other views. Changes to data made in a view can be saved immediately. PLM00064 E Report Generator Guide 1-3
Chapter 1 Getting started Any view can be opened in any perspective, and any combination of views can be saved in a current perspective or in a new perspective. Objects selected in a view may provide context for a shortcut menu. The shortcut menu is usually displayed by right-clicking. For more information about using the shortcut menu, see the Rich Client Interface Guide. Note If your site has online help installed, you can access application and view help from the rich client Help menu or by pressing F1. Some views, such as Communication Monitor, Print Object, Outline, Palette, and Progress, are not specifically associated with a particular perspective. For more information about unassociated views, see the Rich Client Customization Programmer s Guide. For more information about perspectives and views and changing the layout of your rich client window, see the Rich Client Interface Guide. Basic concepts for using Report Generator Report Generator can report the following types of data: Information about the structures of your process plan, including process, operation, activity, product, and plant structures. Current version details. Image files and JT files. Datasets. Forms. Folders. Timing information for a process. Cost data for the process, product, and plant. Basic tasks using Report Generator You can perform the following tasks using Report Generator: Generate a new report. View reports. Export reports. Regenerate a report. 1-4 Report Generator Guide PLM00064 E
Getting started Print reports. Customize reports. PLM00064 E Report Generator Guide 1-5
Chapter 2 Generating and working with reports Generate a new report......................................... 2-1 Viewing reports............................................. 2-1 Export a report.............................................. 2-2 Regenerate a report.......................................... 2-2 Saving a report.............................................. 2-3 Save a report............................................ 2-3 Viewing a saved report........................................ 2-3 View report using the Report Data pane......................... 2-3 View a report using the tree hierarchy.......................... 2-3 Print a report............................................... 2-4 Customizing reports.......................................... 2-4 Switch between PLM XML and other XML schemas................. 2-4 Creating custom report layouts.................................. 2-4 PLM00064 E Report Generator Guide
Chapter 2 Generating and working with reports You can generate reports and view them in a browser. By default, the report is launched using an external browser. You can also regenerate, save, print, and export reports as per your requirements. Generate a new report You can generate a report for any product, process, or plant object. 1. In Manufacturing Process Planner or Part Planner, select an object from the tree hierarchy in the structure pane. 2. In the data pane, click the Report tab. Note You can also use the shortcut menu or drag-and-drop functionality to send the object to the Report Generator application. 3. From the Type list at the bottom of the application window, select a report type. 4. Click Generate Report. The report is generated and displayed in the Web browser. Viewing reports A report is generated as a set of linked HTML pages viewable through a Web browser. You can navigate the report using both the links that are embedded within the report and the standard navigation buttons available in the browser. There are two types of links embedded within the report: External links access a different page of a report, such as subprocesses or operation. Internal links expand or collapse information within the same page of the report, such as showing or hiding an image or a table. PLM00064 E Report Generator Guide 2-1
Chapter 2 Generating and working with reports Export a report The export function allows you to export all files associated with the report to an external directory. 1. In Manufacturing Process Planner or Part Planner, select an object from the tree hierarchy on the structure pane. 2. In the data pane, click the Report tab. 3. From the Type list at the bottom of the application window, select a report type. 4. Click Export Report. 5. In the Export Report dialog box, select a directory location and enter a file name for the exported report file. Note 6. Click Export. If the specified file name already exists, the existing file is overwritten. All report files are generated for the selected object and exported to the directory you specified. The given file name is shown as the starting page of the report. Note If the report has previously been generated, it is exported without being regenerated. To regenerate the report before export, click Regenerate. Regenerate a report Regenerating a report allows you to apply different style sheets to the same data without regenerating the XML data for each report. This option is available only if you have generated and exported the report at least once previously. Note If you choose this option, any changes made to the product, process, or plant structure since the report was generated are not included in the report. 1. In Manufacturing Process Planner or Part Planner, select an object from the tree hierarchy on the structure pane. 2. In the data pane, click the Report tab. 3. From the Type list at the bottom of the application window: Click Regenerate to regenerate the report with the same report type. To regenerate a report with a different report type, select a new report type and click Regenerate. 2-2 Report Generator Guide PLM00064 E
Generating and working with reports The report is generated with the report type using the currently selected product, process, or work area. Saving a report You can save a generated report with the selected product, process, or plant revision. When a report is generated, Teamcenter s manufacturing process management creates a new CME_Report dataset and stores all the report s related files in this dataset. This option is available only if you have generated and exported the report at least once previously. The report is not updated automatically if the product, process, or plant structure is changed. When changes are made to these objects, you must generate and save the report again. Save a report 1. Generate a report. 2. Click Save. The report is saved as a CME_Report type dataset, with the current report type as its name. It becomes attached to the current product, process, or plant revision. Only the latest version of the report is saved. If earlier versions of the same report exist, the Save report to database dialog box is displayed and you must confirm that you want to overwrite the previously saved version. Viewing a saved report You can view previously saved reports without having to regenerate them. You can review the reports from either the Report data tab or from any application where the report is visible, such as the Manufacturing Process Planner or Part Planner Attachment pane or in the My Teamcenter application. View report using the Report Data pane 1. In Manufacturing Process Planner or Part Planner, select an object from the tree hierarchy on the structure pane. 2. In the data pane, click the Report tab. 3. From the Type menu, select the type of report to be viewed. 4. Click View Existing Report. View a report using the tree hierarchy To view a previously saved report from a tree hierarchy with the My Teamcenter application or in the Manufacturing Process Planner or Part Planner PLM00064 E Report Generator Guide 2-3
Chapter 2 Generating and working with reports Attachments data pane, double-click the report dataset in the tree hierarchy. If the report is available, the most recently saved version is displayed in a browser. Print a report Open the report in a Web browser and print it from there. Only the currently displayed page is printed, and this may not show the whole structure. Customizing reports In addition to the standard reports provided by Report Generator, you can create your own custom reports. You can also customize the report layout by creating and using your own XSL style sheets. Report Generator generates an XML file (report_data.xml) that acts as a source of data when reports are generated. Note The PLM XML schema is the default schema. If you used other XML schemas in the previous versions of Teamcenter, you must change a value in the cmereport_user.properties file to view that report. Switch between PLM XML and other XML schemas 1. Open the cmereport.properties and cmereport_user.properties files located in the TC_ROOT\portal\plugins\com.teamcenter.rac.cme.cmereport_8000.0.0\ com\teamcenter\rac\cme\cmereport directory. 2. From the cmereport.properties file, copy the line that contains report_xml_file_type to the cmereport_user.properties file. 3. In the cmereport_user.properties file, change the report_xml_file_type value to either plmxml for PLM XML schema or xml for other XML schemas. 4. Save the modified cmereport_user.properties file. 5. Restart the rich client. Note While generating new reports, change the value of report_xml_file_type to plmxml. Creating custom report layouts When you install the rich client, the report is presented by translating the report data in the XML file using an XSL style sheet that is installed with the application. 2-4 Report Generator Guide PLM00064 E
Generating and working with reports You can replace the default style sheet with one of your own to customize the display of the report data so that it contains the data you need, in a format you need. The custom style sheets can include or import other style sheets. The permanent information for the header, footer, or links is usually designed in one or more separate style sheets and is included or imported by the main style sheet. Specify the names and locations of your custom style sheets in the cmereport.properties file for the application. For more information, see your system administrator. PLM00064 E Report Generator Guide 2-5
Chapter 3 Using default reports Creating cost reports.......................................... 3-1 Assign costs to an item..................................... 3-1 Generate a cost report...................................... 3-2 PLM00064 E Report Generator Guide
Chapter 3 Using default reports Several default report types are included as part of Teamcenter s manufacturing process management. These include: Standard reports detailing basic product, process, and plant information. Alternate process reports presenting the process information in an alternate format, including information about the process operations and subprocesses. Cost reports detailing item cost totals for products, processes, and plant work areas. Creating cost reports Tracking costs is a valuable tool to an organization. Manufacturing costs may include the costs of labor, materials, tools, machines, or other costs associated with the production of products. To support this need, Report Generator includes the capability to show costs assigned to items and the cost totals in a report. Cost data can be assigned to any item revision in any of your product, process, or plant structures. Assign costs to an item To assign costs to an item, create a CostData form, attach it to an item, and assign a monetary value to it. Note The CostDataForm type is installed when you install the rich client. Contact your system administrator if it is not installed. 1. Select the item to which the costs are being assigned from the Product, Process, or Plant structure pane in Manufacturing Process Planner or Part Planner. 2. Click the Attachments data pane. 3. From the Attachments data pane, select the item revision. 4. Choose FilefiNewfiDataset. The New Form dialog box is displayed. PLM00064 E Report Generator Guide 3-1
Chapter 3 Using default reports 5. Select the CostDataForm type. 6. Type values in the Name and Description boxes. 7. Select Open on Create. 8. Click OK. The Cost Data form dialog box is displayed. 9. In the CostAmount box, type a currency value for the item. 10. Click OK. The cost data form is added as an entry in the Attachments data pane. Generate a cost report After you assign cost values to items in your product, process, and plant structures, you can generate reports that display each item and its associated cost. 1. Select the item for which costs are being reported from the tree hierarchy on the structure pane in Manufacturing Process Planner or Part Planner. 2. In the data pane, click the Report tab. 3. From the Type menu, select the cost report. 4. Click Generate Report. 3-2 Report Generator Guide PLM00064 E
Appendix A Glossary PLM00064 E Report Generator Guide
Appendix A Glossary A absolute occurrence Relationship between a parent assembly and an item one or more levels lower down the structure. The parent assembly is the context in which the absolute occurrence exists. You can define data on the absolute occurrence that overrides the data stored on the item when you select the context assembly and view the structure. AIWS See Application Interface Web Service. appearances Cache of configured BOM lines in the context of a specific top-line item. Appearances are created to allow quick searches of the entire structure. Application Interface Viewer Viewer data tab in applications that allows users to monitor and control PLM XML data exchanges between Teamcenter and another application through a collaboration context. Application Interface Web Service Teamcenter extensions to a Web service such as gsoap or WebLogic. These extensions allow Teamcenter to share data in a collaboration context with another application. Application Interface Web Service includes a SOAP server. Application Interface Web Service components are installed and deployed as part of the Web tier. C client tier Teamcenter architectural tier that comprises the Teamcenter clients, Teamcenter integrations with third-party applications, such as Teamcenter s Integration for Microsoft Office and Teamcenter Engineering 2007 Integration for AutoCAD, and the third-party applications themselves, such as Microsoft Office and AutoCAD. cloning rules In a collaboration context, a set of rules that defines how structures are created when copying other structures of the same type. A cloning rule can also be applied when creating a structure from a template. collaboration context Teamcenter object that holds a collection of data contained in structure and configuration contexts. This data allows you to capture multiple different Teamcenter structures in one container. You can open a collaboration context in the Multi-Structure Manager application, in Manufacturing Process Planner or in PLM00064 E Report Generator Guide A-1
Appendix A Glossary Part Planner. You can also use a collaboration context to collect data to share with a third-party application. See also structure context. composition Special kind of structure context that allows components to be added from one or more structure contexts, each of which may contain a different product structure. Compositions are used for design studies and manufacturing processes that contain data from both product and plant structures. configuration context In Multi-Structure Manager, a revision rule, variant rule, and closure rule applied to a collaboration context. See also collaboration context. D design bill of materials List of components and subassemblies used to define an assembly structure, and the representation of the assembly structure. Compare with manufacturing bill of materials. E em-planner interface Interface between Teamcenter s manufacturing process management and Tecnomatix em-planner that allows data exchange. enterprise tier Teamcenter architectural tier that comprises a configurable pool of Teamcenter C++ server processes and a server manager. Larger sites can distribute the pool of server processes across multiple hosts. Smaller sites can run the pool of servers on the same host as the Web tier. F feature Physical or geometric object associated with a product, component, or part. Alternatively, a logical attribute of a product, component, or part. Examples: a weld point, a signal, or a geometric pattern. A feature may be represented by a generic design element (GDE) in a BOM. See also generic design element. four-tier architecture Teamcenter architecture that includes four tiers: resource tier, client tier, Web tier, and enterprise tier. four-tier deployment Deployment of the Teamcenter four-tier architecture. The Web tier, enterprise tier, resource tier, and client tier can each be hosted on the same or separate computers. G GDE See generic design element. generic design element BOM item that cannot have different revisions. See also feature. A-2 Report Generator Guide PLM00064 E
Glossary I instance Single data object that is associated to a class. The instance can correspond to a line in the BOM. M manufacturing bill of materials Defines how the product is manufactured, rather than how it is designed. Compare with design bill of materials. manufacturing feature Teamcenter item. A collection of geometry and geometric references and attributes that provide the means for creating work instructions for a manufacturing process. There are several types of features, including holes, pockets, weld points, and die faces. A manufacturing operation typically addresses several features of the same type. See also feature. Manufacturing Process Planner Teamcenter s manufacturing process management application that enables a user to design a plan detailing how to manufacture a product. MBOM See manufacturing bill of materials. Multi-Structure Manager Teamcenter application that enables users to view and manipulate data in a specific context. P Part Planner Teamcenter s manufacturing process management application that enables a user to design a plan detailing how to manufacture a part. Plant Designer Teamcenter s manufacturing process management application that allows users to design, modify, import, and export a factory structure. product view Saved configuration of the assembly viewer, including the selection of objects, zoom factor, rotation angle, and pan displacements. R Report Generator Teamcenter s manufacturing process management application that provides a format for producing reports about information in Teamcenter s manufacturing process management. Resource Browser Plug-in component that allows users to retrieve classification-related data, such as a hierarchy with corresponding groups, classes, and classification objects from a Teamcenter database when working in an external application. PLM00064 E Report Generator Guide A-3
Appendix A Glossary Resource Manager Teamcenter s manufacturing process management application that enables a user to store and retrieve resource-related data such as tools, fixtures, machines, and process templates from a company-wide accessible database. resource tier Teamcenter architectural tier comprising the database server, database, file servers, and volumes. S structure Representation of multiple objects and their interdependencies. For example, a classification structure represents classes and their inheritance dependencies, and an assembly structure represents how components and subassemblies are associated to build up an assembly. The structure can be viewed in several applications, including Structure Manager, Manufacturing Process Planner, Part Planner, Multi-Structure Manager, and Resource Manager. In Resource Manager, most structures are hierarchical. For example, they acquire the form of a tree where each node can have only one parent but multiple siblings and children. structure context BOM or assembly structure contained in a collaboration context. The structure context can contain occurrence groups, items, and item revisions. See also collaboration context. W Web tier Teamcenter architectural tier that comprises a Java application running in a Java 2 Enterprise Edition (J2EE) application server. The Web tier is responsible for communication between the client tier and enterprise tier. A-4 Report Generator Guide PLM00064 E
Index A Alternate process reports............ 3-1 B Basic Report Generator concepts...... 1-4 C CME_Report..................... 2-3 cmereport.properties............... 2-5 Configure Report Generator.......... 1-1 Cost reports..................... 3-1 CostDataForm................... 3-1 Costs Assign to item.................. 3-1 Generate report................. 3-2 Customizing reports............... 2-4 D Data reported by Report Generator..... 1-4 Default reports Alternate process reports.......... 3-1 Cost reports.................... 3-1 Standard reports................ 3-1 E Enable Report Generator............ 1-1 Exporting reports................. 2-2 G Generating new reports............. 2-1 P Prerequisites for Report Generator..... 1-1 Printing reports.................. 2-4 R Regenerating reports............... 2-2 Report Generator Basic concepts.................. 1-4 Basic tasks.................... 1-4 Buttons....................... 1-2 Customizing reports.............. 2-4 Definition..................... 1-1 Exporting reports................ 2-2 Generating new reports........... 2-1 Interface...................... 1-2 Kind of data reported............. 1-4 List.......................... 1-2 Printing reports................. 2-4 Regenerating reports............. 2-2 Saving reports.................. 2-3 Viewing reports................. 2-3 report_data.xml.................. 2-4 Reports Alternate process reports.......... 3-1 Cost report.................... 3-2 Cost reports.................... 3-1 Creating custom layouts........... 2-4 Customizing................... 2-4 Exporting..................... 2-2 Generating new................. 2-1 Printing...................... 2-4 Regenerating................... 2-2 Saving....................... 2-3 Shipped with software............ 3-1 Standard reports................ 3-1 Viewing....................... 2-1 Rich client perspectives and views..... 1-3 S Saving reports................... 2-3 Standard reports.................. 3-1 Start Report Generator From Manufacturing Process Planner.................... 1-2 From navigation pane............ 1-2 T Teamcenter perspectives and views..... 1-3 U User interface PLM00064 E Report Generator Guide Index-1
Index V Buttons....................... 1-2 Menus....................... 1-2 View reports Using report data pane............ 2-3 Using tree hierarchy............. 2-3 Viewing reports.................. 2-1 Index-2 Report Generator Guide PLM00064 E