SIEMENS

Teamcenter 11.2

Report Builder
PLM00039 • 11.2
Contents

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

About Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Orientation to the Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Reports Home folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Report Builder tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Report Builder menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
What are perspectives and views? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Basic concepts for using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
What is Report Builder used for? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Report Builder definition types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Report definition structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Report Builder terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Basic tasks using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Create report definitions and property sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Create report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Create property sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15

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

Managing Teamcenter report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Modify a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Delete a Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Attach a style sheet to an existing Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . 2-1
Import a style sheet to an existing Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . 2-2
Sample custom report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

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

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

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

PLM00039 11.2 Report Builder 3

 Contents
Contents

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

Generating Report Builder reports in the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Using the rich client to generating Report Builder reports . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Generate a summary report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Generate an item report on a Teamcenter object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Generate a custom report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Generating reports in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Using the thin client to generate reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Generate a summary report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Generate an item report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Generate a custom report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Generate reports from the Command Prompt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

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

Importing and exporting report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Export a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1
Import a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

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

Visual reporting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
Creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Introduction to creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Creating a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Define the visual report in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Define the visual report in the visual reporting client . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
Debug visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9

Upgrading standard Report Builder reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . B-1

Report Builder preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-1

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . D-1

4 Report Builder PLM00039 11.2

Chapter 1: Getting started with Report Builder

About Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Orientation to the Report Builder interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Reports Home folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Report Builder tabs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Report Builder menus . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Dashboard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
What are perspectives and views? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Basic concepts for using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6

What is Report Builder used for? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Report Builder definition types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Report definition structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-7
Report Builder terms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Basic tasks using Report Builder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8

Create report definitions and property sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Create report definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
What are the different types of report definitions? . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Create a summary report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-8
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Create a property finder formatter report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10
Create an item report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Create a custom report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Create property sets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-15
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-17

PLM00039 11.2 Report Builder

Chapter 1: Getting started with Report Builder

About Report Builder

Report Builder allows you to create and manage your own report definitions. These report definitions
provide end users with reports to run in the rich client or the thin client.
End users of the rich client use Report Builder to create new reports to meet their organization's
needs. Use Report Builder to create the following report definitions:
• Summary
Reports that summarize similar information, for example, reports that show all the 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 the BOM 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/TC XML Export Import
Administration application. To assemble reports, you can use saved queries created in Query Builder
and property sets created in PLM XML/TC XML Export Import Administration.

Before you begin

Prerequisites To use Report Builder, you must know how to use:
• Query Builder
Query Builder is a Teamcenter application that enables you to create and
maintain customized searches for objects in the Teamcenter databases.

• PLM XML/TC XML Export Import Administration

PLM XML/TC XML Export Import Administration helps you create transfer
mode objects that contain rules to configure import or export operations.

• PLM XML and TC XML schema

PLM XML and TC XML are the two schemas that Report Builder
uses. PLM XML is an open schema based on standard W3C XML
schemas. TC XML schema is a Siemens PLM Software format that uses
Teamcenter XML. Understanding these schemas allows you to work

PLM00039 11.2 Report Builder 1-1

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

with the XML-formatted organization of the data for import and export
to Teamcenter.

• Teamcenter data model

The data model objects define the objects and rules used in Teamcenter.
For example, some of the data model objects are items, item revisions,
and forms, along with the constructs holding the data.
Enable Report Report Builder does not need to be enabled before you use it. If you have
Builder trouble accessing Report Builder, see your system administrator. It may
be a licensing issue.
To work with Reporting and Analytics reports from Report Builder, install and
deploy Teamcenter reporting and analytics (Reporting and Analytics).
Configure Report You must set appropriate preferences to configure Report Builder.
Builder
• Add appropriate reporting source values to the
Valid_ReportBuilder_Sources preference.

• Add appropriate values to the

Enable_ReportBuilder_Reports_By_Source preference to view non
Teamcenter source reports.

• To control the columns and column width in Report Builder wizards, set
preferences as described in the Preferences and Environment Variables
Reference.
Start Report Builder
Click Report Builder in the rich client navigation pane.

Related topics
• What is Query Builder?

• Transfer mode objects

• Introduction to the Business Modeler IDE

1-2 Report Builder PLM00039 11.2

 Getting started with Report Builder

Report Builder interface

Orientation to the Report Builder interface

PLM00039 11.2 Report Builder 1-3

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

1 Reports Home tree The Reports Home tree pane displays the available report
definitions. The Teamcenter Reports folder contains report
definitions created using Report Builder. The TcRA Reports
folder contains report definitions created using Teamcenter
reporting and analytics.
2 Report Builder tabs The Report Builder tabs display file details, properties, and
configurable data for the selected report.
3 Localization button Displays the Language Translations dialog box that lists existing
translation values.

Related topics
• How do you know if a property is localizable?

• Report Builder tabs

• Teamcenter rich client

Reports Home folder

The Reports Home folder displays the available report definitions:
• Teamcenter Reports
Displays all report definitions available from Teamcenter.

• TcRA Reports
Contains reports created with Reporting and Analytics. You can execute, view, edit, set
permissions, and delete Reporting and Analytics reports from Report Builder.

Report Builder tabs

The Report Builder tabs allow you to view different aspects of reports:
• Details
Displays the file details of the selected report definition.

• Viewer
Displays the properties of the selected report definition.

• Report Data
Holds the configurable data for the selected report definition. From this tab, you can modify report
definition data or delete a report definition.
For Reporting and Analytics reports, you can execute, modify, view, set permissions, and delete
report definitions from this tab.

Report Builder menus

The following File menu commands are unique to Report Builder:

1-4 Report Builder PLM00039 11.2

 Getting started with Report Builder

• Create Report
Launches the Create Report Definition Template wizard. This wizard allows report administrators
to create summary, item, and custom report definitions.

• Create Property Set

Launches the New Property Set wizard. This wizard allows report administrators to define new
property sets and modify existing property sets. Property sets contain properties displayed in
summary and item reports.
The New Property Set wizard contains the same functionality as the Property Set tab in the PLM
XML/TC XML Export Import Administration application. However, the Report Builder application
offers a graphical user interface to define property sets.

Related topics

• Property sets

• Create report definitions and property sets

• Create property sets

Dashboard
The Dashboard application shows the dashboard page of the Teamcenter Reporting and Analytics
application.

• To install the Dashboard application, start Teamcenter Environment Manager on UNIX/Linux

server or Windows server, and then select the Dashboard option under Extensions→Reporting
and Analytics.

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

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

What are perspectives and views?

Within the rich client user interface, application functionality is provided in perspectives and views.
Some applications use perspectives and views to arrange how functionality is presented. Other
applications use a single perspective and view to present information.
Note

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

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

PLM00039 11.2 Report Builder 1-5

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

Basic concepts for using Report Builder

What is Report Builder used for?

Report Builder lets administrators create and manage Teamcenter report definitions. After
administrators create the report definitions, users can use these definitions to generate 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 style sheet to format the output.

Report Builder definition types

Report Builder allows you to create three types of reports:

• Summary reports

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

• Item reports

Item reports are executed in the context of one or more objects, such as item revisions. Each
item report object is associated with a Teamcenter class and transfer mode object. Transfer mode
objects are created in the PLM XML/TC XML Export Import Administration application.
The difference between item and summary reports is that item reports require an object to be
selected and summary reports depend on a saved query. For example, when you select an
item type document, only the reports applicable to the document item and its relationships are
available to generate the report.

• Custom reports

Custom reports address special cases such as complex processing or calculations done through
custom code or when data is coming from external sources. Each custom report object is
associated with a custom program. When you select a custom report from a list, the server
launches the program and the custom process.
You can use custom reports especially when you register integration toolkit (ITK) functions and
want to use their output as an input for these reports.

1-6 Report Builder PLM00039 11.2

 Getting started with Report Builder

Report definition structure

The process of creating report definitions varies slightly based on the type of report definition you
choose to create.
Common structure in all reports include:
• A unique report ID that can be assigned automatically by the system.

• A report name and description.

• A style sheet dataset to reformat the report data for output.

Report Report type

properties Description Summary Item Custom
Specifies the saved query
Query source
used to find items to report.
Specifies structure
Closure rule processing for related
items.
PLM XML or TC XML report
Report format
output properties.

Specifies additional output

Property set
properties.

Specifies the type of items

Class allowed by the report.
Specifies structure
Transfer mode processing and filtering
for related items.
Specifies the program for
Process
the custom process path.

Specifies the output file

Output
name for the report.

Specifies variable input for

Parameters
the custom process.

The end user has the option to attach different style sheets to produce different types of reports in
HTML or Microsoft Excel format. For examples of how to format summary and item reports, refer
to the Report Builder sample style sheets. The sample style sheets are available on the corporate
server in the tc_data/crf/Resources directory.
Closure rules, transfer modes, and property sets are defined using PLM XML.

Related topics
• Transfer mode objects

PLM00039 11.2 Report Builder 1-7

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

Report Builder terms

• A saved query object allows end users to search for Teamcenter data model objects 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. Teamcenter manages data by grouping similar
types of data into classes.

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

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

• A style sheet defines and controls the report display. You can use the style sheet provided with
Teamcenter, or you can create a new style sheet to display your data in a different format.

Basic tasks using Report Builder

Create report definitions and property sets
You can create report definitions in Report Builder by choosing File→Create Report. Administrators
create the property sets used in reports by choosing File→Create Property Set.
Once the report definitions are created, end users can generate reports from My Teamcenter in
the rich client or from the thin client.

Related topics
• What are the different types of report definitions?

• Create property sets

• Generating reports

Create report definitions

What are the different types of report definitions?

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

Create a summary report definition

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

1-8 Report Builder PLM00039 11.2

 Getting started with Report Builder

Saved queries are the data source for summary report definitions. You can use the supplied 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:

a. In the Report ID box, type an ID or click Assign to automatically assign an 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_Sources preference.

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 Builder application, open the
Saved Queries folder in the left pane, and select the query. The values of the query
are displayed in the right pane. You can also create your own query using the Query
Builder application.

f. Click the arrow on the Closure Rule box if you want to use a closure rule to process the
query definition selected in the Query Source box. Closure rules specify how the data
structure is traversed by specifying which relationships are of interest.
Note

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

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

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

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

PLM00039 11.2 Report Builder 1-9

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

TCXML supports transfer option sets. These are created in PLM XML/TC XML Export
Import Administration and are used with Data Exchange to move data between Teamcenter
and Teamcenter Enterprise sites. You can set transfer options for a report by creating a
report_ID_transferoptions user preference. The parameter report_ID specifies the ID of the
report and is available in the Details tab. You can specify transfer options as name-value
pairs in the Values box of the preference dialog box.
An example of transfer options specified in the Values box is as follows:
opt_rev_select=allItemRevisions
opt_entire_bom=True

i. (For Active Workspace only) To allow users to generate the report asynchronously, select the
Run in Async check box.
The AsyncService translator uses the Dispatcher framework to independently process
asynchronous requests from the Teamcenter server using the Teamcenter SOA native C++
framework in the background mode.

j. Click Next.

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

a. Select the style sheet you wish 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 style sheet, click the Import stylesheets button, located under the + and –
buttons in the Report Stylesheets pane.
In the Import Stylesheet dialog box, in the Dataset Type box, select a type for the
new style sheet: HTML, MSExcel, MSWord, Text, or Xml. This option is required if
the end user wants to save the report as a dataset at the 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, choose Tools→Reports→Summary Reports
and select your new summary report.

Related topics
• Creating customized searches using Query Builder

• Using the rich client to generating Report Builder reports

Create a property finder formatter report

A set of property finder formatter (PFF) objects corresponding to the basic search types are delivered
as part of the standard Teamcenter installation. PFF objects are similar to query definitions, but they

1-10 Report Builder PLM00039 11.2

 Getting started with Report Builder

navigate the relationships in the object schema to locate the properties of the objects returned in the
search results. They provide the necessary links and relationships required to locate object properties
data without reformatting the query instance. You can use PFF reports to generate a report for a
large number of objects, for example, more than 2000 objects.

1. To activate report builder reports to support PFF reports, set the Crf_report_use_pff_rp site
preference to true. By default it is set to false.

2. (Optional) To specify a delimiter to separate the report ID and PFF name pair, set the
Crf_report_pff_delimit site preference. By default it is set to #.

3. Choose File→Create Report.

4. Select Summary Report and click Next.

5. 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 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_Sources preference.

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 Builder application, open the
Saved Queries folder in the left pane, and select the query. The values of the query
are displayed in the right pane. You can also create your own query using the Query
Builder application.

f. Click Next.

6. Select the default_pff_html.xsl style sheet and click the + button to move it to the Selected
Stylesheets pane.

If this style sheet is not available, import it from the TC_DATA\crf\resources directory, and then
click the + button to move it to the Selected Stylesheets pane.

7. Click Finish to create this report.

8. To establish a map between a report and PFF, set the Crf_report_pff_map site preference
by specifying a value, for example, TC_9_00_SUM_RPT_0003#ItemOwnership. Here,
TC_9_00_SUM_RPT_0003 is the report ID, ItemOwnership is the PFF, and # is the default
delimiter value specified in the Crf_report_pff_delimit site preference you set earlier.

PLM00039 11.2 Report Builder 1-11

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

Create an item report definition

Item reports are run on an individual item, such as an item revision. Each item report object is
associated with a transfer mode, which is created in PLM XML/TC XML Export Import Administration.
1. Choose File→Create Report.
The system displays the Create Report Definition Template wizard.

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.

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_Sources preference.

e. Click the arrow on the Class box to select a class, such as an item revision.
If you selected ItemRevision as the class, BOM Report is enabled. Select the BOM 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.

f. Click the arrow on the Transfer Mode box to select a transfer mode for the report definition.
A transfer mode object combines rules and property sets to define the context of the PLM
XML import or export operation. It stores the translation intent in the PLM XML product.
These objects are presented as context options when you import or export objects or system
data. If the transfer mode object does not exist, you can create it with the PLM XML/TC
XML Export Import Administration 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 the property set in the left pane. The
values of the selected property set appear in the right pane.
You can also create your own property set using the PLM XML/TC XML Export Import
Administration application.

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

1-12 Report Builder PLM00039 11.2

 Getting started with Report Builder

i. (For Active Workspace only) To allow users to generate the report asynchronously, select the
Run in Async check box .
The AsyncService translator uses the Dispatcher framework to independently process
asynchronous requests from the Teamcenter server using the Teamcenter SOA native C++
framework in the background mode.

j. (For Active Workspace only) To make this report template available in Active Workspace,
select the Use for Print check box.

k. Click Next.

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

a. Select the style sheet you wish to use in the Defined Stylesheets pane, and click the +
button to move it to the Selected Stylesheets pane.
Note

To import a style sheet, click the Import stylesheets button, located under the + and –
buttons in the Report Stylesheets pane.
In the Import Stylesheet dialog box in the Dataset Type box, select a type for the
new style sheet: HTML, MSExcel, MSWord, Text, or Xml. This option is required if
the end user wants to save the report as a dataset at the 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, choose one or more Teamcenter objects,
choose Generate Report from the shortcut menu, and select your new item report.

Related topics
• Transfer mode objects

• Introduction to creating classes

• Transfer mode objects

• Property sets

• Using the rich client to generating Report Builder reports

Create a custom report definition

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

PLM00039 11.2 Report Builder 1-13

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

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 assign an ID.

b. In the Name box, type a short description of 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_Sources preference.
Note

If you select Visual Report as your source, the report information pane changes.

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 application that generates
the output file.
This path is used to identify the operating system name for a process that generates an
XML data file output. This is used as the source dataset for the custom report.

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

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

f. Select Method to run a custom report against a type.

Select BOMLine to generate a BOM report and AuditDefinition to generate audit reports.
You can register ITKs and use their output as an input for the custom report. You might have
different ITKs for different reports. You can register these using name-value pair parameters.

A. Click the arrow in the Type Name box to select the type that is applicable to the custom
report.

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

4. (For Active Workspace only) To allow users to generate the report asynchronously, select the
Run in Async check box .
The AsyncService translator uses the Dispatcher framework to independently process
asynchronous requests from the Teamcenter server using the Teamcenter SOA native C++
framework in the background mode.

5. Click Next.

1-14 Report Builder PLM00039 11.2

 Getting started with Report Builder

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

a. Select the style sheet you wish to use for the report by selecting it in the Defined Stylesheets
pane and clicking the + button to move it to the Selected Stylesheets pane.
Note

To import a style sheet, click the Import stylesheets button, located under the + and –
buttons in the Report Stylesheets pane.
In the Import Stylesheet dialog box, in the Dataset Type box, select a type for the
new style sheet: HTML, MSExcel, MSWord, Text, or Xml. This option is required if
the end user wants to save the report as a dataset at the time the report is run.

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

c. Click Close.

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

For example, in My Teamcenter, in the rich client, choose Tools→Reports→Custom Reports,
and select your new custom report.

Related topics

• Using the rich client to generating Report Builder reports

• Sample custom report definition

• Define the visual report in Teamcenter

• Introduction to creating a custom method

Create property sets

Property sets are collections of Teamcenter data, such as class attributes or business object (type)
properties. You can create a property set that contains just the information you want to use in a
report. For example, you can create a property set that lists the name, ID, and description of items.
When you create a summary or item report definition, you can select the property set to use in the
report by clicking the selection arrow on the Property Set box.
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/TC XML Export Import
Administration application.
Note

It is important to understand Teamcenter class and attributes structure (the POM schema)
when you create property sets. Administrators can examine the 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 UML Editor.

PLM00039 11.2 Report Builder 1-15

 Chapter
Chapter 1: 1: Getting
Getting started
started with Report
with Report Builder
Builder

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 be exported from the
database and placed into reports.

5. Perform the following steps to locate the class or business object (type) whose properties 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 Settings button. 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 them in the pane.
The properties appear at the bottom of the dialog box.
For example, if you searched for the Item class, double-click the Item properties in the pane.

6. To change the order that the properties are placed into the set, click the up or down 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 right of the bottom
pane (also known as the clause table):
a. Click the + button located to the right of the clause table.

b. Click the arrow in the Primary Object Class Type cell and choose CLASS or 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 the following:
• DO

1-16 Report Builder PLM00039 11.2

 Getting started with Report Builder

Specifies that the action be executed.

• SKIP
Specifies that the relationship should not be followed. This directive is useful 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 the following example:
CLASS.Item:PROPERTY.last_mod_date:DO
CLASS.Item:PROPERTY.object_string:DO

After this property set runs, the resulting transformed data in the PLM XML looks 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>

Tip

Style sheets can handle only supported reference objects. Add only supported data types
such as int, logical, string, or date to a property set.

8. Click the Create button.

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

9. To verify that the property set works as expected, create a summary or item report definition that
uses the new property set. For example, choose File→Create Report, select Summary Report,
and click the arrow on the Property Set box to select the new property set for the report.
Note

When generating a report, if some attribute values of subtypes are missing on the report,
check the property set associated with the report and add attributes of the subtypes into
the property set.

Related topics

• Property sets

• Class structure and attribute inheritance

• What are the different types of report definitions?

PLM00039 11.2 Report Builder 1-17

Chapter 2: Managing Teamcenter report definitions

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

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

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

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

Import a style sheet to an existing Teamcenter report definition . . . . . . . . . . . . . . . . . . . . . . . 2-2

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

PLM00039 11.2 Report Builder

Chapter 2: Managing Teamcenter report definitions

Managing Teamcenter report definitions

You can manage the standard Teamcenter report definitions in the Teamcenter Reports folder. You
can edit or delete any Teamcenter report definition.
Reporting and Analytics report definitions are in the TcRA Reports folder.

Related topics
• Managing Reporting and Analytics report definitions

Modify a Teamcenter report definition

1. 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 the report definition.

4. Click Modify to save your changes.

Delete a Teamcenter report definition

1. 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. Click Delete.

Attach a style sheet to an existing Teamcenter report definition

1. 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. Select a defined style sheet and click + to add it to the selected style sheets column.

PLM00039 11.2 Report Builder 2-1

 Chapter
Chapter 2: 2: Managing
Managing Teamcenter
Teamcenter report
report definitions
definitions

4. Click Modify to save your changes.

Import a style sheet to an existing Teamcenter report definition

1. 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. Click the Import stylesheets button , located under the + and – buttons in the Report
Stylesheets pane.
The Import Stylesheet dialog box appears.

4. In the Dataset Type box, select a style sheet type for the new style sheet: HTML, MSExcel,
MSWord, Text, or Xml. This option is required if the end user wants 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 style sheet file. The style sheet must be
in XSL format.

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

7. Select the new style sheet in the Defined Stylesheets pane and click the + button to move it
to the Selected Stylesheets pane.
Note

To import a style sheet, 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 style sheet type for the new style sheet: HTML,
MSExcel, MSWord, Text, or Xml. This option is required if the end user wants to save the
report as a dataset at the time the report is run.

8. Click Modify to save your changes.

Sample custom report definition

When you create a custom report definition, you associate the custom report object with a custom
executable program. When you run the report in Teamcenter, Teamcenter runs the executable
program from the full path specified in the report's process path and waits until the process is
complete. The path specified as the output for the process contains the newly created XML file. The
Report Builder framework takes the XML, applies the style sheet, and creates the dataset in the New
Stuff folder in the Teamcenter rich client or in the context of the item it is run against.

2-2 Report Builder PLM00039 11.2

 Managing Teamcenter report definitions

Perform the following steps to run a sample custom report definition. This report invokes the
%TC_BIN%\query_xml.exe file that takes an input file named c6.xml.
1. Save the following custom report definition as TC_CUSTOM_RPT.xml in a temporary directory
named TC_CUSTOM_RPT. The directory name must be the same as the report name. For
example, save the TC_CUSTOM_RPT.xml file 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\test directory :
<?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 the Teamcenter
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

PLM00039 11.2 Report Builder 2-3

 Chapter
Chapter 2: 2: Managing
Managing Teamcenter
Teamcenter report
report definitions
definitions

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

5. In the Report Builder application, choose the Query Report and import the
default_xml_template.xsl style sheet.
The style sheet is located in the TC_ROOT\tcdata\report_writer directory.

6. In My Teamcenter in , choose Tools→Report Builder Reports and run the Query Report
report without choosing a style sheet.
This report runs the %TC_BIN%\query_xml.exe file and generates the C6_output.xml report file.

7. In the rich client, in My Teamcenter, choose Tools→Report Builder Reports and run the Query
Report report and choose a style sheet.
This report runs the TC_BIN\query_xml.exe file and generates the C6_output.xml report file
and applies the style sheet to generate the final HTML report.

Related topics
• Import a style sheet to an existing Teamcenter report definition

2-4 Report Builder PLM00039 11.2

Chapter 3: Managing Reporting and Analytics report definitions

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

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

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-5

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

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

PLM00039 11.2 Report Builder

Chapter 3: Managing Reporting and Analytics report definitions

Managing Reporting and Analytics report definitions

Reporting and Analytics is a stand-alone reporting application. When it is installed and deployed
in a Teamcenter environment, it integrates with Report Builder and displays reports in the TcRA
Reports folder.
Use the Reporting and Analytics Mapper and BuildNPlay applications to create and manage reports.
Use Mapper to set user rights and to create the cubes (similar to property sets) that are displayed in
reports. Use BuildNPlay to create and manage the Reporting and Analytics report definitions.
For more information about BuildNPlay and Mapper, see the Reporting and Analytics documentation.
The process for managing Reporting and Analytics reports is as follows:
1. In Mapper, set rights for users so they can create reports.

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

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

4. In Report Builder, manage the reports in the TcRA Reports folder.

Set rights to create and deploy reports

To create and deploy reports using BuildNPlay, a user must have the correct rights based on their role.
As an administrator, you use the Reporting and Analytics Mapper 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:

• EQUBE_DEFAULT
Allows BuildNPlay users to run Reporting and Analytics reports.

• EQUBE_SUPER
Allows BuildNPlay users to modify, save, delete, and deploy Reporting and Analytics 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 .

PLM00039 11.2 Report Builder 3-1

 Chapter
Chapter 3: 3: Managing
Managing Reporting
Reporting and Analytics
and Analytics report
report definitions
definitions

5. To expand the search results, choose the + button by All. Select the user on the left 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, they must be
assigned the EQUBE_DEFAULT and the EQUBE_SUPER roles.

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

Create a cube
If you want to create a report that has a specific set of data, you must first use Mapper to create a
cube that contains that data. A cube defines the data displayed in a Reporting and Analytics report.
For example, if a report has columns that list the item ID, description, and creation date, these
columns are provided by the cube.
Note

It is important to understand Teamcenter class and attributes structure (the POM schema)
when you create property sets. Administrators can examine the 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 UML Editor.

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

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 Connection for standard
user logon or 2-User Connection if you use Security Services single sign-on.

d. Click OK.
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 the cube, 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 right pane.

d. Click the Add to Tree button.

3-2 Report Builder PLM00039 11.2

 Managing Reporting and Analytics report definitions

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 arrow button 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 move them to the left
pane. For saved queries, only use those that are prefaced by SQ_.
Note

If use a class cube and you have chosen owning_user or owning_name, you must
remove their filters and convert these 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 to move 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 to something
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 .

Related topics
• Class structure and attribute inheritance

PLM00039 11.2 Report Builder 3-3

 Chapter
Chapter 3: 3: Managing
Managing Reporting
Reporting and Analytics
and Analytics report
report definitions
definitions

• Convert attributes to strings

Create and deploy an ad hoc report

In BuildNPlay, you can create a Reporting and Analytics report from a cube. You can deploy
it to Teamcenter so that it displays in the TcRA Reports folder. You must be assigned the
EQUBE_SUPER role to create reports.
The following procedure provides the basic steps for creating an ad hoc report. For more detailed
instructions, see the Reporting and Analytics BuildNPlay documentation.
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 Filter button .
BuildNPlay displays the filtering variables at the bottom of the window. Enter the 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 and those 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 redefine
at the time of retrieval.

3-4 Report Builder PLM00039 11.2

 Managing Reporting and Analytics report definitions

h. Select the factor.

BuildNPlay displays the attributes.

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

If you are using a saved query, you must only include the needed operators. For
example, use only == to enter matching data. If you include operators that do not
match the attribute, the data does not 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 the Add 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 a user who has
permissions to view the report and select the TcRA Reports folder.
The new report appears in the TcRA Reports folder.

Related topics
• Set rights to create and deploy reports

• Create a cube

Manage Reporting and Analytics report definitions from Report

Builder
If you have permissions to work with the Reporting and Analytics reports, you can execute, view,
edit, set permissions, and delete Reporting and Analytics report definitions from the Report Data
tab in Report Builder. This method launches the Reporting 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.

PLM00039 11.2 Report Builder 3-5

 Chapter
Chapter 3: 3: Managing
Managing Reporting
Reporting and Analytics
and Analytics report
report definitions
definitions

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

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

• Execute
Generates the report from within the Reporting and Analytics BuildNPlay application. In
BuildNPlay, enter any additional filter information and choose Submit and then Show Report.
Generating a Reporting and Analytics report this way is the same as running a Reporting and
Analytics report from My Teamcenter by choosing Tools→Reports→Summary Reports.

• View
Shows the report definition details in BuildNPlay.

• Modify
Opens the report definition for modification in BuildNPlay.

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

• Set Permissions
Allows you to change rights to the report in BuildNPlay. You are allowed to set permissions
on a report only if you have rights to work with the report definition 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 report definition or set
permissions.

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

Convert attributes to strings

When creating a cube using a class, you must convert typed reference attributes and Boolean
attributes to strings. For example, if you have chosen owning_user or owning_name, you must
convert them to strings. If you are using a saved query for the cube, you do not have to convert any
attributes to strings.
1. Log on to the Reporting and Analytics Mapper application.

2. Click Manage Views on the toolbar.

Mapper displays the Views tab.

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

3-6 Report Builder PLM00039 11.2

 Managing Reporting and Analytics report definitions

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 (for example,
ItemRevision.owning_user) and click the fn button in the upper right corner 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 convert to 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. You can 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 Server Metadata button .

PLM00039 11.2 Report Builder 3-7

Chapter 4: Generating reports

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

Generating Report Builder reports in the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Using the rich client to generating Report Builder reports . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Generate a summary report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Generate an item report on a Teamcenter object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Generate a custom report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Generating reports in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5

Using the thin client to generate reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Generate a summary report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-5
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Generate an item report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Generate a custom report in the thin client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-7
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-9

PLM00039 11.2 Report Builder

Chapter 4: Generating reports

Generating reports
You can generate Report Builder reports from the Teamcenter rich client or thin client interfaces. You
can also generate reports using the import_export_reports utility.

Generating Report Builder reports in the rich client

Using the rich client to generating Report Builder reports

You can generate Report Builder reports in My Teamcenter by choosing Tools→Reports→Report
Builder Reports or by right-clicking an object and choosing Generate Report.
The process of generating reports differs slightly depending on the type of report you choose. If style
sheets 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 if Reporting and Analytics
is installed and deployed in your Teamcenter environment. For Reporting and Analytics reports
defined as a snapshot or template, you see the report results in a Web browser. If the report is
redefinable, you see another page in the Web browser where you can enter additional criteria.
You can also save Reporting and Analytics reports as datasets in PDF, Excel, or XML format.

Generate a summary report

Summary reports are created from saved or dynamic queries. When you select a summary report
from a list of available summary reports, you are prompted to input query criteria.
1. In My Teamcenter in the rich client, choose Tools→Reports→Report Builder Reports.
The system displays the Report Generation Wizard.
If no reports are listed, no reports have been created by your system administrator.

2. Select a summary report.

Note

If you choose a Reporting and Analytics report, only Finish is available. When you choose
Finish, you are logged on to the Reporting and Analytics BuildNPlay application. Enter
any additional filter information and choose Show Report.

3. Click Next.

PLM00039 11.2 Report Builder 4-1

 Chapter
Chapter 4: 4: Generating
Generating reports
reports

4. Fill in criteria for the query. Only the objects that match the query are placed into the report.
Note

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

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 style sheet from the Report Stylesheets
list.

7. If the report is based on Office Template source, the Live Integration check box 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 and type 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 is based on the
style sheet selected from the Report Stylesheets list.

9. Click Finish.
If you did not choose a style sheet, the report is displayed in your default XML application. If you
chose an HTML spreadsheet, the report is displayed in a Web browser.
If you saved the report as a dataset, the report is saved in your default Home folder, for example,
Newstuff.
If you selected the Live Integration option, the report is in Bulk Live mode. Click the Save To
Teamcenter button in the report to save the changes you make in the report to Teamcenter.

Related topics
• Create a summary report definition

Generate an item report on a Teamcenter object

You can generate an item report from My Teamcenter in the rich client by choosing one or more
Teamcenter objects, such as an item revision. Only objects with associated reports have report
definitions displayed in the selection wizard. When you select a item report from a list of available
reports, you may be prompted for additional 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.

4-2 Report Builder PLM00039 11.2

 Generating reports

If no reports are listed, no reports have been created by your system administrator for the
selected object type. Teamcenter has standard item report definitions for item revisions.

3. Select an item report.

Note

If you choose a Reporting and Analytics report, only Finish is available. When you choose
Finish, you are logged on to the Reporting and Analytics BuildNPlay application. Enter
any additional filter information and choose Show Report.

4. Click Next.

5. For BOM reports, a Revision Rule box is displayed. Click the arrow at the end of the 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.

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

7. If you want to choose the format for the report, select a style sheet from the Report Stylesheets
list.

8. If the report is based on Office Template source, the Live Integration check box 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 and type 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 is based on the
style sheet selected from the Report Stylesheets list.

10. Click Finish.

If you did not choose a style sheet, the report is displayed in your default XML application. If you
chose an HTML spreadsheet, the report is displayed in a Web browser.
If you saved the report as a dataset, the report file is saved in your default Home folder, for
example, Newstuff.
If you selected the Live Integration option, the report is in Bulk Live mode. Click the Save To
Teamcenter button in the report to save the changes you make in the report to Teamcenter.

Related topics
• Create an item report definition

PLM00039 11.2 Report Builder 4-3

 Chapter
Chapter 4: 4: Generating
Generating reports
reports

Generate a custom report

Custom reports address special cases such as complex processing or calculations done through
custom code, or when data comes from external sources. Each custom report object is associated
with a custom program. When a custom report is selected from a list, the server launches the
program and the custom process.
1. In My Teamcenter in the rich client, choose Tools→Reports→Report Builder Reports.
The system displays the Report Generation Wizard.
If no reports are listed, no reports have been created by your system administrator.

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, and type the
parameter name and value.

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 a style sheet from the Report Stylesheets
list.

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

8. Click Finish.
If you did not choose a style sheet, the report is displayed in your default XML application. If you
chose an HTML spreadsheet, the report is displayed in a Web browser.
If you saved the report as a dataset, the report is saved in your default Home folder, for example,
Newstuff.

Related topics

• Create a custom report definition

• Debug visual reports

4-4 Report Builder PLM00039 11.2

 Generating reports

Generating reports in the thin client

Using the thin client to generate reports

You can generate reports in the Teamcenter thin client by choosing Tools→Reports→Report
Builder Reports. (You cannot create report definitions in 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 from Teamcenter saved queries.
When you select a summary report from a list of available summary reports, you are prompted to
input query criteria.
Custom reports are Report Builder reports that address special cases such as complex
processing or calculations done through custom code or when data comes from external sources.

• Item Reports
Item reports are Report Builder reports that are executed in the context of an individual object,
such as an item revision.
Note

You can generate Reporting and Analytics reports from the thin client if Reporting and Analytics
is installed and deployed in your Teamcenter environment. For Reporting and Analytics reports
defined as a snapshot or template, you see the report results in a Web browser. If the report is
redefinable, you see another page in the Web browser where you can enter additional criteria.
You can also save Reporting and Analytics reports as datasets 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 a summary report
from a list of available summary reports, you are prompted to input 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 system administrator.

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 Analytics BuildNPlay application. Enter any
additional filter information and choose Show Report.

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

PLM00039 11.2 Report Builder 4-5

 Chapter
Chapter 4: 4: Generating
Generating reports
reports

You can fill the query criteria in the query dialog box. Click the Query button to 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 Display Locale list.

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

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

7. Click OK.
If you did not choose a style sheet, the report is displayed in the Web browser as XML. If you
chose an HTML spreadsheet, the report is displayed as a formatted report in the Web browser.
If you saved the report as a dataset, the report is saved in your default Home folder, for example,
Newstuff. Refresh the view to see the report.

Related topics
• Create a summary report definition

Generate an item report in the thin client

You can generate an item report by selecting one or more Teamcenter objects, such as an item
revision object. Only objects with associated reports have report definitions to choose in the selection
wizard. When you select an item report from a list of available 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 system administrator for the
selected item type. Teamcenter has standard item reports for item revisions.
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 Analytics BuildNPlay application. Enter any
additional filter information and choose Show Report.

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

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

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

4-6 Report Builder PLM00039 11.2

 Generating reports

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

8. Click OK.
If you did not choose a style sheet, the report is displayed in the Web browser as XML. If you
chose an HTML spreadsheet, the report is displayed as a formatted report in the Web browser.
If you saved the report as a dataset, the report is saved in your default Home folder, for example,
Newstuff. Refresh the view to see the report.

Related topics
• Create an item report definition

Generate a custom report in the thin client

Custom reports address special cases such as complex processing or calculations done through
custom code, or when data comes from external sources. Each custom report object is associated
with a custom program. When a custom report is selected from 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 system administrator.

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 button and type the
parameter name and value.

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

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

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

7. Click OK.
If you did not choose a style sheet, the report is displayed in the Web browser as XML. If you
chose an HTML spreadsheet, the report is displayed as a formatted report in the Web browser.
If you saved the report as dataset, the report is saved in your default Home folder, for example,
Newstuff. Refresh the view to see the report.

PLM00039 11.2 Report Builder 4-7

 Chapter
Chapter 4: 4: Generating
Generating reports
reports

Related topics

• Create a custom report definition

Generate reports from the Command Prompt

You can use the import_export_reports utility to generate reports from the Teamcenter Command
Prompt on the Teamcenter server. You must execute this utility from a directory where you have
write access.
Use the –execute argument with the –f argument to execute reports and set the file they 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 the Teamcenter.

Related topics
• Importing and exporting report definitions

Report Builder preferences

Use 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 the ReportDefinition_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 the
ReportGenerationDlg_ColumnPreferences preference.

• ReportXMLGenerationRules
Defines the specific components of a BOM to be included or excluded in an XML report.

• Valid_ReportBuilder_Sources
Specifies the source of the report.

• Enable_ReportBuilder_Reports_By_Source

4-8 Report Builder PLM00039 11.2

 Generating reports

Specifies reports that will be shown in Report Builder. The reports shown in Report 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 click Index at
the bottom of the Options dialog box.

Related topics
• Report Builder preferences

PLM00039 11.2 Report Builder 4-9

Chapter 5: Importing and exporting report definitions

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

Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

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

Import a report definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

PLM00039 11.2 Report Builder

Chapter 5: Importing and exporting report definitions

Importing and exporting report definitions

The import_export_reports utility allows report definitions, their dependent data (for example, saved
query definitions and property set definitions), and their associated style sheets to be exported from
one Teamcenter server and imported to another.
import_export_reports {-import | —export | —execute} [-u=user-id -p=password –g=group]
–stageDir=directory -reportId=report-identifier —f=output-filename.xml [-h]

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 of the 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 name of the directory
that is created where the report definition and style sheets are written. On import,
this is the name of the directory where the report definition and style sheets are
located.

Related topics
• import_export_reports

Export a report definition

1. Ensure you are in the proper environment for running a command utility.
For example, on a Windows system where the corporate server is installed, click the Start button
and choose Programs→Teamcenter 11.2→Command Prompt.

2. Type the import_export_reports utility commands:

a. Enter the utility name: import_export_reports

b. Specify the action argument: –export

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

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

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

PLM00039 11.2 Report Builder 5-1

 Chapter
Chapter 5: 5: Importing
Importing and exporting
and exporting report
report definitions
definitions

Note

To find the ID for a report, in the Report Builder application select the report in the
Reports Home folder and view the ID on the Details 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 query definitions and property
set definitions, are included with the exported report definition.

Example
1. Consider a situation where you want to export an existing report definition Admin - 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_reports utility has write access
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. The folder 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
style sheets 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

Import a report definition

1. Ensure you are in the proper environment for running a command utility.
For example, on a Windows system where the corporate server is installed, click the Start button
and choose Programs→Teamcenter 11.2→Command Prompt.

5-2 Report Builder PLM00039 11.2

 Importing and exporting report definitions

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 –stageDir option, for
example, d:\tc_data.

e. Specify an existing report ID from the staging directory using the –reportId option, 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 the Export a report
definition topic.
Note

Ensure that the staging directory (C:\Temp\Reports) contains the report ID folder (the
folder whose name is the same as the report ID). This folder must contain the report
definition template and other style sheet 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.

PLM00039 11.2 Report Builder 5-3

Appendix A: Visual reporting

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

Creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2

Introduction to creating complex visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Creating a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Introduction to creating a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Define a custom method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4
Build the custom method in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Define the visual report in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7
Related topics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8
Define the visual report in the visual reporting client . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8

Debug visual reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9

PLM00039 11.2 Report Builder

Appendix A: Visual reporting

Visual reporting
Visual reporting allows you to quickly display and analyze parts of an assembly in meaningful 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 visual reporting client like NX.
Using Report Builder, you can define complex visual reports by creating custom methods and
defining a custom report.
You can execute these reports and view their results in a visual reporting client like NX.
The following visual reports are available in Report Builder:
Note

You can only view the definitions of these reports in Report Builder. To view the results of these
reports, use a visual reporting client like NX.
For more information, see the Visual Reporting guide in the NX help collection.

• Overall Status in Change Process

Shows status of parts currently in a change process. Colors all parts according to their overall
status in a change process.

• Overall Status in Workflow

Shows status of parts currently in a workflow process. Colors all parts according to their overall
status in workflow.

• Affected by Problem Report

Shows parts that are affected by a specified problem report. Colors all parts that are affected by
the specified problem report by its relationship to the specified problem report.

• Affected by Change Request

Shows parts that are affected by a specified change request. Colors all parts that are affected by
the specified change request by its relationship to the specified change request.

• Affected by Change Notice

Shows parts that are affected by a specified change notice. Colors all parts that are affected by
the specified change notice by its relationship to the specified change notice.

• Has Higher Revision

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

PLM00039 11.2 Report Builder A-1

 Appendix
Appendix A: A: Visual
Visual reporting
reporting

• Rule Evaluation Result

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

• Check-Mate Result
Shows parts that have Check-Mate results. Colors all parts according to their Check-Mate overall
result.
This report is not available in Report Builder. To use this report, import the
TC_9_0_00_VR_RPT_VAL_RESULT.xml file into Teamcenter using the import_export_reports
utility.

• Requirements Validation Status

Shows parts that have not fulfilled all their requirements. Colors all parts according to the
requirement validation status.
This report is not available in Report Builder. To use this report, import the
TC_9_0_00_VR_RPT_REQ_VAL_STATUS.xml file into Teamcenter using the
import_export_reports utility.

Creating complex visual reports

Introduction to creating complex visual reports

The following diagram shows the process of creating complex visual reports.

A-2 Report Builder PLM00039 11.2

 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 Visual Reporting guide in
the NX help collection.

Creating a custom method

Introduction to creating a custom method

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

PLM00039 11.2 Report Builder A-3

 Appendix
Appendix A: A: Visual
Visual reporting
reporting

Custom methods compute the set of properties supplied as input for the report using the context
provided. Custom methods do not process closure rules and property sets that are specified in the
report definition. The Report Builder framework processes the closure rules and property sets.
To create a custom method you must:

• Define the custom method.

• Build the custom method into Teamcenter.

When you create custom methods, use the following guidelines:

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

• The custom method localizes property display names in the report output.
Add report properties and custom property strings to the
TC_ROOT\install\lang\textserver\language \report_customization_display_text_locale.xml
file, and use the txtsvr API to retrieve the localized strings.

• To retrieve the display names of Teamcenter properties, use the AOM_UIF_ask_name API.
For more information about these Teamcenter Server APIs, see the Integration Toolkit Function
Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter developer
references when you install Teamcenter online help, or go to the Global Technical Access
Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

Related topics

• Custom exits

Define a custom method

Note

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

A-4 Report Builder PLM00039 11.2

 Visual reporting

Method registration
Methods must be registered against a type. For visual reports, the methods are registered against the
ReportDefinition type. Registration is done in the initialization 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
METHOD_function_t base_action
TC_argument_list_t * user_data
METHOD_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 with CrfGenerateVisualReport.
Example: For a custom method named CostReport, the msg_name value will be
CrfGenerateVisualReportCostReport.

• base_action
Corresponds to the custom function.

• user_data
Value if NULL.

• method
Corresponds to the output parameter.

Execution method
The 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

PLM00039 11.2 Report Builder A-5

 Appendix
Appendix A: A: Visual
Visual reporting
reporting

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 of the report.

• parameter_descriptors_t *spd
The list of search criteria or values to be used in refining the results of the report. Typically
these parameters are a list of strings to be used to fill in values for 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 described parameter types.

• parameter_descriptors_t *apd
The list of any parameter that does not fit the previously described parameter types.

The following are the primary ITK APIs used in the custom methods.
For more information about ITK APIs and other APIs which support additional functions, see the
Integration Toolkit Function Reference.
Note

To access the Integration Toolkit Function Reference, install the Teamcenter developer
references when you install Teamcenter online help, or go to the Global Technical Access
Center (GTAC):
https://support.industrysoftware.automation.siemens.com/docs/teamcenter/

• SSR_create_visual_report_objects

• SSR_create_report_property_objects

• SSR_set_report_property_data

• SSR_create_related_objects

A-6 Report Builder PLM00039 11.2

 Visual reporting

• SSR_set_related_object_data

• SSR_create_property_objects

• SSR_set_property_data

Build the custom method in Teamcenter

You can build a custom method in the Teamcenter Server using a custom library.

Define the visual report in Teamcenter

Note

Ensure you have added Visual Report as a value in the Valid_ReportBuilder_Sources

preference.

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 assign an ID.

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

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

d. From the Source list, select Visual Report.

The Source value is defined in the Valid_ReportBuilder_Sources preference.

4. Click the arrow on the Closure Rule box if you want to use a closure rule to process the query
definition selected in the Query Source box. Closure rules specify how the data structure is
traversed by specifying which relationships are of interest.
Note

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

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

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

PLM00039 11.2 Report Builder A-7

 Appendix
Appendix A: A: Visual
Visual reporting
reporting

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, and type or select the
parameter name, display name, parameter type, and value.
The following parameter types are available in their separate tabs:

• Report Properties
Specifies the properties to be returned by the visual report.

• Search Criteria
Specifies the context objects that should be filtered by Report Builder while delivering the
output.

• General
Any other paramenters required by the visual report.

8. Click Next.

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

a. Select the style sheet to use for the report by selecting it in the Defined Stylesheets pane
and clicking the + button to move it to the Selected Stylesheets pane.
Note

Style sheets for visual reports are not available by default. You must create your own
style sheets and import it in Teamcenter or use the available style sheets.

To import a style sheet, 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 style sheet type for the new style sheet: HTML,
MSExcel, MSWord, Text, or Xml. This option is required if the end user wants to save
the report as a dataset at the time the report is run.

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

c. Click Close.

Related topics
• Property sets

• Introduction to closure rules

Define the visual report in the visual reporting client

You must define the visual report in the visual reporting client to generate the reports.

A-8 Report Builder PLM00039 11.2

 Visual reporting

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

Debug visual reports

Note

Ensure you have added Visual Report as a value in the

Enable_ReportBuilder_Reports_By_Source preference.

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

The system displays the Report Generation Wizard.
If no reports are listed, no reports have been created by your system administrator.

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, and type the
parameter name and value.

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

5. If you want to choose the format for the report, select a style sheet from the Report Stylesheets
list.
Note

Style sheets for visual reports are not available by default. You must create your own style
sheets and import it in Teamcenter or use the available style sheets.

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

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 Home folder, for example,
Newstuff.

PLM00039 11.2 Report Builder A-9

Appendix B: Upgrading standard Report Builder reports

PLM00039 11.2 Report Builder

Appendix B: Upgrading standard Report Builder reports

Because of possible customization loss, the upgrade process does not automatically upgrade
standard Report Builder reports.
1. Back up report definitions using the import_export_reports utility with the -export argument.
This exports one report definition at a time:
import_export_reports -export
-u=user-name -p=password -g=group
-stageDir=${TC_DATA}/crf -reportId=REPORTID

If you have style sheet customizations, you can save them with using Report Builder by opening
the style sheet and saving to a local hard drive.

2. Update all standard reports using the following command:

import_export_reports -import -overwrite
-u=user-name -p=password -g=group
-stageDir=${TC_DATA}/crf -reportFile=${TC_DATA}/crf/CrfReports.xml

PLM00039 11.2 Report Builder B-1

Appendix C: Report Builder preferences

Valid_ReportBuilder_Sources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-2
Enable_ReportBuilder_Reports_By_Source . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-3
Default_Crf_OfficeTemplate_relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-4
ReportDefinition_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-5
ReportDefinition_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-6
ReportGenerationDlg_ColumnPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-7
ReportGenerationDlg_ColumnWidthPreferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-8
TC_RA_server_parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . C-9

PLM00039 11.2 Report Builder

Appendix C: Report Builder preferences

PLM00039 11.2 Report Builder C-1

 Appendix
Appendix C: C: Report
Report Builder
Builder preferences
preferences

Valid_ReportBuilder_Sources

DESCRIPTION
Specifies all valid sources available to the common reporting framework reporting
engine.
VALID
VALUES
Accepts one or more strings as values. Any invalid string is ignored.
Teamcenter
TcRA
Office Template
Visual Report
DEFAULT
VALUES
Teamcenter
DEFAULT
PROTECTION
SCOPE
Site preference.

C-2 Report Builder PLM00039 11.2

 Report Builder preferences

Enable_ReportBuilder_Reports_By_Source

DESCRIPTION
Specifies the reports displayed in the Tools→Reports→Report Builder Reports
menu.
VALID
VALUES
Accepts one or more strings as values. Any invalid string is ignored.
DEFAULT
VALUES
Teamcenter
TcRA
Office Template
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00039 11.2 Report Builder C-3

 Appendix
Appendix C: C: Report
Report Builder
Builder preferences
preferences

Default_Crf_OfficeTemplate_relation

DESCRIPTION
Specifies the relation between the report definition and the associated Microsoft Office
template.
VALID
VALUES
Any valid relation.
DEFAULT
VALUES
IMAN_reference
DEFAULT
PROTECTION
SCOPE
Site preference.

C-4 Report Builder PLM00039 11.2

 Report Builder preferences

ReportDefinition_ColumnPreferences

DESCRIPTION
Determines which columns are displayed in the Report Builder application. This
preference can also be set by editing column options directly from the interface.
Note

Column widths are defined using the

ReportDefinition_ColumnWidthPreferences preference.

VALID
VALUES
Accepts one or more strings as values. Each string must be one of the following
report definition attributes:
rd_id
rd_name
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
VALUES
rd_id
rd_name
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00039 11.2 Report Builder C-5

 Appendix
Appendix C: C: Report
Report Builder
Builder preferences
preferences

ReportDefinition_ColumnWidthPreferences

DESCRIPTION
Specifies the column width for each column defined in the
ReportDefinition_ColumnPreferences preference.
VALID
VALUES
Accepts one or more integers as values. Each integer defines the column width in
characters. The first value set in this preference defines the column width of the first
value set in the ReportDefinition_ColumnPreferences preference, and so on.
DEFAULT
VALUES
20
20
13
17
13
9
17
17
9
9
17
17
17
DEFAULT
PROTECTION
SCOPE
Site preference.

C-6 Report Builder PLM00039 11.2

 Report Builder preferences

ReportGenerationDlg_ColumnPreferences

DESCRIPTION
Determines which columns are displayed in the Report Generation wizard. This
preference can also be set by editing column options directly from the interface.
Note

Column widths are defined using the

ReportGenerationDlg_ColumnWidthPreferences preference.

VALID
VALUES
Accepts one or more strings as values. Each string must be one of the following
report definition attributes:
rd_id
rd_name
rd_type
rd_class
rd_state
rd_source
rd_query_source
rd_property_source
owning_group
owning_user
last_mod_date
last_mod_user

DEFAULT
VALUES
rd_id
rd_name

DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00039 11.2 Report Builder C-7

 Appendix
Appendix C: C: Report
Report Builder
Builder preferences
preferences

ReportGenerationDlg_ColumnWidthPreferences

DESCRIPTION
Specifies the column width for each column defined in the
ReportGenerationDlg_ColumnPreferences preference.
VALID
VALUES
Accepts one or more integers as values. Each integer defines the column width in
characters. The first value set in this preference defines the column width of the first
value set in the ReportGenerationDlg_ColumnPreferences preference, and so on.
DEFAULT
VALUES
20
20
DEFAULT
PROTECTION
SCOPE
Site preference.

C-8 Report Builder PLM00039 11.2

 Report Builder preferences

TC_RA_server_parameters

DESCRIPTION
Configures the Teamcenter reporting and analytics (Reporting and Analytics)
parameters at the site level: server host, port, and application name. Use Reporting
and Analytics, powered by eQube, to view, modify, and create reports.
VALID
VALUES
Accepts multiple strings as values in the following format:
Host:application-server-host-name
Port:port-number
Context:application-context
ServletName:eQube-servlet-name
ServiceDashboard:action=url of the Reporting and Analytics dashboard
DEFAULT
VALUES
Host:localhost Port:80 Context:eQube ServletName:eQubeServlet
ServideDashboard:action=Dashboard
DEFAULT
PROTECTION
SCOPE
Site preference.

PLM00039 11.2 Report Builder C-9

Appendix D: Glossary

PLM00039 11.2 Report Builder

Appendix D: Glossary

access control list (ACL)

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

ACL
See access control list (ACL).

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

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

My Teamcenter
In the Teamcenter rich client and thin client, application that is the main access point for managing
product information. My Teamcenter provides the functionality for creating objects in the Teamcenter
database, querying the database for objects, checking in and checking out objects, and managing
tasks. Users can also open objects, automatically launching the related application.
Each user has a personal My Teamcenter window that displays product information as graphical
objects. Although users share product information across the enterprise, they organize this
information individually in personal workspaces.

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

navigation pane
Rich client framework component that displays buttons of the applications available for use in the rich
client. Clicking the application button launches the application.

PLM00039 11.2 Report Builder D-1

 Appendix
Appendix D: D: Glossary
Glossary

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

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

preference
Configuration variable stored in a Teamcenter database and read when a Teamcenter session is
initiated. Preferences allow administrators and users to configure many aspects of a session, such as
user logon names and the columns displayed by default in a properties table.

properties
Keys and values that specify the configuration settings for an application in the Teamcenter rich client.

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

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

site preference
Teamcenter preference that applies to the entire site.

Structure Manager
Teamcenter application that enables creation of generic product structures that can be configured
to show the product structure that is in production, effective on a certain date, used by a particular
customer, and so forth. Structure Manager enables creation and modification of a product structure
and its associated occurrence data, display of a product structure in a multilevel indented format, and
viewing graphics tightly coupled to the structure for easy identification of a component by location in
the structure or in the embedded viewer.

system administrator
Teamcenter user who is a member of the system administration group.

D-2 Report Builder PLM00039 11.2

 Glossary

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

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

value
Content of a field or variable. It can refer to alphabetic, numeric, or alphanumeric data.

PLM00039 11.2 Report Builder D-3

Siemens Industry Software

Headquarters
Europe
Granite Park One
Stephenson House
5800 Granite Parkway
Sir William Siemens Square
Suite 600
Frimley, Camberley
Plano, TX 75024
Surrey, GU16 8QD
USA
+44 (0) 1276 413200
+1 972 987 3000

Asia-Pacific
Americas
Suites 4301-4302, 43/F
Granite Park One
AIA Kowloon Tower, Landmark East
5800 Granite Parkway
100 How Ming Street
Suite 600
Kwun Tong, Kowloon
Plano, TX 75024
Hong Kong
USA
+852 2230 3308
+1 314 264 8499

About Siemens PLM Software

© 2015 Siemens Product Lifecycle Management

Siemens PLM Software, a business unit of the Siemens
Software Inc. Siemens and the Siemens logo are
Industry Automation Division, is a leading global provider
registered trademarks of Siemens AG. D-Cubed,
of product lifecycle management (PLM) software and
Femap, Geolus, GO PLM, I-deas, Insight, JT, NX,
services with 7 million licensed seats and 71,000 customers
Parasolid, Solid Edge, Teamcenter, Tecnomatix and
worldwide. Headquartered in Plano, Texas, Siemens
Velocity Series are trademarks or registered trademarks
PLM Software works collaboratively with companies
of Siemens Product Lifecycle Management Software
to deliver open solutions that help them turn more
Inc. or its subsidiaries in the United States and in other
ideas into successful products. For more information
countries. All other trademarks, registered trademarks
on Siemens PLM Software products and services, visit
or service marks belong to their respective holders.
www.siemens.com/plm.