report builder guide - help!help.aviacons.ru/tc10doc/pdf/en_us/tdocext/pdf/report_builder.pdf ·...

Teamcenter 10.1

Report Builder Guide

Publication NumberPLM00039 J

Proprietary and restricted rights notice

This software and related documentation are proprietary to Siemens ProductLifecycle Management Software Inc.

© 2013 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.

Siemens and the Siemens logo are registered trademarks of Siemens AG. Teamcenteris a trademark or registered trademark of Siemens Product Lifecycle ManagementSoftware Inc. or its subsidiaries in the United States and in other countries. Allother trademarks, registered trademarks, or service marks belong to their respectiveholders.

2 Report Builder Guide PLM00039 J

Contents

Proprietary and restricted rights notice . . . . . . . . . . . . . . . . . . . . . . . . . 2

Getting started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Getting started with Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Basic concepts for using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Basic tasks using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Managing Teamcenter report definitions . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Managing Teamcenter report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Modify a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Delete a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Attach a stylesheet to an existing Teamcenter report definition . . . . . . . . . . . . 2-1Import a stylesheet to an existing Teamcenter report definition . . . . . . . . . . . 2-2Sample custom report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Managing Reporting and Analytics report definitions . . . . . . . . . . . . . . 3-1

Managing Reporting and Analytics report definitions . . . . . . . . . . . . . . . . . . . 3-1Set rights to create and deploy reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Create a cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Create and deploy an ad hoc report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4Manage Reporting and Analytics report definitions from Report Builder . . . . . 3-5Convert attributes to strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6

Generating reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Generating reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Generating Report Builder reports in the rich client . . . . . . . . . . . . . . . . . . . 4-1Generating reports in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5Generate reports from the Command Prompt . . . . . . . . . . . . . . . . . . . . . . . . 4-8Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Importing and exporting report definitions . . . . . . . . . . . . . . . . . . . . . . 5-1

Importing and exporting report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Export a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Import a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Visual reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Visual reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2Debug visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

PLM00039 J Report Builder Guide 3

Contents

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

4 Report Builder Guide PLM00039 J

Chapter

1 Getting started

Getting started with Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Reports Home folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Report Builder tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Report Builder menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5Rich client perspectives and views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Basic concepts for using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Report Builder definition types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Report definition structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Report Builder terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7

Basic tasks using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8Create report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Create a summary report definition . . . . . . . . . . . . . . . . . . . . . . . . . 1-8Create an item report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10Create a custom report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Create property sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13

PLM00039 J Report Builder Guide

Chapter

1 Getting started

Getting started with Report BuilderReport Builder allows you to create and manage your own report definitions. Thesereport definitions provide end users with reports to run in the rich client or thethin client.

End users of the rich client use Report Builder to create new reports to meet theirorganization’s needs. Use Report Builder to create the following report definitions:

• Summary

Reports that summarize similar information, for example, reports that show allthe employees, the items belonging to a user, or the release status of items.

• Item

Reports that can be run on a particular item, for example, reports that show theBOM list for an item or the workflow signoff for an item.

• Custom

Reports that use custom processing.

Report Builder works with the Query Builder application and the PLM XML/TCXML Export Import Administration application. To assemble reports, you can usesaved queries created in Query Builder and property sets created in PLM XML/TCXML Export Import Administration.

Before you beginPrerequisites To use Report Builder, you must know how to use:

• Query Builder

Query Builder is a Teamcenter application that enables youto create and maintain customized searches for objects inthe Teamcenter databases.

For more information, see the Query Builder Guide.

• PLM XML/TC XML Export Import Administration

PLM XML/TC XML Export Import Administration helpsyou create transfer mode objects that contain rules toconfigure import or export operations.

PLM00039 J Report Builder Guide 1-1

Chapter 1 Getting started

For more information, see the PLM XML/TC XML ExportImport Administration Guide.

• PLM XML and TC XML schema

PLM XML and TC XML are the two schemas that ReportBuilder uses. PLM XML is an open schema based onstandard W3C XML schemas. TC XML schema is aSiemens PLM Software format that uses Teamcenter XML.Understanding these schemas allows you to work with theXML-formatted organization of the data for import andexport to Teamcenter.

• Teamcenter data model

The data model objects define the objects and rules used inTeamcenter. For example, some of the data model objects areitems, item revisions, and forms, along with the constructsholding the data.

For more information about creating the data model, see theBusiness Modeler IDE Guide.

Enable ReportBuilder

Report Builder does not need to be enabled before you use it.If you have trouble accessing Report Builder, see your systemadministrator. It may be a licensing issue.

To work with Reporting and Analytics reports from ReportBuilder, install and deploy Teamcenter reporting and analytics(Reporting and Analytics).

ConfigureReport Builder

You must set appropriate preferences to configure ReportBuilder.

For more information, see Report Builder preferences.

• Add appropriate reporting source values to theValid_ReportBuilder_Sources preference.

• Add appropriate values to theEnable_ReportBuilder_Reports_By_Source preferenceto view non Teamcenter source reports.

• To control the columns and column width in Report Builderwizards, set preferences as described in the Preferences andEnvironment Variables Reference.

Start ReportBuilder Click Report Builder in the rich client navigation pane.

1-2 Report Builder Guide PLM00039 J

Getting started

Report Builder interface

1 Reports Home tree The Reports Home tree pane displays the availablereport definitions. The Teamcenter Reports foldercontains report definitions created using ReportBuilder. The TcRA Reports folder contains reportdefinitions created using Teamcenter reporting andanalytics.



2 Report Builder tabs The Report Builder tabs display file details, properties,and configurable data for the selected report.

For more information, see Report Builder tabs.

3 Localization button Displays the Language Translations dialog box thatlists existing translation values.

For more information about the Localization button,see the Localization Guide.

Note For information about general interface topics such as the navigationpane, tabs, general menu commands, data display, data objects, favorites,the clipboard, and printing object properties, see Getting Started withTeamcenter. For information about user interface components that arespecific to My Teamcenter in the rich client, see theMy Teamcenter Guide.

Reports Home folderThe Reports Home folder displays the available report definitions:• Teamcenter Reports

Displays all report definitions available from Teamcenter.

• TcRA ReportsContains reports created with Reporting and Analytics. You can execute, view,edit, set permissions, and delete Reporting and Analytics reports from ReportBuilder.

Report Builder tabsThe Report Builder tabs allow you to view different aspects of reports:

• DetailsDisplays the file details of the selected report definition.

• ViewerDisplays the properties of the selected report definition.

• Report DataHolds the configurable data for the selected report definition. From this tab, youcan modify report definition data or delete a report definition.

For Reporting and Analytics reports, you can execute, modify, view, setpermissions, and delete report definitions from this tab.

Report Builder menusThe following File menu commands are unique to Report Builder:• Create Report

Launches the Create Report Definition Template wizard.


Getting started

For more information, see Basic tasks using Report Builder.

• Create Property Set

Launches the New Property Set wizard. This wizard allows reportadministrators to define new property sets and modify existing property sets.Property sets contain properties displayed in summary and item reports.

For more information, see Create property sets.

The New Property Set wizard contains the same functionality as the PropertySet tab in the PLM XML/TC XML Export Import Administration application.However, the Report Builder application offers a graphical user interface todefine property sets.

For more information about property sets, see the PLM XML/TC XML ExportImport Administration Guide.

Dashboard

The Dashboard application shows the dashboard page of the Teamcenter Reportingand Analytics application.

• To install the Dashboard application, select the Dashboard option underExtenstions ®Reporting and Analytics in Teamcenter Environment Manager.

For more information, see the Installation on UNIX and Linux Servers Guide orInstallation on Windows Servers Guide and Teamcenter Environment ManagerHelp.

• After Dashboard is installed, update the TC_RA_server_parameterspreference with the URL of the Teamcenter Reporting and Analytics dashboard.

• To start the Dashboard application, click Dashboard in the rich clientnavigation pane.

Rich client perspectives and views

Within the Teamcenter rich client user interface, application functionality isprovided in perspectives and views. Some applications use perspectives and views toarrange how functionality is presented. Other applications use a single perspectiveand view to present information.

Note Your administrator can use the HiddenPerspectives preference to preventthe display of some Teamcenter perspectives in the rich client.

For information about editing preference values, see the Preferences andEnvironment Variables Reference.

If your site has online help installed, you can access application and view help fromthe rich client Help menu or by pressing F1.

For more information about rich client perspectives and views, see the Rich ClientInterface Guide.



Basic concepts for using Report BuilderReport Builder lets administrators create and manage Teamcenter report definitions.After administrators create the report definitions, users can use these definitions togenerate reports from My Teamcenter in the rich client or from the thin client.

Administrators can create several different kinds of reports:

• Summary reports present information based on a saved query definition.

• Item reports are run on one or more selected items based on a class of items.

• Custom reports show results based on custom processing.

All report definitions have a similar structure and contain a source for the data(such as a query) and a stylesheet to format the output.

Report Builder definition typesReport Builder allows you to create three types of reports:

• Summary reports

Summary reports are generated from Teamcenter saved queries. When youselect a summary report from a list of available summary reports, you areprompted to input query criteria. You can leave default values or enter newvalues. If default values are not given, you are prompted to type the valueswhen you generate a report.

• Item reports

Item reports are executed in the context of one or more objects, such as itemrevisions. Each item report object is associated with a Teamcenter class andtransfer mode object. Transfer mode objects are created in the PLM XML/TCXML Export Import Administration application.

The difference between item and summary reports is that item reports requirean object to be selected and summary reports depend on a saved query. Forexample, when you select an item type document, only the reports applicable tothe document item and its relationships are available to generate the report.

• Custom reports

Custom reports address special cases such as complex processing or calculationsdone through custom code or when data is coming from external sources. Eachcustom report object is associated with a custom program. When you selecta custom report from a list, the server launches the program and the customprocess.

Report definition structureThe process of creating report definitions varies slightly based on the type of reportdefinition you choose to create.

Common structure in all reports include:

• A unique report ID that can be assigned automatically by the system.


Getting started

• A report name and description.

• A stylesheet dataset to reformat the report data for output.

Report typeReportproperties Description Summary Item Custom

Query sourceSpecifies the saved queryused to find items toreport.

Closure ruleSpecifies structureprocessing for relateditems.

Report format PLM XML or TC XMLreport output properties.

Property set Specifies additional outputproperties.

ClassSpecifies the type of itemsallowed by the report.

Transfer modeSpecifies structureprocessing and filtering forrelated items.

ProcessSpecifies the program forthe custom process path.

Output Specifies the output filename for the report.

ParametersSpecifies variable input forthe custom process.

The end user has the option to attach different stylesheets to produce differenttypes of reports in HTML or Microsoft Excel format. For examples of howto format summary and item reports, refer to the Report Builder samplestylesheets. The sample stylesheets are available on the corporate server in thetc_data/crf/Resources directory.

Closure rules, transfer modes, and property sets are defined using PLM XML

For additional information on closure rules, transfer modes, and property sets, seethe PLM XML/TC XML Export Import Administration Guide.

Report Builder terms

• A saved query object allows end users to search for Teamcenter data modelobjects using search criteria.

• A class is the definition of an object implemented in the Teamcenter data model.Each class has associated attributes and behavior that control both the actions



that may be performed on it and what other data it can be related to. Teamcentermanages data by grouping similar types of data into classes.

• A transfer mode object combines closure rules and property sets to define thecontext of the PLM XML import or export operation. These objects are presentedas context options when you import or export objects or system data usingTeamcenter applications.

• A property set allows you to have user defined data for data exchange. Usingproperty sets you can add Teamcenter data into the PLM XML file that may notbe in the PLM XML schema.

• A stylesheet defines and controls the report display. You can use the stylesheetprovided with Teamcenter, or you can create a new stylesheet to display yourdata in a different format.

Basic tasks using Report BuilderYou can create report definitions in Report Builder by choosing File→Create Report.Administrators create the property sets used in reports by choosing File→CreateProperty Set.For more information, see Create report definitions and Create property sets.

Once the report definitions are created, end users can generate reports from MyTeamcenter in the rich client or from the thin client.

For more information, see Generating reports.

Create report definitions

You can create summary, item, and custom report definitions by choosingFile→Create Report.When you create new report definitions, they are saved in the Teamcenter Reportsfolder under the Reports Home folder.

Create a summary report definition

Summary reports list information about Teamcenter data. For example, you canuse a summary report to list users in a group, or to list the Item objects releasedon a particular day.

Saved queries are the data source for summary report definitions. You can use thesupplied saved queries, or you can create your own query using Query Builder.


1. Choose File→Create Report.The system displays the Create Report Definition Template wizard.

2. Select Summary Report and click Next.

3. Perform the following steps in the Report Information pane:


Getting started

a. In the Report ID box, type an ID or click Assign to automatically assignan ID.

b. In the Name box, type a name for the report definition.

c. In the Description box, type a short description of the report definition.

d. From the Source list, select the source of the report.The Source value is defined in the Valid_ReportBuilder_Sourcespreference.

e. Click the arrow on the Query Source box to select a query definition.

Note To see the values of query definitions, run the Query Builderapplication, open the Saved Queries folder in the left pane, andselect the query. The values of the query are displayed in the rightpane. You can also create your own query using the Query Builderapplication.


f. Click the arrow on the Closure Rule box if you want to use a closure rule toprocess the query definition selected in the Query Source box. Closure rulesspecify how the data structure is traversed by specifying which relationshipsare of interest.

Note To see the values of closure rules, run the PLM XML/TC XML ExportImport Administration application and select the closure rule in theleft pane. The values of the selected closure rule are displayed in theright pane. You can also create your own closure rule using the PLMXML/TC XML Export Import Administration application.

For more information, see the PLM XML/TC XML Export ImportAdministration Guide.

g. Click the arrow on the Property Set box to select a set of properties to usefor the report.

Note To see the values of property sets, run the PLM XML/TC XMLExport Import Administration application and select the name of theproperty set in the left pane. The values of the selected property setappear in the right pane. You can also create your own propertyset using the PLM XML/TC XML Export Import Administrationapplication.


h. Click the arrow on the Report Format box to select the format for the report,PLMXML or TcPLMXML.Select TcPLMXML to see all the Teamcenter attributes. Select PLMXML tosee attributes displayed in PLM XML industry standard names.

i. Click Next.



4. Perform the following steps in the Reports Stylesheets pane:a. Select the stylesheet to use for the report in the Defined Stylesheets pane

and click the + button to move it to the Selected Stylesheets pane.Note

To import a stylesheet, click the Import stylesheets button ,located under the + and – buttons in the Report Stylesheets pane.

The Import Stylesheet dialog box appears.

In the Dataset Type box, select a stylesheet type for the newstylesheet: HTML, MSExcel, MSWord, Text, or Xml. This option isrequired if the end user wants to save the report as a dataset atthe time the report is run.

b. Click Finish.The new report is added to the Teamcenter Reports folder.

c. Click Close.

5. To verify that the report definition works as desired, generate a report.

For example, in My Teamcenter in the rich client, chooseTools→Reports→Summary Reports and select your new summaryreport.

For more information, see Generating Report Builder reports in the rich client.

Create an item report definition

Item reports are run on an individual item, such as an item revision. Each itemreport object is associated with a transfer mode, which is created in PLM XML/TCXML Export Import Administration.

For more information about transfer mode objects, see the PLM XML/TC XMLExport Import Administration Guide.


2. Select Item Report and click Next.

3. Perform the following steps in the Report Information pane:a. In the Report ID box, type an ID or click Assign to automatically assign

an ID.

b. In the Name box, type a short description of the report definition.


d. From the Source list, select the source of the report.The Source value is defined in the Valid_ReportBuilder_Sourcespreference.

e. Click the arrow on the Class box to select a class, such as an item revision.


Getting started

If you selected ItemRevision as the class, BOM Report is enabled. Select theBOM Report flag if you want to generate a bill of materials report.Note Teamcenter manages data by grouping similar types of data into

classes. Classes are created and edited in the Business Modeler IDE.

For more information, see the Business Modeler IDE Guide.

f. Click the arrow on the Transfer Mode box to select a transfer mode for thereport definition.

A transfer mode object combines rules and property sets to define the contextof the PLM XML import or export operation. It stores the translation intentin the PLM XML product. These objects are presented as context optionswhen you import or export objects or system data. If the transfer mode objectdoes not exist, you can create it with the PLM XML/TC XML Export ImportAdministration application.


g. Click the arrow on the Property set box to select a property set.Note To see the values of property sets, run the PLM XML/TC XML

Export Import Administration application and select the name of theproperty set in the left pane. The values of the selected property setappear in the right pane.

You can also create your own property set using the PLM XML/TCXML Export Import Administration application.


h. Click the arrow on the Report Format box to select the format for the report,PLMXML or TcPLMXML.Choose TcPLMXML to see all the Teamcenter attributes. Choose PLMXML tosee attributes displayed in PLM XML industry standard names.

i. Click Next.

4. Perform the following steps in the Reports Stylesheets pane:a. Select the stylesheet to use in the Defined Stylesheets pane and click the +

button to move it to the Selected Stylesheets pane.Note




b. Click Finish.



The new report is added to the Teamcenter Reports folder.

c. Click Close.


For example, in My Teamcenter in the rich client, choose one or more Teamcenterobjects, choose Generate Report from the shortcut menu, and select your newitem report.


Create a custom report definition

Custom reports address special cases such as complex processing or calculationsdone through custom code, or when data comes from external sources. Each customreport object is associated with a custom program. When a custom report is selectedfrom a list, the server launches the program and the custom process.

1. Choose File→Create Report.

The system displays the Create Report Definition Template wizard.

2. Select Custom Report and click Next.

3. Perform the following steps in the Report Information pane:

a. In the Report ID box, type an ID or click Assign to automatically assignan ID.



d. From the Source list, select the source of the report.

The Source value is defined in the Valid_ReportBuilder_Sourcespreference.

Note If you select Visual Report as your source, the report informationpane changes.

For more information, see Define the visual report in Teamcenter.

e. Select Process if you are using a process to run the custom report.

A. In the Process box, type the full path to any command line applicationthat will generate the output file.

For more information, see Sample custom report definition.

B. In the Output box, type the output file name.

C. Click the + button on the right of the Parameters pane to add a new line,and type the parameter name and value.

f. Select Method if you want to run a custom report against a type.


Getting started

A. Click the arrow in the Type Name box to select the type that the customreport applies to.

B. Click the + button on the right of the Parameters pane to add a new line,and type the parameter name and value.

For more information about creating a custom method for visual reports, seeCreating a custom method.

4. Click Next.

5. Perform the following steps in the Reports Stylesheets pane:

a. Select the stylesheet to use for the report by selecting it in the DefinedStylesheets pane and clicking the + button to move it to the SelectedStylesheets pane.

NoteTo import a stylesheet, click the Import stylesheets button ,located under the + and – buttons in the Report Stylesheets pane.



b. Click Finish.

The new report is added to the Teamcenter Reports folder.

c. Click Close.


For example, in My Teamcenter in the rich client, chooseTools→Reports→Custom Reports and select your new customreport.


Create property sets

Property sets are collections of Teamcenter data, such as class attributes orbusiness object (type) properties. You can create a property set that contains justthe information you want to use in a report. For example, you can create a propertyset that lists the name, ID, and description of items.

When you create a summary or item report definition, you can select the property setto use in the report by clicking the selection arrow on the Property Set box.

For more information, see Create report definitions.

When you choose File→Create Property Set, the New Property Set wizard launches,which contains the same functionality as the Property Set tab in the PLM XML/TCXML Export Import Administration application.



For more information, see the PLM XML/TC XML Export Import AdministrationGuide.

Note It is important to understand Teamcenter class and attributes structure (thePOM schema) when you create property sets. Administrators can examinethe POM schema in the Business Modeler IDE by using the Classes viewor by right-clicking a class in the Classes view and choosing Open in UMLEditor.


1. Choose File→Create Property Set.

The system displays the New Property Set wizard.

2. In the Property Set Name box, type a name for the property set.

3. In the Description box, type a brief description of the property set.

4. For Scope of Property Set, select Export because you want the data to beexported from the database and placed into reports.

5. Perform the following steps to locate the class or business object (type) whoseproperties you want to compile into a set:

a. In the Search box, select Class or Type.

b. Click the ? button and type the name of the class or business object (type)whose properties you want to compile into a set, for example, Item.

c. Click the magnifying glass button or press Enter.

The class or business object appears in the pane. To close the selection box,click the X in the upper right corner.The properties of the class or business object appear in the pane.

d. To change how the attributes display in the pane, click the Display Settingsbutton. Use this to display all attributes or only the attributes for the class.

e. Select the properties you want to place into the set by double-clicking themin the pane.

The properties appear at the bottom of the dialog box.

For example, if you searched for the Item class, double-click the Itemproperties in the pane.

6. To change the order that the properties are placed into the set, click the up ordown arrows to the right of the bottom pane.

To remove a property, click the minus button (–) to the right of the bottom pane.

7. You can also add properties manually by clicking the plus button (+) to the rightof the bottom pane (also known as the clause table):

a. Click the + button located to the right of the clause table.


Getting started

b. Click the arrow in the Primary Object Class Type cell and choose CLASSor TYPE.

c. Type the name of the class or business object in the Primary Object box.For example, type Item.

d. Click the arrow in the Relation Type cell and choose PROPERTY.

e. Type the name of a property in the Related Property Or Object box.

f. Click the arrow in the Property Action Type cell and choose one of thefollowing:

• DO

Specifies that the action be executed.

• SKIP

Specifies that the relationship should not be followed. This directive isuseful to eliminate special cases before a more general rule is reached.

The property set uses a defined syntax to specify the data to retrieve, as in thefollowing example:

CLASS.Item:PROPERTY.last_mod_date:DOCLASS.Item:PROPERTY.object_string:DO

After this property set runs, the resulting transformed data in the PLM XMLlooks like this:

<ProductRevision id="id12" name="assy" accessRefs="id5" masterRef="#id20" revision"A"><UserDAta id="id15">

<UserData value="02-Dec-2003 12:37" title="last_mod_date"/><UserData value="000338/A-assy" title="object_string"/>

</UserDAta></ProductRevision>

8. Click the Create button.

The system displays the new rule in the left pane. This property set can now beused when creating an item or summary report definition.

9. To verify that the property set works as expected, create a summary oritem report definition that uses the new property set. For example, chooseFile→Create Report, select Summary Report, and click the arrow on theProperty Set box to select the new property set for the report.

For more information, see Create report definitions.


Chapter

2 Managing Teamcenter reportdefinitions

Managing Teamcenter report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Modify a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Delete a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Attach a stylesheet to an existing Teamcenter report definition . . . . . . . . . . . . 2-1

Import a stylesheet to an existing Teamcenter report definition . . . . . . . . . . . 2-2

Sample custom report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2


Chapter

2 Managing Teamcenter reportdefinitions

Managing Teamcenter report definitionsYou can manage the standard Teamcenter report definitions in the TeamcenterReports folder. You can edit or delete any Teamcenter report definition.Reporting and Analytics report definitions are in the TcRA Reports folder.For more information, seeManaging Reporting and Analytics report definitions.

Modify a Teamcenter report definition1. Open the Teamcenter Reports folder.

2. Select a report definition and click the Report Data tab.Information about the report definition displays in the Report Data pane.

3. Change the information in the boxes or click Clear to remove all data from thereport definition.

4. Click Modify to save your changes.

Delete a Teamcenter report definition1. Open the Teamcenter Reports folder.


3. Click Delete.

Attach a stylesheet to an existing Teamcenter report definition1. Open the Teamcenter Reports folder.



Chapter 2 Managing Teamcenter report definitions

3. Select a defined stylesheet and click + to add it to the selected stylesheets column.


Import a stylesheet to an existing Teamcenter report definition1. Open the Teamcenter Reports folder.


3. Click the Import stylesheets button , located under the + and – buttons inthe Report Stylesheets pane.The Import Stylesheet dialog box appears.

4. In the Dataset Type box, select a stylesheet type for the new stylesheet: HTML,MSExcel, MSWord, PDF, Text, or Xml. This option is required if the end userwants to save the report as a dataset at the time the report is run.

5. Click the Browse on the Location box to locate the stylesheet file. The stylesheetmust be in XSL format.

6. Click OK.The stylesheet is added to the Defined Stylesheets pane.

7. Select the new stylesheet in the Defined Stylesheets pane and click the + buttonto move it to the Selected Stylesheets pane.Note

To import a stylesheet, click the Import stylesheets button , locatedunder the + and – buttons in the Report Stylesheets pane.


In the Dataset Type box, select a stylesheet type for the new stylesheet:HTML,MSExcel,MSWord, Text, or Xml. This option is required if the enduser wants to save the report as a dataset at the time the report is run.


Sample custom report definitionWhen you create a custom report definition, you associate the custom report objectwith a custom executable program. When you run the report in Teamcenter,Teamcenter runs the executable program from the full path specified in the report’sprocess path and waits until the process is complete. The path specified as the outputfor the process contains the newly created XML file. The Report Builder frameworktakes the XML, applies the stylesheet, and creates the dataset in the New Stufffolder in the Teamcenter rich client or in the context of the item it is run against.

Perform the following steps to run a sample custom report definition. This reportinvokes the %TC_BIN%\query_xml.exe file that takes an input file named c6.xml.


Managing Teamcenter report definitions

1. Save the following custom report definition as TC_CUSTOM_RPT.xml in atemporary directory named TC_CUSTOM_RPT. The directory name must bethe same as the report name. For example, save the TC_CUSTOM_RPT.xmlfile in D:\Temp\ TC_CUSTOM_RPT\

<?xml version="1.0" encoding="Windows-1252"?><ReportDefinition><Id value="TC_CUSTOM_RPT"/><name value="Query Report"/><Description value=""/><Class value=""/><Type value="2"/><QuerySource/><PropertySet value=""/><Stylesheets><Stylesheet><StylesheetType value="CrfHtmlStylesheet"/><StylesheetName value="default_xml_template.xsl"/></Stylesheet></Stylesheets><NoOfParameters value="7"/><Params><param_0 value="process"/><param_1 value="output"/><param_2 value="-f"/><param_3 value="-u"/><param_4 value="-p"/><param_5 value="-g"/><param_6 value="-o"/></Params><Values><param_0 value="%TC_BIN%\query_xml.exe"/><param_1 value="D:\workdir\test\c6_output.xml"/><param_2 value="D:\workdir\test\c6.xml"/><param_3 value="infodba"/><param_4 value="infodba"/><param_5 value="dba"/><param_6 value="D:\workdir\test\c6_output.xml"/></Values></ReportDefinition>

2. Save the following process file as c6.xml and place it in the D:\workdir\testdirectory :

<?xml version="1.0" encoding="UTF-8"?><ImanQueryCommandFile site_name="arh" site_id="id">

<ImanQueryCommand command="execute_tuples"><name value="General..."/><query_input_parameter name="Name" value="*"/><query_input_parameter name="Type" value="Item"/><query_pff_post pffName="Admin - Objects By Status" />

</ImanQueryCommand></ImanQueryCommandFile>

3. Import the TC_CUSTOM_RPT custom report definition to Teamcenter from theTeamcenter command prompt, using a command similar to the following:

import_export_reports –import –u=user-name –p=password-g=dba –stageDir=temp-directory –reportId=TC_CUSTOM_RPT

If you are logged on as infodba, use the following command:

import_export_reports –import –u=infodba –p=infodba-g=dba –stageDir=”D:\Temp\” –reportId=TC_CUSTOM_RPT


Chapter 2 Managing Teamcenter report definitions

4. Verify that the Query Report is displayed in the Report Builder application inthe Teamcenter Reports folder.

5. In the Report Builder application, choose the Query Report and import thedefault_xml_template.xsl stylesheet.

The stylesheet is located in the TC_ROOT\tcdata\report_writer directory.

For more information about importing stylesheets, see Import a stylesheet to anexisting Teamcenter report definition.

6. In My Teamcenter in , choose Tools→Report Builder Reports and run theQuery Report report without choosing a stylesheet.

This report runs the %TC_BIN%\query_xml.exe file and generates theC6_output.xml report file.

7. In the rich client, in My Teamcenter, choose Tools→Report Builder Reports andrun the Query Report report and choose a stylesheet.

This report runs the %TC_BIN%\query_xml.exe file and generates theC6_output.xml report file and applies the stylesheet to generate the finalHTML report.


Chapter

3 Managing Reporting andAnalytics report definitions

Managing Reporting and Analytics report definitions . . . . . . . . . . . . . . . . . . . 3-1

Set rights to create and deploy reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Create a cube . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Create and deploy an ad hoc report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4

Manage Reporting and Analytics report definitions from Report Builder . . . . . 3-5

Convert attributes to strings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6


Chapter

3 Managing Reporting andAnalytics report definitions

Managing Reporting and Analytics report definitionsReporting and Analytics is a stand-alone reporting application. When it is installedand deployed in a Teamcenter environment, it integrates with Report Builder anddisplays reports in the TcRA Reports folder.Use the Reporting and Analytics Mapper and BuildNPlay applications to create andmanage reports. Use Mapper to set user rights and to create the cubes (similar toproperty sets) that are displayed in reports. Use BuildNPlay to create and managethe Reporting and Analytics report definitions.

For more information about BuildNPlay and Mapper, see the Reporting andAnalytics documentation.

The process for managing Reporting and Analytics reports is as follows:

1. In Mapper, set rights for users so they can create reports.

See Set rights to create and deploy reports.

2. In Mapper, create cubes that define the data to be displayed in a report.

See Create a cube.

3. In BuildNPlay, create reports and place them in the TcRA Reports folder inReport Builder.

See Create and deploy an ad hoc report.

4. In Report Builder, manage the reports in the TcRA Reports folder.SeeManage Reporting and Analytics report definitions from Report Builder.

Set rights to create and deploy reportsTo create and deploy reports using BuildNPlay, a user must have the correct rightsbased on their role. As an administrator, you use the Reporting and AnalyticsMapper application to set the user rights.

1. Log on to the Reporting and Analytics Mapper application.

2. Click the Role Based Security button .

The Mapper application displays the available roles:


Chapter 3 Managing Reporting and Analytics report definitions

• EQUBE_DEFAULTAllows BuildNPlay users to run Reporting and Analytics reports.

• EQUBE_SUPERAllows BuildNPlay users to modify, save, delete, and deploy Reporting andAnalytics report definitions.

3. To locate users, click the down arrow on the View By box and choose Users.

4. In the User Name box, type a string to search and click the Search button .

5. To expand the search results, choose the + button by All. Select the user on theleft side of the pane to see their roles in the right side of the pane.

6. To change a user’s roles, select the boxes in the right side of the pane.

If you want to allow a user to create reports and deploy them to Teamcenter, theymust be assigned the EQUBE_DEFAULT and the EQUBE_SUPER roles.

7. Click the Save button in the lower right of the pane.

Create a cubeIf you want to create a report that has a specific set of data, you must first useMapper to create a cube that contains that data. A cube defines the data displayed ina Reporting and Analytics report. For example, if a report has columns that list theitem ID, description, and creation date, these columns are provided by the cube.

Note It is important to understand Teamcenter class and attributes structure (thePOM schema) when you create property sets. Administrators can examinethe POM schema in the Business Modeler IDE by using the Classes view,or by right-clicking a class in the Classes view and choosing Open in UMLEditor.



2. Choose Cube→Define.Mapper displays the Define Cube tab.

3. Perform the following steps on the Define Cube tab:a. Type a name for the cube in the Cube Name box.

b. Leave Assign Category as Default and select Use Semantic Mapping.

c. Click the arrow on the Select Connection box and choose 1-User Connectionfor standard user logon or 2-User Connection if you use Security Servicessingle sign-on.

d. Click OK.


Managing Reporting and Analytics report definitions

Mapper displays the Search tab.

4. Perform the following steps on the Search tab:

a. In the Search classes box, type the name of the class you want to use for thecube, or if you want to use a saved query enter SQ_.

b. Press Enter or click the Search button .

c. Click the right arrow button to move the class or saved query to the rightpane.

d. Click the Add to Tree button.

Mapper displays the Objects and Steps tab.

5. Perform the following steps on the Objects and Steps tab:

a. Click the arrow on Attributes.

Mapper displays the attributes on the class or saved query.

b. Choose the attributes you want to use on the cube by clicking the right arrowbutton to move them to the right pane. For saved queries, do not use SQ_names.

c. Click the arrow on Filters.

Mapper displays the filters on the class or saved query.

d. Remove any filters you do not want by clicking the left arrow button to movethem to the left pane. For saved queries, only use those that are prefacedby SQ_.

Note If use a class cube and you have chosen owning_user orowning_name, you must remove their filters and convert theseattributes to strings.

For more information, see Convert attributes to strings.

e. Click the Apply button.

6. Click the Measure Placement tab.

Perform the following steps on the Measure Placement tab:

a. Click the + button by the class or saved query name.

The attributes appear.

b. Select the attributes you want on the cube and click the arrow button tomove them to the right pane.

c. Click the Submit button.

Mapper displays the attributes on the columns, under Msr1, Msr2, and so on.



d. Change the names on the columns as desired, for example, change Msr1 tosomething appropriate for the attribute below it, change Msr2, and so on.These are the columns displayed in the report.

7. Save the cube by clicking the Save button on the top toolbar.Mapper displays a confirmation dialog box containing the following message:

Cube is created with name: cube-name

8. To send the cube to the server, click the Update Server Metadata button .

Create and deploy an ad hoc reportIn BuildNPlay, you can create a Reporting and Analytics report from a cube. You candeploy it to Teamcenter so that it displays in the TcRA Reports folder. You must beassigned the EQUBE_SUPER role to create reports.

For more information, see Set rights to create and deploy reports. For informationabout how to create a cube, see Create a cube.

The following procedure provides the basic steps for creating an ad hoc report.For more detailed instructions, see the Reporting and Analytics BuildNPlaydocumentation.

1. Log on to the Reporting and Analytics BuildNPlay application.

2. Click Ad Hoc on the toolbar.

3. In the Cube Categories pane, select the cube you want to use for the report.BuildNPlay displays the cube information in the right pane.

4. In the Measures pane, select the columns you want to display on the report.

5. If you want to filter the data to be displayed in the report, click the Apply Filterbutton .

BuildNPlay displays the filtering variables at the bottom of the window. Enterthe operators and values to use for filtering. Only include the needed operators.For example, if you are using dates, only keep the <=, ==, and >= operators,and, for saved queries, remove NULL.

6. Click the Submit button at the bottom of the window.

7. Click the Save button .

BuildNPlay displays the Save definition dialog box.

8. Perform the following steps in the Save definition dialog box:a. In the Name for this definition box, type a name.

b. In the Description box, type a brief explanation.

c. In the Category box, select an area to store the report definition.



d. Select Save definition as redefinable template. This means that you andthose you authorize can change the report.

e. Select Deploy to Teamcenter.

f. Click the arrow on the Teamcenter Type box to select the type of report:Item, Summary, or Custom.

g. Click the Save button.BuildNPlay displays a new dialog box with the following message:

Please select the factors you want to redefineat the time of retrieval.

h. Select the factor.

BuildNPlay displays the attributes.

i. Click the operator button to the left of the attributes to select the operatorsto use, for example, ==, LIKE, and so on. By default, all operators are onthe attribute.

Note If you are using a saved query, you must only include the neededoperators. For example, use only == to enter matching data. If youinclude operators that do not match the attribute, the data doesnot get retrieved.

j. Click the Save button.

k. Click the Set Permissions button.

l. Select the users you want to give permission to run this report and click theAdd button. To allow all users to run it, select All.

m. Click Submit. The report is submitted to Report Builder.A dialog box displays the message:

Permissions Have Been Set Successfully

n. Click OK.

9. To verify that the report displays in Report Builder, log on to Report Builder as auser who has permissions to view the report and select the TcRA Reports folder.The new report appears in the TcRA Reports folder.

Manage Reporting and Analytics report definitions from Report BuilderIf you have permissions to work with the Reporting and Analytics reports, you canexecute, view, edit, set permissions, and delete Reporting and Analytics reportdefinitions from the Report Data tab in Report Builder. This method launches theReporting and Analytics BuildNPlay application to manage the report definitions.

1. Start the Report Builder application in the Teamcenter rich client.



2. Select the Report Home→TcRA Reports folder.

3. Select a Reporting and Analytics report definition and click the Report Data tab.Report Builder displays information about the report definition in the ReportData pane.

4. Click one of the following buttons in the Report Data pane:• Execute

Generates the report from within the Reporting and Analytics BuildNPlayapplication. In BuildNPlay, enter any additional filter information andchoose Submit and then Show Report.Generating a Reporting and Analytics report this way is the same asrunning a Reporting and Analytics report from My Teamcenter by choosingTools→Reports→Summary Reports.

• ViewShows the report definition details in BuildNPlay.

• ModifyOpens the report definition for modification in BuildNPlay.

• DeleteRemoves the report definition from Reporting and Analytics and Teamcenter.When prompted, click Yes to confirm deletion.

• Set PermissionsAllows you to change rights to the report in BuildNPlay. You are allowed toset permissions on a report only if you have rights to work with the reportdefinition by the report creator.

5. If prompted, log on to the Reporting and Analytics BuildNPlay application.

The Reporting and Analytics BuildNPlay application launches in a Web browser.

6. Use BuildNPlay to perform the desired action, for example, modify a reportdefinition or set permissions.

For more information about managing Reporting and Analytics reports usingBuildNPlay, see the Reporting and Analytics BuildNPlay documentation.

Convert attributes to stringsWhen creating a cube using a class, you must convert typed reference attributes andBoolean attributes to strings. For example, if you have chosen owning_user orowning_name, you must convert them to strings. If you are using a saved query forthe cube, you do not have to convert any attributes to strings.


2. Click Manage Views on the toolbar.



Mapper displays the Views tab.

3. Enter search criteria for the cube and click the Search button.

Mapper displays available cubes.

4. Select the cube that contains attributes to be converted.

The cube information displays in the View tab.

5. Click the + button in the Attributes column.

Mapper displays the Select Attribute dialog box.

6. In the right pane, select the attribute you need to convert to a string (forexample, ItemRevision.owning_user) and click the fn button in the upper rightcorner of the dialog box.

Mapper displays the Define Expression dialog box.

7. Perform the following steps in the Define Expression dialog box:

a. Select the attribute at the top of the Define Expression dialog box.

b. In the Functions box, double-click TO_STRING.

c. In the Operators box, double-click (.

A ( operator is placed to the left of the attribute at the top of the dialog box.

d. Select the space to the right of the attribute and double-click ).

A ) operator is placed to the right of the attribute, enclosing it in parentheses.The final expression should look like the following:

TO_STRING ( ItemRevision.owning_user )

e. Click Submit.

8. In the Select Attribute dialog box, select the other attributes you need to convertto strings. When done, click OK.

9. Click the Map View button .

Mapper displays the cube in the Map View tab.

10. In the Filters box, double-click the converted attribute (for example,owning_user) to add it to Column Name and Filter Name in the right pane. Youcan change the display name for the attribute under Column Name.

11. Click Save.

12. To send the updated cube information to the server, click the Update ServerMetadata button .


Chapter

4 Generating reports

Generating reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Generating Report Builder reports in the rich client . . . . . . . . . . . . . . . . . . . 4-1Generate a summary report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Generate an item report on a Teamcenter object . . . . . . . . . . . . . . . . . . . 4-2Generate a custom report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Generating reports in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5Generate a summary report in the thin client . . . . . . . . . . . . . . . . . . . . . 4-5Generate an item report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . 4-6Generate a custom report in the thin client . . . . . . . . . . . . . . . . . . . . . . . 4-7

Generate reports from the Command Prompt . . . . . . . . . . . . . . . . . . . . . . . . 4-8

Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8


Chapter

4 Generating reports

Generating reportsYou can generate Report Builder reports from the Teamcenter rich client or thinclient interfaces. You can also generate reports using the import_export_reportsutility.

Generating Report Builder reports in the rich clientYou can generate Report Builder reports in My Teamcenter by choosingTools→Reports→Report Builder Reports or by right-clicking an object and choosingGenerate Report.

The process of generating reports differs slightly depending on the type of report youchoose. If stylesheets are available, they can be selected while generating a report.You also have the option to save the generated results as a dataset.

Note You can generate Reporting and Analytics reports from the thin client ifReporting and Analytics is installed and deployed in your Teamcenterenvironment. For Reporting and Analytics reports defined as a snapshotor template, you see the report results in a Web browser. If the report isredefinable, you see another page in the Web browser where you can enteradditional criteria. You can also save Reporting and Analytics reports asdatasets in PDF, Excel, or XML format.

Generate a summary report

Summary reports are created from saved or dynamic queries. When you select asummary report from a list of available summary reports, you are prompted toinput query criteria.

1. In My Teamcenter in the rich client, choose Tools→Reports→Report BuilderReports.

The system displays the Report Generation Wizard.

If no reports are listed, no reports have been created by your systemadministrator.

For more information about creating summary reports, see Create a summaryreport definition.

2. Select a summary report.


Chapter 4 Generating reports

Note If you choose a Reporting and Analytics report, only Finish isavailable. When you choose Finish, you are logged on to the Reportingand Analytics BuildNPlay application. Enter any additional filterinformation and choose Show Report.

3. Click Next.

4. Fill in criteria for the query. Only the objects that match the query are placedinto the report.

Note You can enter multiple criteria separated by the delimiting character.By default the delimiting character is a semicolon (;). In cases whereyou want Teamcenter to ignore the delimiting character, use the escapecharacter before the delimiting character. By default the escapecharacter is tilde (~).

For more information, see the Rich Client Interface Guide.

5. To select the display locale, select the locale from the Report Display Locale list.

6. If you want to choose the format for the report, select the stylesheet from theReport Stylesheets list.

7. If the report is based on Office Template source, the Live Integration checkbox is seen.

Select the Live Integration check box to generate the report in Live mode.

8. If you want to save the report as a file, select the Create Dataset check box andtype a name in the Dataset Name box.

Note If the report is based on Office Template source, the Create Datasetcheck box is disabled.

The dataset generated for reports based on the Office Template source isbased on the stylesheet selected from the Report Stylesheets list.

9. Click Finish.

If you did not choose a stylesheet, the report is displayed in your default XMLapplication. If you chose an HTML spreadsheet, the report is displayed in aWeb browser.

If you saved the report as a dataset, the report is saved in your default Homefolder, for example, Newstuff.If you selected the Live Integration option, the report is in Bulk Live mode. Clickthe Save To Teamcenter button in the report to save the changes you makein the report to Teamcenter.

Generate an item report on a Teamcenter object

You can generate an item report from My Teamcenter in the rich client by choosingone or more Teamcenter objects, such as an item revision. Only objects withassociated reports have report definitions displayed in the selection wizard. When


Generating reports

you select a item report from a list of available reports, you may be prompted foradditional parameters.

1. In My Teamcenter, choose a Teamcenter object, such as an item revision.

2. Right-click the object and choose Generate Report.The system displays the Report Generation Wizard.

If no reports are listed, no reports have been created by your systemadministrator for the selected object type. Teamcenter has standard item reportdefinitions for item revisions.

For more information about creating item reports, see Create an item reportdefinition.

3. Select an item report.

Note If you choose a Reporting and Analytics report, only Finish isavailable. When you choose Finish, you are logged on to the Reportingand Analytics BuildNPlay application. Enter any additional filterinformation and choose Show Report.

4. Click Next.

5. For BOM reports, a Revision Rule box is displayed. Click the arrow at the end ofthe Revision Rule box to select the revision to run the report on.Note The BOM report gets generated only for the first selected context object.

BOM reports can be generated from Structure Manager.


7. If you want to choose the format for the report, select a stylesheet from theReport Stylesheets list.

8. If the report is based on Office Template source, the Live Integration checkbox is seen.

Select the Live Integration check box to generate the report in Live mode.

9. If you want to save the report as a file, select the Create Dataset check box andtype a name in the Dataset Name box.Note If the report is based on Office Template source, the Create Dataset

check box is disabled.

The dataset generated for reports based on the Office Template source isbased on the stylesheet selected from the Report Stylesheets list.

10. Click Finish.If you did not choose a stylesheet, the report is displayed in your default XMLapplication. If you chose an HTML spreadsheet, the report is displayed in aWeb browser.

If you saved the report as a dataset, the report file is saved in your default Homefolder, for example, Newstuff.



If you selected the Live Integration option, the report is in Bulk Live mode. Clickthe Save To Teamcenter button in the report to save the changes you makein the report to Teamcenter.

Generate a custom report

Custom reports address special cases such as complex processing or calculationsdone through custom code, or when data comes from external sources. Each customreport object is associated with a custom program. When a custom report is selectedfrom a list, the server launches the program and the custom process.




For more information about creating custom reports, see Create a custom reportdefinition.

2. Select a custom report.

3. Click Next.

4. Fill in the requested report information:

a. In the Process box, type the custom process path.

b. In the Output box, type the output file name.

c. Click the + button in the right of the Parameters pane to add a new line, andtype the parameter name and value.




8. Click Finish.

If you did not choose a stylesheet, the report is displayed in your default XMLapplication. If you chose an HTML spreadsheet, the report is displayed in aWeb browser.

If you saved the report as a dataset, the report is saved in your default Homefolder, for example, Newstuff.

For information about generating a visual report, see Debug visual reports.


Generating reports

Generating reports in the thin clientYou can generate reports in the Teamcenter thin client by choosingTools→Reports→Report Builder Reports. (You cannot create report definitionsin the thin client.)

When you choose Tools→Reports, the following options are displayed:

• Report Builder Reports

Summary reports and custom reports are shown.

Summary reports are Report Builder reports that are generated fromTeamcenter saved queries. When you select a summary report from a list ofavailable summary reports, you are prompted to input query criteria.

Custom reports are Report Builder reports that address special cases such ascomplex processing or calculations done through custom code or when datacomes from external sources.

• Item Reports

Item reports are Report Builder reports that are executed in the context of anindividual object, such as an item revision.

Note You can generate Reporting and Analytics reports from the thin client ifReporting and Analytics is installed and deployed in your Teamcenterenvironment. For Reporting and Analytics reports defined as a snapshotor template, you see the report results in a Web browser. If the report isredefinable, you see another page in the Web browser where you can enteradditional criteria. You can also save Reporting and Analytics reports asdatasets in PDF, Excel, or XML format.

Generate a summary report in the thin client

Summary reports are created from saved or dynamic queries. When you select asummary report from a list of available summary reports, you are prompted toinput query criteria.

1. Choose Tools→Reports→Report Builder Reports.

The system displays the Generate Builder Report dialog box.If no reports are listed, no reports have been created by your systemadministrator.

For more information about creating summary reports, see Create a summaryreport definition.

2. Click the report link of a summary report.

The system displays the Generate Summary Report dialog box.

Note If you select a Reporting and Analytics report, only OK is available.When you click OK, you are logged on to the Reporting and AnalyticsBuildNPlay application. Enter any additional filter information andchoose Show Report.



3. Fill in criteria for the query. Only the objects that match the query are placedinto the report.

You can fill the query criteria in the query dialog box. Click the Query buttonto open the query dialog box.

The title of the query dialog box will be the same as the name of the report.

4. To select the report display locale, select the locale from the Report DisplayLocale list.

5. To select the format for the report, select the stylesheet from the Stylesheet list.

6. To save the report as a file, select Save to Dataset option and type a name inthe Dataset Name box.

7. Click OK.If you did not choose a stylesheet, the report is displayed in the Web browser asXML. If you chose an HTML spreadsheet, the report is displayed as a formattedreport in the Web browser.

If you saved the report as a dataset, the report is saved in your default Homefolder, for example, Newstuff. Refresh the view to see the report.

Generate an item report in the thin clientYou can generate an item report by selecting one or more Teamcenter objects, such asan item revision object. Only objects with associated reports have report definitionsto choose in the selection wizard. When you select an item report from a list ofavailable reports, you may be prompted for additional parameters to run the report.

1. Choose one or more Teamcenter objects, such as an item revision.

2. Choose Tools→Reports→Item Reports.The system displays the Generate Item Report dialog box.

3. To select an item report, select a report from the Report Definition list.If no reports are listed, no reports have been created by your systemadministrator for the selected item type. Teamcenter has standard item reportsfor item revisions.

For more information about creating item reports, see Create an item reportdefinition.

Note If you select a Reporting and Analytics report, only OK is available.When you click OK, you are logged on to the Reporting and AnalyticsBuildNPlay application. Enter any additional filter information andchoose Show Report.

4. Some reports require you to filter by item status in the Revision Rule box. Clickthe arrow in the box to select the item status.


6. To choose the format of the report, select a stylesheet from the Stylesheets list.


Generating reports

7. To save the report as a file, select Save to Dataset option and type a name inthe Dataset Name box.

8. Click OK.

If you did not choose a stylesheet, the report is displayed in the Web browser asXML. If you chose an HTML spreadsheet, the report is displayed as a formattedreport in the Web browser.

If you saved the report as a dataset, the report is saved in your default Homefolder, for example, Newstuff. Refresh the view to see the report.

Generate a custom report in the thin client

Custom reports address special cases such as complex processing or calculationsdone through custom code, or when data comes from external sources. Each customreport object is associated with a custom program. When a custom report is selectedfrom a list, the server launches the program and custom process.

Note Custom reports for visual reporting is not available for the thin client.

1. Choose Tools→Reports→Report Builder Reports.

The system displays the Generate Builder Report dialog box.If no reports are listed, no reports have been created by your systemadministrator.

For more information about creating custom reports, see Create a custom reportdefinition.

2. Click the report link of a custom report.

The system displays the Generate Custom Report dialog box.

3. Fill in the requested report information.

For example, if parameters are required for the report, click the Add Row buttonand type the parameter name and value.


5. To choose the format of the report, select a stylesheet from the Stylesheets list.

6. To save the report as a file, select Save to Dataset option, and type a name inthe Dataset Name box.

7. Click OK.

If you did not choose a stylesheet, the report is displayed in the Web browser asXML. If you chose an HTML spreadsheet, the report is displayed as a formattedreport in the Web browser.

If you saved the report as dataset, the report is saved in your default Homefolder, for example, Newstuff. Refresh the view to see the report.



Generate reports from the Command PromptYou can use the import_export_reports utility to generate reports from theTeamcenter Command Prompt on the Teamcenter server. You must execute thisutility from a directory where you have write access.

Use the –execute argument with the –f argument to execute reports and set the filethey are saved to, for example:

import_export_reports —execute —u=username –p=password g=group—f=filename.xml

For samples, see the TC_DATA/crf/*offline_execution_sample.xml files on theTeamcenter.

For more information about the import_export_reports utility, see Importingand exporting report definitions.

Report Builder preferencesUse the following preferences to define how reports are displayed and generated:

• ReportDefinition_ColumnPreferences

Determines which columns are displayed in Report Builder.

• ReportDefinition_ColumnWidthPreferences

Specifies the column width for each column defined in theReportDefinition_ColumnPreferences preference.

• ReportGenerationDlg_ColumnPreferences

Determines which columns are displayed in the Report Generation wizard.

• ReportGenerationDlg_ColumnWidthPreferences

Specifies the column width for each column defined in theReportGenerationDlg_ColumnPreferences preference.

• ReportXMLGenerationRules

Defines the specific components of a BOM to be included or excluded in anXML report.

• Valid_ReportBuilder_Sources

Specifies the source of the report.

• Enable_ReportBuilder_Reports_By_Source

Specifies reports that will be shown in Report Builder. The reports shown inReport Builder are based on the source of the report specified in this preference.

To access preferences in the Teamcenter rich client, choose Edit→Options, and clickIndex at the bottom of the Options dialog box.

For more information, see the Preferences and Environment Variables Reference.


Chapter

5 Importing and exportingreport definitions

Importing and exporting report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Export a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Import a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3


Chapter

5 Importing and exportingreport definitions

Importing and exporting report definitionsThe import_export_reports utility allows report definitions, their dependentdata (for example, saved query definitions and property set definitions), and theirassociated stylesheets to be exported from one Teamcenter server and imported toanother.

import_export_reports {-import | —export | —execute}[-u=user-id -p=password –g=group]–stageDir=directory -reportId=report-identifier —f=output-filename.xml [-h]

Key arguments for the import_export_reports utility:

Argument Definition

import Specifies the report definition is imported.export Specifies the report definition is exported.

stageDir Specifies the fully qualified name of the directory that contains all ofthe report definitions and its associated data in predefined format.This directory must exist prior to import and export.

reportId Specifies the ID of the report definition. On export, this is the nameof the directory that is created where the report definition andstylesheets are written. On import, this is the name of the directorywhere the report definition and stylesheets are located.

For more information, see the import_export_reports utility in the UtilitiesReference.

Export a report definition1. Ensure you are in the proper environment for running a command utility.

For example, on a Windows system where the corporate server is installed, clickthe Start button and choose Programs→Teamcenter 10.1→Command Prompt.

2. Type the import_export_reports utility commands:

a. Enter the utility name: import_export_reports

b. Specify the action argument: –export


Chapter 5 Importing and exporting report definitions

c. Optionally, specify an administrator user: –u=user-name –p=password–g=group

d. Specify an existing staging directory using the –stageDir option, forexample, d:\tc_data.

e. Specify an existing report ID in Teamcenter using the –reportId option, forexample, TC_2007_00_SUM_RPT_0001.

Note To find the ID for a report, in the Report Builder application selectthe report in the Reports Home folder and view the ID on theDetails tab.

The syntax is as follows:

import_export_reports –export -u=user-name -p=password –g=group–stageDir=staging-directory -reportId=ID

Note Report definition dependent data definitions, for example, saved querydefinitions and property set definitions, are included with the exportedreport definition.

Example

1. Consider a situation where you want to export an existing report definitionAdmin - Item Ownership whose report ID is TC_2007_00_SUM_RPT_0001.

Create a staging directory named Reports under C:\Temp (Windows) or /tmp(UNIX).

Note Ensure that the user executing the import_export utility has writeaccess permission to this directory.

2. Start the Teamcenter command prompt and specify the following command:import_export_reports –export -u=infodba -p=infodba –g=dba–stageDir="C:\Temp\Reports” -reportId=”TC_2007_00_SUM_RPT_0001"

After the export, Teamcenter creates a new folder in the staging directory. Thefolder name is the same as the report ID: TC_2007_00_SUM_RPT_0001.

Teamcenter creates another folder named Resources in the report ID folder.The associated stylesheets are copied in this folder.

After successful export, you can see the following directories and files:

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\TC_2007_00_SUM_RPT_0001.xml

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources\admin_ownership_html.xsl

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources\l10n_admin_ownership_html.xsl


Importing and exporting report definitions

Import a report definition1. Ensure you are in the proper environment for running a command utility.

For example, on a Windows system where the corporate server is installed, clickthe Start button and choose Programs→Teamcenter 10.1→Command Prompt.

2. Type the import_export_reports utility commands:

a. Enter the utility name: import_export_reports

b. Specify the action argument: –import

c. Optionally, specify an administrator user: –u=user-name –p=password–g=group

d. Specify the staging directory where the reports reside using the –stageDiroption, for example, d:\tc_data.

e. Specify an existing report ID from the staging directory using the –reportIdoption, for example, TC_2007_00_SUM_RPT_0001.

The syntax is as follows:

import_export_reports –import -u=user-name -p=password –g=dba–stageDir=staging-directory -reportId=ID

Example

1. In this example, we will import the report definition that we exported in theExport a report definition topic.

Note Ensure that the staging directory (C:\Temp\Reports) contains thereport ID folder (the folder whose name is the same as the reportID). This folder must contain the report definition template and otherstylesheet files.

The directory structure looks similar to this:

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\TC_2007_00_SUM_RPT_0001.xml

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources\admin_ownership_html.xsl

C:\Temp\Reports\TC_2007_00_SUM_RPT_0001\Resources\l10n_admin_ownership_html.xsl

2. Start the Teamcenter command prompt and specify the following command:import_export_reports –import -u=infodba -p=infodba –g=dba–stageDir="C:\Temp\Reports” -reportId=”TC_2007_00_SUM_RPT_0001"

If the report definition does not exist in Teamcenter, the import is successful.Else the import is skipped.


Appendix

A Visual reporting

Visual reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2Creating a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3

Define a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4Build the custom method in Teamcenter . . . . . . . . . . . . . . . . . . . . . . A-6

Define the visual report in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . A-7Define the visual report in the visual reporting client . . . . . . . . . . . . . . . . A-8

Debug visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8


Appendix

A Visual reporting

Visual reportingVisual reporting allows you to quickly display and analyze parts of an assembly inmeaningful and well-organized ways by coloring parts based on values of a property.Simple visual reports based on existing properties can be created from a visualreporting client like NX.

Using Report Builder, you can define complex visual reports by creating custommethods and defining a custom report.

You can execute these reports and view their results in a visual reporting clientlike NX.

The following visual reports are available in Report Builder:

Note You can only view the definitions of these reports in Report Builder. To viewthe results of these reports, use a visual reporting client like NX.

For more information, see the Visual Reporting guide in the NX helpcollection.

• Overall Status in Change ProcessShows status of parts currently in a change process. Colors all parts according totheir overall status in a change process.

• Overall Status in WorkflowShows status of parts currently in a workflow process. Colors all parts accordingto their overall status in workflow.

• Affected by Problem ReportShows parts that are affected by a specified problem report. Colors all parts thatare affected by the specified problem report by its relationship to the specifiedproblem report.

• Affected by Change RequestShows parts that are affected by a specified change request. Colors all parts thatare affected by the specified change request by its relationship to the specifiedchange request.

• Affected by Change NoticeShows parts that are affected by a specified change notice. Colors all parts thatare affected by the specified change notice by its relationship to the specifiedchange notice.

PLM00039 J Report Builder Guide A-1

Appendix A Visual reporting

• Has Higher Revision

Shows parts that have higher revisions. Colors all parts that have higherrevisions than the one that is currently configured in the visual reporting client.

• Rule Evaluation Result

Shows parts that satisfy a specified validation rule. Colors all parts whosevalidation results do not satisfy the specified validation rule.

• Check-Mate Result

Shows parts that have Check-Mate results. Colors all parts according to theirCheck-Mate overall result.

This report is not available in Report Builder. To use this report, import theTC_9_0_00_VR_RPT_VAL_RESULT.xml file into Teamcenter using theimport_export_reports utility.

• Requirements Validation Status

Shows parts that have not fulfilled all their requirements. Colors all partsaccording to the requirement validation status.

This report is not available in Report Builder. To use this report, import theTC_9_0_00_VR_RPT_REQ_VAL_STATUS.xml file into Teamcenter usingthe import_export_reports utility.

Creating complex visual reportsThe following diagram shows the process of creating complex visual reports.

A-2 Report Builder Guide PLM00039 J

Visual reporting

Creating visual reports involves the following steps:

• Create custom method to compute the values of the visual report.

• Define a custom Report Builder report.

• Define the visual report in visual reporting client like NX.

• Run the report in a visual reporting client like NX.

For information about defining and running the visual report in NX, see the VisualReporting guide in the NX help collection.

Creating a custom method

Methods are C/C++ functions that allow you to add functionality to the Teamcenter.

For more information about methods, see Server Customization Programmer’s Guide.



Custom methods compute the set of properties supplied as input for the report usingthe context provided. Custom methods do not process closure rules and property setsthat are specified in the report definition. The Report Builder framework processesthe closure rules and property sets.

To create a custom method you must:

• Define the custom method.

• Build the custom method into Teamcenter.

For information about how to define and register custom methods and build yourown custom library, see Server Customization Programmer’s Guide.

When you create custom methods, use the following guidelines:

• When you generate a visual report from a visual reporting client, the custommethod by itself does not gather the general parameters of the report.The general parameters are available in the report definition. Use theSSR_get_property_descriptors API in the custom method to get the generalparameters.

• The custom method localizes property display names in the report output.

Add report properties and custom property strings to theTC_ROOT\install\lang\textserver\language\report_customization_display_text_locale.xmlfile, and use the txtsvr API to retrieve the localized strings.

• To retrieve the display names of Teamcenter properties, use theAOM_UIF_ask_name API.

For more information about these Teamcenter Server APIs, see the IntegrationToolkit Function Reference.

Note The Integration Toolkit Function Reference is available only in theTeamcenter HTML Help Collection. It is not available in the PDFcollection.

Define a custom methodNote A sample custom method for visual reports is available in the

TC_ROOT/sample/visual_report directory.

The custom method code has the following parts:

• Method registration

• Execution method

Method registrationMethods must be registered against a type. For visual reports, the methodsare registered against the ReportDefinition type. Registration is done in theinitialization method for the ReportDefinition type.

Methods are registered using METHOD_register_method.TCCORE_API int METHOD_register_method ( const char * type_name

const char * msg_name


Visual reporting

METHOD_function_t base_actionTC_argument_list_t * user_dataMETHOD_id_t * method )

You must follow the following conventions for custom method for visual reports:

• type_name

Register method against the type ReportDefinition.

• msg_name

Corresponds to the method name. Prefix the msg_name withCrfGenerateVisualReport.

Example: For a custom method named CostReport, themsg_name value willbe CrfGenerateVisualReportCostReport.

• base_action

Corresponds to the custom function.

• user_data

Value if NULL.

• method

Corresponds to the output parameter.

Execution methodThe execution method will have input parameters and computing code.

Signature of custom method

int sampleVisualReport (METHOD_message_t *msg, va_list args)

Input parameters

• msg

The reference to the tag of a report definition.

• args

The constituents of the va_list arguments.

• int numObjects

The number of item revisions that are the context of the report.

• tag_t *objects

The list of item revisions that are the context of the report.

• int num_reporting_property

The number of reporting properties to be computed for the report.

• parameter_descriptors_t *rpd

The list of reporting properties to be computed for the report.



• int num_search_parameter

The number of search criteria or values to be used in refining the results ofthe report.

• parameter_descriptors_t *spd

The list of search criteria or values to be used in refining the results of thereport. Typically these parameters are a list of strings to be used to fill in valuesfor a query that needs to be executed on the server.

• int num_general_parameter

The number of any other parameters required by the visual report.

• parameter_descriptors_t *gpd

The list of any other parameters required by the visual report.

• int num_additional_parameter

The number of any parameter that does not fit the previously describedparameter types.

• parameter_descriptors_t *apd

The list of any parameter that does not fit the previously described parametertypes.

The following are the primary ITK APIs used in the custom methods.

For more information about ITK APIs and other APIs which support additionalfunctions, see the Integration Toolkit Function Reference.

Note The Integration Toolkit Function Reference is available only in theTeamcenter HTML Help Collection. It is not available in the PDF collection.

• SSR_create_visual_report_objects

• SSR_create_report_property_objects

• SSR_set_report_property_data

• SSR_create_related_objects

• SSR_set_related_object_data

• SSR_create_property_objects

• SSR_set_property_data

Build the custom method in Teamcenter

For information about building a custom method into the Teamcenter Server using acustom library, see Server Customization Programmer’s Guide.


Visual reporting

Define the visual report in TeamcenterNote Ensure you have added Visual Report as a value in the

Valid_ReportBuilder_Sources preference.


2. Select Custom Report and click Next.

3. Perform the following steps in the Report Information pane:a. In the Report ID box, type an ID or click Assign to automatically assign

an ID.



d. From the Source list, select Visual Report.The Source value is defined in the Valid_ReportBuilder_Sourcespreference.

4. Click the arrow on the Closure Rule box if you want to use a closure rule toprocess the query definition selected in the Query Source box. Closure rulesspecify how the data structure is traversed by specifying which relationshipsare of interest.

Note To see the values of closure rules, run the PLM XML/TC XML ExportImport Administration application and select the closure rule in the leftpane. The values of the selected closure rule are displayed in the rightpane. You can also create your own closure rule using the PLM XML/TCXML Export Import Administration application.


5. Click the arrow on the Property Set box to select a set of properties to use forthe report.

Note To see the values of property sets, run the PLM XML/TC XML ExportImport Administration application and select the name of the propertyset in the left pane. The values of the selected property set appear in theright pane. You can also create your own property set using the PLMXML/TC XML Export Import Administration application.


6. Type the name of the custom method in the Custom Method box.

7. Click the + button on the right of the Parameters pane to add a new line, andtype or select the parameter name, display name, parameter type, and value.

The following parameter types are available in their separate tabs:



• Report PropertiesSpecifies the properties to be returned by the visual report.

• Search CriteriaSpecifies the context objects that should be filtered by Report Builder whiledelivering the output.

• GeneralAny other paramenters required by the visual report.

8. Click Next.

9. Perform the following steps in the Reports Stylesheets pane:a. Select the stylesheet to use for the report by selecting it in the Defined

Stylesheets pane and clicking the + button to move it to the SelectedStylesheets pane.Note Stylesheets for visual reports are not available by default. You must

create your own stylesheets and import it in Teamcenter or use theavailable stylesheets.




b. Click Finish.The new report is added to the Teamcenter Reports folder.

c. Click Close.

Define the visual report in the visual reporting clientYou must define the visual report in the visual reporting client to generate thereports.

For information about defining visual report in NX, see the Visual Reporting guide inthe NX help collection.

Debug visual reportsNote Ensure you have added Visual Report as a value in the

Enable_ReportBuilder_Reports_By_Source preference.



Visual reporting



2. Select a custom report.

3. Click Next.

4. In the Report Information pane, add or remove parameter values:

a. Click the + button in the right of the Parameters pane to add a new line, andtype the parameter name and value.

b. Select a parameter value and click the + button in the right of theParameters pane to remove a parameter.


Note Stylesheets for visual reports are not available by default. You mustcreate your own stylesheets and import it in Teamcenter or use theavailable stylesheets.


7. Click Finish.

The report is displayed in your default XML application.

If you saved the report as a dataset, the report is saved in your default Homefolder, for example, Newstuff.


Appendix

B Glossary


Appendix

B Glossary

A

access control list (ACL)Access Manager component that contains a list of accessors and, for each accessor,the privileges granted, denied, and not set.

ACLSee access control list (ACL).

C

classSet of objects that share the same list of attributes but distinguishable by the valuethe attributes acquire for specific objects. For example, the Automobile class can bedefined by the brand, color, and price, but each car associated to the Automobileclass has a different brand, color, and price combination.

F

folderGraphical representation of an aggregation of objects, such as a group, class, orsubclass. For easy distinction in the class hierarchy, each of these aggregations hasa different type of folder icon associated with it: a group folder icon, a class foldericon, or a subclass folder icon.

M

My TeamcenterIn the Teamcenter rich client and thin client, application that is the main accesspoint for managing product information. My Teamcenter provides the functionalityfor creating objects in the Teamcenter database, querying the database for objects,checking in and checking out objects, and managing tasks. Users can also openobjects, automatically launching the related application.

Each user has a personal My Teamcenter window that displays product informationas graphical objects. Although users share product information across the enterprise,they organize this information individually in personal workspaces.

N

named ACLNamed group of access controls. See also access control list (ACL).

PLM00039 J Report Builder Guide B-1

Appendix B Glossary

navigation paneRich client framework component that displays buttons of the applications availablefor use in the rich client. Clicking the application button launches the application.

O

output dataData generated as a result of applying instructions to input data. Output data canbe the resulting in-process model and any instructions for the next step.

P

PLM XMLSiemens PLM Software format for facilitating product life cycle interoperabilityusing XML. PLM XML is open and based on standard W3C XML schemas.Representing a variety of product data both explicitly and via references, PLMXML provides a lightweight, extensible, and flexible mechanism for transportinghigh-content product data over the Internet.

preferenceConfiguration variable stored in a Teamcenter database and read when a Teamcentersession is initiated. Preferences allow administrators and users to configure manyaspects of a session, such as user logon names and the columns displayed by defaultin a properties table.

propertiesKeys and values that specify the configuration settings for an application in theTeamcenter rich client.

Q

Query BuilderTeamcenter application that enables a system administrator to create and maintaincustomized searches for objects in the Teamcenter databases, both local and remote.Saved queries are subject to standard object protection and can be accessed by usersthrough the search feature in My Teamcenter.

R

rich clientJava-based user interface to Teamcenter installed on user workstations. The richclient accesses Teamcenter databases using a remote or local server. Compare tothin client.

S

site preferenceTeamcenter preference that applies to the entire site.

Structure ManagerTeamcenter application that enables creation of generic product structures that canbe configured to show the product structure that is in production, effective on acertain date, used by a particular customer, and so forth. Structure Manager enablescreation and modification of a product structure and its associated occurrence data,

B-2 Report Builder Guide PLM00039 J

Glossary

display of a product structure in a multilevel indented format, and viewing graphicstightly coupled to the structure for easy identification of a component by location inthe structure or in the embedded viewer.

system administratorTeamcenter user who is a member of the system administration group.

T

thin clientTeamcenter user interface that provides a streamlined browser-based view of productinformation stored in a Teamcenter database. The thin client is configured in theWeb tier, which creates and serves its Web pages to the client. Compare to rich client.

transfer modeObjects composed of rules that configure PLM XML import and export operations.Transfer mode allows users to import and export data with little knowledge otherthan the name of the transfer mode object.

V

valueContent of a field or variable. It can refer to alphabetic, numeric, or alphanumericdata.

PLM00039 J Report Builder Guide B-3

Index

AAttaching stylesheets to existing reportdefinitions . . . . . . . . . . . . . . . . . . . . . . 2-1

BBasic concepts about Report Builder . . . . 1-6Basic tasks using Report Builder . . . . . . 1-8BuildNPlay application . . . . . . . . . . . . . 3-1

CConceptsCustom reports . . . . . . . . . . . . . . . . . 1-6Item reports . . . . . . . . . . . . . . . . . . . 1-6Summary reports . . . . . . . . . . . . . . . . 1-6

Configuring Report Builder . . . . . . . . . . 1-2Create Property Set menu command . . . 1-4,1-13Create Report menu command . . . . . . . . 1-4CreatingCustom report definitions . . . . . . . . . 1-12Item report definitions . . . . . . . . . . . 1-10Property sets . . . . . . . . . . . . . . . . . . 1-13Report definitions . . . . . . . . . . . . . . . 1-8Reporting and Analytics reports . . . . . 3-4Summary report definitions . . . . . . . . 1-8

Cubes . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Custom reportsConcepts . . . . . . . . . . . . . . . . . . . . . . 1-6Creating . . . . . . . . . . . . . . . . . . . . . 1-12Rich client . . . . . . . . . . . . . . . . . . . . . 4-4Thin client . . . . . . . . . . . . . . . . . . . . . 4-7

DDashboard . . . . . . . . . . . . . . . . . . . . . . 1-5Deleting report definitions . . . . . . . . . . . 2-1Details tab . . . . . . . . . . . . . . . . . . . . . . 1-4

EEnabling Report Builder . . . . . . . . . . . . 1-2EQUBE_DEFAULT role . . . . . . . . . . . . . 3-1EQUBE_SUPER role . . . . . . . . . . . . . . . 3-1

Exporting report definitions . . . . . . . . . . 5-1

FFile menu . . . . . . . . . . . . . . . . . . . . . . . 1-4Folders . . . . . . . . . . . . . . . . . . . . . . . . . 1-4

GGenerating reportsCommand prompt . . . . . . . . . . . . . . . 4-8Rich client . . . . . . . . . . . . . . . . . . . . . 4-1Thin client . . . . . . . . . . . . . . . . . . . . . 4-5

Getting started with Report Builder . . . . 1-1

Iimport_export_reports utilityExporting reports . . . . . . . . . . . . . . . . 5-1Generating reports . . . . . . . . . . . . . . . 4-8Importing reports . . . . . . . . . . . . . . . . 5-3Using . . . . . . . . . . . . . . . . . . . . . . . . 5-1

ImportingReport definitions . . . . . . . . . . . . . . . 5-3Stylesheets to existing report

definitions . . . . . . . . . . . . . . . . . . 2-2Item reportsConcepts . . . . . . . . . . . . . . . . . . . . . . 1-6Creating . . . . . . . . . . . . . . . . . . . . . 1-10Rich client . . . . . . . . . . . . . . . . . . . . . 4-2Thin client . . . . . . . . . . . . . . . . . . . . . 4-6

LLanguage Translations dialog box . . . . . 1-4Localization button . . . . . . . . . . . . . . . . 1-4

MManagingReporting and Analytics report

definitions . . . . . . . . . . . . . . . . . . 3-1Reporting and Analytics reports from Report

Builder . . . . . . . . . . . . . . . . . . . . . 3-5Teamcenter report definitions,

managing . . . . . . . . . . . . . . . . . . . 2-1

PLM00039 J Report Builder Guide Index-1

Index

Mapper application . . . . . . . . . . . . . . . . 3-1Menu, File . . . . . . . . . . . . . . . . . . . . . . 1-4Modifying Teamcenter reportdefinitions . . . . . . . . . . . . . . . . . . . . . . 2-1

PPerspectivesIn general . . . . . . . . . . . . . . . . . . . . . 1-5

Preferences . . . . . . . . . . . . . . . . . . . . . . 4-8Prerequisites for Report Builder . . . . . . . 1-2Property sets, creating . . . . . . . . . . . . . 1-13

RReport BuilderConcepts . . . . . . . . . . . . . . . . . . . . . . 1-6Folders . . . . . . . . . . . . . . . . . . . . . . . 1-4Getting started . . . . . . . . . . . . . . . . . 1-1Preferences . . . . . . . . . . . . . . . . . . . . 4-8Tabs . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Tasks . . . . . . . . . . . . . . . . . . . . . . . . 1-8Terms . . . . . . . . . . . . . . . . . . . . . . . . 1-7User interface . . . . . . . . . . . . . . . . . . 1-3

Report Data tab . . . . . . . . . . . . . . . . . . 1-4Report definitionsCreating . . . . . . . . . . . . . . . . . . . 1-8, 3-4Custom . . . . . . . . . . . . . . . . . . . . . . 1-12Deleting . . . . . . . . . . . . . . . . . . . . . . 2-1Exporting . . . . . . . . . . . . . . . . . . . . . 5-1Importing . . . . . . . . . . . . . . . . . . . . . 5-3Item . . . . . . . . . . . . . . . . . . . . . . . . 1-10Managing . . . . . . . . . . . . . . . . . . . . . 2-1Modifying . . . . . . . . . . . . . . . . . . . . . 2-1Summary . . . . . . . . . . . . . . . . . . . . . 1-8

Report generation . . . . . . . . . . . . . . . . . 4-1Reporting and AnalyticsAd hoc reports . . . . . . . . . . . . . . . . . . 3-4BuildNPlay and Mapper

applications . . . . . . . . . . . . . . . . . 3-1Cubes . . . . . . . . . . . . . . . . . . . . . . . . 3-2Managing report definitions . . . . . . . . 3-1Setting rights . . . . . . . . . . . . . . . . . . 3-1

Rich clientCustom reports . . . . . . . . . . . . . . . . . 4-4Generating reports . . . . . . . . . . . . . . . 4-1Item reports . . . . . . . . . . . . . . . . . . . 4-2Summary reports . . . . . . . . . . . . . . . . 4-1

Rich client perspectives and views . . . . . 1-5Rights to Reporting and Analyticsreports . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Roles, Reporting and Analytics . . . . . . . . 3-1

S

Set Permissions buttonBuildNPlay . . . . . . . . . . . . . . . . . . . . 3-5Report Builder . . . . . . . . . . . . . . . . . . 3-6

Setting rights to Reporting and Analyticsreports . . . . . . . . . . . . . . . . . . . . . . . . 3-1Starting Report Builder . . . . . . . . . . . . . 1-2StylesheetsAttaching to existing report

definitions . . . . . . . . . . . . . . . . . . 2-1Importing to existing report

definitions . . . . . . . . . . . . . . . . . . 2-2Summary reportsConcepts . . . . . . . . . . . . . . . . . . . . . . 1-6Creating . . . . . . . . . . . . . . . . . . . . . . 1-8Rich client . . . . . . . . . . . . . . . . . . . . . 4-1Thin client . . . . . . . . . . . . . . . . . . . . . 4-5

T

Tabs, Report Builder . . . . . . . . . . . . . . . 1-4TcRA Reports folder . . . . . . . . . . . . . . . 1-4Teamcenter Reports folder . . . . . . . . . . . 1-4Thin clientCustom reports . . . . . . . . . . . . . . . . . 4-7Generating reports . . . . . . . . . . . . . . . 4-5Item reports . . . . . . . . . . . . . . . . . . . 4-6Summary reports . . . . . . . . . . . . . . . . 4-5

U

User interface, Report Builder . . . . . . . . 1-3

V

Viewer tab . . . . . . . . . . . . . . . . . . . . . . 1-4Visual reports . . . . . . . . . . . . . . . . . . . A-1Creating complex visual reports . . . . A-2

Build custom method . . . . . . . . . A-6Create custom method . . . . . . . . A-3Define custom method . . . . . . . . A-4

Debug visual report . . . . . . . . . . . . . A-8Define visual report

Teamcenter . . . . . . . . . . . . . . . . A-6Visual reporting client . . . . . . . . A-8

Index-2 Report Builder Guide PLM00039 J

report builder guide - help!help.aviacons.ru/tc10doc/pdf/en_us/tdocext/pdf/report_builder.pdf ·...

Documents