0% found this document useful (0 votes)
820 views

Teamcenter 12.0 Managing Administration Data: Siemens Siemens Siemens

Uploaded by

behnya
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
820 views

Teamcenter 12.0 Managing Administration Data: Siemens Siemens Siemens

Uploaded by

behnya
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 44

SIEMENS

Teamcenter 12.0

Managing
Administration Data
PLM00504 • 12.0
Contents

What is administration data? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Tools for managing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Example tasks and processes for managing site behavior . . . . . . . . . . . . . . . . . . . . . . . 3-1

Reconcile differences in administration data between Teamcenter sites . . . . . . . . . . . . . 4-1

Exporting administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

Why would I export administration data? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1


Export administration data using the admin_data_export utility . . . . . . . . . . . . . . . . . . . . . . . 5-1
Export full administration data using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2
Export partial administration data using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3
Considerations for partial export of administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6

Importing administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Why would I import administration data? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1


Perform a dry run import of administration data using the admin_data_import utility . . . . . . . . . 6-1
Perform a dry run import of administration data using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2
Import administration data using the admin_data_import utility . . . . . . . . . . . . . . . . . . . . . . . 6-5
Import administration data using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5
Postprocess imported volume objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7
Administration data import merge options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-8
Style sheet import behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9
Modifying an administration data package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-11
Import a modified administration data package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-13

Reporting administration data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Overview of administration data reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1


Administration Data Documentation report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1
Administration Data Comparison report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2
Administration Data Import (dry run) report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4
Administration Data Import (history) report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5

Managing Administration Data Video Gallery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Managing administration data across environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1


Copy and compare administration data across environments . . . . . . . . . . . . . . . . . . . . . . . . A-1
Manage administration data tools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Generate an administration data report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-2
Generate dry run and import reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3
Generate a comparison report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-4

PLM00504 12.0 Managing Administration Data 3


Contents
Contents

Tables

Preference import actions for Item dataset cases . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10


Preference import actions for Item Revision and Document Revision datasets cases . . 6-11

4 Managing Administration Data PLM00504 12.0


Chapter 1: What is administration data?

Administration data is data within the database that defines:


• The behavior of the site.

• Who has access to information in the database.

Administration data comprises the following data categories:

Access Manager Project Stylesheets


Logical Objects Revision Rules Subscriptions
Organization Saved queries Workflow
Preferences

Administration data is not maintained in BMIDE projects, nor is it maintained in solution templates.
You can use administration data reporting capabilities to generate interactive reports of administration
data, which you can use to analyze and troubleshoot a site, and to compare differences in data
between sites.

You can use adminstration data export and administration data import to copy and paste
administration data across Teamcenter sites.

PLM00504 12.0 Managing Administration Data 1-1


Chapter
Chapter 1: 1: WhatWhat is administration
is administration data?data?

Note
To safeguard functionality and data integrity in a production site, similar sites are often
created apart from the production site for purposes of development, training, patch testing,
and troubleshooting. These purposes are supported by the ability to report and analyze
administration data, and the ability to export and import administration data across sites.
You can review the default administration data for Teamcenter. The information is
contained in the Administration Data Report included in the References for Administrators
and Customizers collection. You can access this collection two ways:
Local Network
Install the Siemens PLM Documentation Server on your local network, and then install
the References for Administrators and Customizers collection.
Doc Center
Find the References for Administrators and Customizers collection on Siemens PLM
Doc Center. You must have a WebKey account to access the collection.

1-2 Managing Administration Data PLM00504 12.0


Chapter 2: Tools for managing administration data

You can invoke tools for managing administration data from the command line and, to a lesser extent,
in the Teamcenter Environment Manager (TEM).

Tool function Command Line tool TEM tool


Export administration data from admin_data_export Manage Administration Data
the current site into an export panel export options.
package file.
Import administration data admin_data_import Manage Administration Data
from an administration data panel import options.
export package into the current
Teamcenter site.
Generate an interactive report of generate_admin_data_report None.
administration data contained in
a site or in an administration data
export package file.
Generate an interactive report generate_admin_data_ None.
of differences between the compare_report
administration data in an
administration data export
package file and either the
current site or another package
file.

PLM00504 12.0 Managing Administration Data 2-1


Chapter 3: Example tasks and processes for
managing site behavior

The following task examples illustrate how you can use interactive administration data reports along
with administration data export/import utilities to manage your Teamcenter sites.

Task General process


Analyze how a site is Generate an interactive report of administration data at the site and
configured and troubleshoot review the report in any web browser.
configuration issues.
Ensure that one site is Export all administration data from one site and import it to another.
configured the same as
another. This capability is useful when you must ensure certain administration
data at one site exists at another site, such as a test site and a
training site or during site consolidation.

Spread workload for a Set up several isolated sites for work group teams to work on
project, such as adding particular parts of a development project. A team can make changes
or modifying multiple in its site and then export the changed (partial) administration data.
workflows, among teams. You can then consolidate the changes by importing the administration
data from the multiple partial export packages into one site, such as
a sandbox site for final testing.

PLM00504 12.0 Managing Administration Data 3-1


Chapter
Chapter 3: 3: Example
Example
taskstasks and processes
and processes for managing
for managing site behavior
site behavior

Task General process


Determine the cause Generate a report that compares the administration data from a
of differences in site source site with the administration data in a target site. Then analyze
behavior and troubleshoot the report of differences in administration data to determine the cause
configuration issues. of differences in site behavior.
You can also use the report to provide information to an administrator
at a different site.

Determine when a particular Review a site's administration data import history report to track
change was introduced to a impacts of importing administration data over time. This report is
site. automatically updated upon each successful administration data
import to the site.

3-2 Managing Administration Data PLM00504 12.0


Chapter 4: Reconcile differences in administration
data between Teamcenter sites

You may need to determine why two sites behave differently, or may want to ensure that the
administration data is the same at both sites to allow consolidation of data. Use the following process
to reconcile administration data between two sites.

1. Export the administration data from both sites.

2. Generate an administration data comparison report.


The report shows the areas that differ between the sites for each type of administration data.

3. View the comparison report and analyze the differences.

4. After you determine the administration data that requires modification at a target site, import the
data from the source administration data package. Set the appropriate merge options during the
import to ensure you get the only the desired data modification.

Caution
When you export and import administration data between sites, it is important that the
schemas for the administration data and any related objects involved in the transfer are the
same at both sites.

Example
Given a situation where:
• A custom business object type exists in the schema at an exporting (source) site, but
not at the importing (target) site.

• A revision rule included in the administration data export refers to an instance of the
custom business object.

Then:

PLM00504 12.0 Managing Administration Data 4-1


Chapter
Chapter 4: 4: Reconcile
Reconcile differences
differences in administration
in administration data data between
between Teamcenter
Teamcenter sites sites

• The administration data import succeeds, but errors occur during activities involving
the revision rule due to the nonexistent custom business object.

4-2 Managing Administration Data PLM00504 12.0


Chapter 5: Exporting administration data

Why would I export administration data?


Export administration data from a site into an administration data export package, which you can
use when you want to:
• Configure a target site the same as the source site.

• Export administration data from a test site, so you can import it to a production site.

• Collect information on a site, so you can compare it to another site.

• Export partial administration data from multiple developers into a source code management
(SCM) system for compilation into a comprehensive set of administration data.

You can use either the admin_data_export command line utility or the Teamcenter Environment
Manager (TEM) to export administration data into an administration data package. Procedures in
the TEM vary for partial export and full export.

Note
It is important to be aware of the considerations for partial export of administration data.

Export administration data using the admin_data_export utility


You can use either the admin_data_export command line utility or the Teamcenter Environment
Manager to export administration data into an administration data package. Procedures in the
Teamcenter Environment Manager vary for partial export and full export.

Note
It is important to be aware of the considerations for partial export of administration data.

Export administration data using the admin_data_export utility

At a Teamcenter command prompt, run the admin_data_export utility.

Tip
When the export completes, you may want to use the generate_admin_data_report utility
to generate a report of the site administration data contained in the package.

PLM00504 12.0 Managing Administration Data 5-1


Chapter
Chapter 5: 5: Exporting
Exporting administration
administration data data

Export full administration data using TEM


You can select the categories of data to export by using the Full export option in Teamcenter
Environment Manager (TEM).

1. Start TEM.

a. In the Maintenance panel, select Configuration Manager and click Next.

b. In the Configuration Maintenance panel, select Perform maintenance on an existing


configuration and click Next.

2. Select the configuration for the site where you want to export the administration data file and
click Next.

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Full export option and click Next.

5. In the Full Administration Data Export panel, specify the administration data package and the
categories to export and click Next.

5-2 Managing Administration Data PLM00504 12.0


Exporting administration data

a. Click the ... button to the right of the Administration Data Package box to browse to the
location where you want to place the administration data package.

b. Select the administration data categories to export and click Next.

6. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

7. In the Confirmation panel, review the choices and click Start.

On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files that are used later for
importing into another Teamcenter environment.

Export partial administration data using TEM


You can use either the admin_data_export command line utility or the Teamcenter Environment
Manager to export administration data into an administration data package. Procedures in the
Teamcenter Environment Manager vary for partial export and full export.

Note
It is important to be aware of Considerations for partial export of administration data.

You can export specific administration data components using the Partial export option in
Teamcenter Environment Manager (TEM). You select the specific instances of administration data by
category, class, and specific attribute/value criteria.
However, each administrative data type supports only specific elements in partial export, but not all.
For example, Access Manager supports only Named ACL and Privilege elements to be exported
partially, but not rule trees.

Export partial administration data using TEM

1. Start TEM.
a. In the Maintenance panel, select Configuration Manager and click Next.

b. In the Configuration Maintenance panel, select Perform maintenance on an existing


configuration and click Next.

2. Select the configuration for the site where you want to export the administration data file and
click Next.

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Partial export option and click Next.

PLM00504 12.0 Managing Administration Data 5-3


Chapter
Chapter 5: 5: Exporting
Exporting administration
administration data data

5. Use the Partial Administration Data Export panel to specify the administration data to export.

a. Click the ... button to the right of the Administration Data Package box to browse to the
location where you want to place the administration data package.

b. Click the arrow in the Category Name box to select the administration data category to export.

c. Click the arrow in the Export box to select the administration data class to export.

d. Refine the administration data that is exported by using rows in the table.
A. Type the Attribute and Value pair.
Depending on what you select from the Export list, the system may supply an entry for
the Attribute.

5-4 Managing Administration Data PLM00504 12.0


Exporting administration data

B. Click the Add button to the right of the table to add rows for additional attribute/value
pairs and select the Boolean Operator to define how the attributes are added.
To delete an attribute/value pair, select a row from the table and click the Remove button.

C. Click Next.

6. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account.

7. In the Confirmation panel, review the choices and select Start.

On successful export, TEM packages the exported administration data to the specified packaging
directory. The export package contains the administration data in TC XML files used later for
importing into another Teamcenter environment.

Tip
When the export completes, you may want to use the generate_admin_data_report utility
to generate a report of the site administration data contained in the package.

Examples of partial export attributes and values using TEM


Following are some example attributes and values for partial administration data export using
Teamcenter Environment Manager. Depending on your selection from the Export list, the system
may supply an entry for Attribute. These are examples only. The attributes and values listed here
may not match what you have in your system.

Category name Export Attribute (example) Value (example)


Access Manager Named ACL ACL_Name System
Privilege Privilege_Name READ
Organization Discipline discipline_name *
Group name Engineering
License Server fnd0name *
Person user_name *
Role role_name Designer
Site name *
Volume user_name *
Discipline volume_name volume
Preferences Preferences by Category Name Change Management
Category (supplied)
Preferences by Group Group Name Engineering
(supplied)
Preferences by Preference Name HiddenPerspectives
Preference Name (supplied)
Preferences by Role Role Name (supplied) Designer

PLM00504 12.0 Managing Administration Data 5-5


Chapter
Chapter 5: 5: Exporting
Exporting administration
administration data data

Category name Export Attribute (example) Value (example)


Preferences by User User Name (supplied) user0001
Project Project project_id *
Revision Rules Revision Rule object_name *
Saved Queries Saved Query query_name *
Stylesheets Stylesheets by Name (supplied) *SUMMARYRENDERING
Preference Name
Stylesheets by Name (supplied) Item*
Stylesheet Name
Subscriptions Subscription subscriber *
Workflow Named ACL ACL_Name Vault
Privilege Privilege_Name PROMOTE
Workflow Templates Name (supplied) Quick Release
by Name

Considerations for partial export of administration data


When you perform a partial export of administration data, keep in mind the following:
• With any partial export, the Access Manager privileges are always exported to maintain the
data integrity.

• Partial export of an Organization tree is supported bottom-up and not top-down. For example, if
you have the following tree and you are exporting the group1 group partially, the complete tree
may not be exported. But if you export the user1 user partially, the complete tree is exported.
group1
- role1
- user1

5-6 Managing Administration Data PLM00504 12.0


Chapter 6: Importing administration data

Why would I import administration data?


Import administration data previously exported from a source site into a target site when you want to:

• Configure the target site the same as the source site.

• Move administration data configured on a test environment into a production environment.

When importing administration data, you can use merge options to control whether the source or
target takes precedence.
Before actually importing data, you can perform a dry run import, and then review the dry run report
to analyze the potential impact and resolve any conflicts. You can perform the dry run import using
either the admin_data_import utility or using Teamcenter Environment Manager (TEM).
You can import administration data using either the admin_data_import utility or using Teamcenter
Environment Manager (TEM).

Perform a dry run import of administration data using the


admin_data_import utility
Using an administration data package file that is the output of exporting administration data from
a source site, you can perform a dry run import to a target site to see the impact before actually
importing data. You can perform the dry run import using the admin_data_import utility or using TEM.

Perform the dry run data import using the admin_data_import utility

At a Teamcenter command prompt, run the admin_data_import command line utility with the
-dryrun argument.

Note
Use the -mergeOption argument to specify the merge options to set for each data type.

View the Administration Data Import (dry run) report

To view the dry run report, after the run completes, browse to the following location:
TC_ROOT\logs\admin_data_import_history\Import_date-and-time\index.html

The following image shows the summary page of an example partial administration data import dry
run report. In an actual report, you can click links to navigate through the report.

PLM00504 12.0 Managing Administration Data 6-1


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

Perform a dry run import of administration data using TEM


Using an administration data package file that is the output of exporting administration data from
a source site, you can perform a dry run import to a target site to see the impact before actually
importing data. You can perform the dry run import using the admin_data_import utility or using TEM.

Perform the dry run data import using Teamcenter Environment Manager

1. Start TEM.
a. In the Maintenance panel, select Configuration Manager and click Next.

b. In the Configuration Maintenance panel, select Perform maintenance on an existing


configuration and click Next.

2. Select the configuration for the site where you want to import the administration data file and
click Next.

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Dry run import option and click Next.

6-2 Managing Administration Data PLM00504 12.0


Importing administration data

5. In the Dry Run Import Administration Data panel, click the ... button in the Administration
Data Package box and select the administration data package. Click Next.

6. In the Import Merge Options panel, select the merge option for each category and click Next.

PLM00504 12.0 Managing Administration Data 6-3


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

7. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

8. In the Confirmation panel, review the choices and click Start.

9. In the Install panel, monitor the Overall Progress or select Show Details to see the install status.

View the Administration Data Import (dry run) report

To view a dry run report, after the run completes, browse to the following location:
TC_ROOT\logs\admin_data_import_history\Import_date-and-time\index.html

The following image shows the summary page of an example partial administration data import dry
run report. In an actual report, you can click links to navigate through the report.

6-4 Managing Administration Data PLM00504 12.0


Importing administration data

Import administration data using the admin_data_import utility


After you perform a dry run import to a target site to see the impact and resolve conflicts, you can
import the administration data using the admin data_import command line utility.
Run the utility from a Teamcenter command prompt similar to the following:
admin_data_import -u=admin-username -p=admin-password -g=dba
-adminDataTypes=all -inputPackage=D:\apps\Siemens\Teamcenter11\administration_data.zip
-mergeOption=AccessManager:override_with_source,Organization:override_with_source,Preferences:choose_latest,
RevisionRules:choose_target_for_unresolvable_conflicts,SavedQueries:keep_target,Stylesheets:keep_target,
Subscriptions:keep_target,WorkflowTemplates:override_with_source

In this example, the -adminDataTypes=all argument specifies to import all data types available in the
input package, and the -mergeOption argument specifies the merge options to set for each data type.
After the import, access the results from the following location:
TC_ROOT\logs\admin_data_import_history\Import_date-and-time\index.html

Following is an example import report.

Import administration data using TEM


The type of administration data that you can import is determined by what the import package
contains. If there is more than one category of data in the file, you can select the categories that you
want to import.
1. Start Teamcenter Environment Manager (TEM).
a. In the Maintenance panel, select Configuration Manager and click Next.

b. In the Configuration Maintenance panel, select Perform maintenance on an existing


configuration and click Next.

2. Select the configuration for the site where you want to import the administration data file and
click Next.

PLM00504 12.0 Managing Administration Data 6-5


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

3. In the Feature Maintenance panel, select the Manage Administration Data option under
Teamcenter Foundation and click Next.

4. In the Manage Administration Data panel, select the Import option and click Next.

5. In the Import Administration Data panel, click the ... button to the right of the Administration
Data Package box to select the administration data package to import. Click Next.

6. In the Import Merge Options panel, select the merge option for each category and click Next.

6-6 Managing Administration Data PLM00504 12.0


Importing administration data

7. In the Teamcenter Administrative User panel, enter the logon information for the Teamcenter
administrative user account and click Next.

8. In the Confirmation panel, review the choices and select Start.

9. In the Install panel, monitor the Overall Progress or select Show Details to watch the install
status.

10. After the import, access the results from the following location:
TC_ROOT\logs\admin_data_import_history\Import_date-and-time\index.html

Following is an example import report.

Postprocess imported volume objects


If your imported administrative package contains volume objects, the volume's host and FMS
configuration must be updated with the importing site data.
1. Extract the VolumeAttributeUpdateInput.xml file from the export package.

2. Open the file and update the host name and host path with the importing site's host name and
path.

3. Run the tc_attribute_bulk_update utility with the updated VolumeAttributeUpdateInput.xml


file as in -inputfile argument value, for example:
tc_attribute_bulk_update –u=infodba –p=infodba –g=dba
–inputfile=VolumeAttributeUpdateInput.xml –import

4. Run the update_fms_configuration utility to update the FSC configuration, for example:
update_fms_configuration –u=infodba –p=infodba –g=dba
–volumes=volume-names-in-comma-separated-list -fsc_id=fsc-id

PLM00504 12.0 Managing Administration Data 6-7


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

Administration data import merge options


When you import administration data, for each category of administration data you must specify
how to handle data conflicts between the target (importing) site administration data and the source
(exporting) site data in the input package.
Following are the available merge options:
Override With Source
Overrides target objects with source objects. If an object exists in both environments, the
attributes on the object are taken from the source environment and updated on the object in the
target environment during the import. If an object in the source environment does not exist in the
target environment, it is imported to the target environment.
To avoid unexpected behavior that could result from mixing the rule tree contents, this is the only
option available for Access Manager administration data.
Keep Target
Keeps the target site’s administration data for all conflicts. If an object exists in both environments,
the object in the target environment is kept as-is. If an object in the source environment does not
exist in the target environment, it is imported to the target environment.
Choose Latest
Chooses objects that were last saved (based on the Last Saved Date property value). If an
object exists in both environments and the one in the source environment was saved last, the
attributes on the object in the source environment are used to update the attributes of the object
in the target environment during the import. If the object in the target environment was saved last,
the attributes on the object in the source environment are not imported. If an object in the source
environment does not exist in the target environment, it is imported to the target environment.
Choose Source for Unresolvable Conflicts
Chooses objects from the source environment if they were edited in the source environment and
not in the target environment since the last import. If an object exists in both environments, the
attributes on the object in the source environment are used to update the attributes on the object
in the target environment during the import. If an object was edited only in the target environment
and not the source environment since the last import, the object is left as-is at the time of import.
If an object in the source environment does not exist in the target environment, it is imported
to the target environment.
This option is not available for workflow administration data.
Choose Target for Unresolvable Conflicts
Chooses objects from the target environment if they were edited in the target environment and
not in the source environment since the last import. If an object was edited only in the target
environment and not the source environment since the last import, the object is left as-is at the
time of import. If an object in the source environment does not exist in the target environment, it
is imported to the target environment.
This option is not available for workflow administration data.

How you set import merge options depends on which method you use to perform the import, either
with the admin_data_import utility or with the Teamcenter Environment Manager (TEM):
• admin_data_import utility

6-8 Managing Administration Data PLM00504 12.0


Importing administration data

Use the -MergeOptions argument to specify the merge option to use with each administration
data category.

• Import Merge Options panel in TEM


When you perform a dry run import or a regular import of administration data, the Import Merge
Options panel is displayed. Select the merge option you want to use with each data category.

Tip
The default values on this panel are the actions that Siemens PLM Software
recommends you use in most cases to avoid unintentional changes.

Style sheet import behavior


By default, each style sheet has two preferences set. For example, the summary style sheet has the
following:
type-name.SUMMARYRENDERING=dataset-name
dataset-name.SUMMARY_REGISTEREDTO=type-name

If no preferences or only one preference is defined on a style sheet, then the style sheet is not in use.
During import, when the target database is missing one or both preferences for a style sheet, the
import is processed as if both preferences are defined in the target database.
The following tables show details of the import actions taken for the two preferences depending on
whether the preferences exist. The last column shows the target action when you select the import
option Choose Source or Choose Source For Unresolved Conflicts.

PLM00504 12.0 Managing Administration Data 6-9


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

Preference import actions for Item dataset cases


Target preferences after Target action with
Source preferences Target preferences Action import source option1
Item. First time import, dataset Added at source Item. Add at target
SUMMARYRENDERING does not exist. site. SUMMARYRENDERING site using import
package data.
ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Dataset does not exist Item. Added at target No change. None.
SUMMARYRENDERING site.

ItemSummary.
SUMMARY_REGISTEREDTO
Item. Item. First time created Item. Update using
SUMMARYRENDERING SUMMARYRENDERING at source. SUMMARYRENDERING source package.

ItemSummary. ItemSummary. First time created ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO at target not by SUMMARY_REGISTEREDTO
importing.
Item. Item. Change XML file Item. Update.
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING

ItemSummary. ItemSummary. ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Item. Item. Change XML file Item. Update using
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING source package.

ItemSummary. ItemSummary. Change XML file ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO content at target. SUMMARY_REGISTEREDTO
Item. Item. Change XML file Item. Add using source
SUMMARYRENDERING SUMMARYRENDERING content at source. SUMMARYRENDERING package.

ItemSummary. ItemSummary. Delete at target. ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Item. Delete at source. None.
SUMMARYRENDERING

ItemSummary.
SUMMARY_REGISTEREDTO
Item. Delete at target. None.
SUMMARYRENDERING

ItemSummary.
SUMMARY_REGISTEREDTO
Item. Item. Delete at source. Item. None.
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING
Delete at target.
ItemSummary. ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
Item. Item. Delete at source. Depends on SyncDelete SyncDelete
SUMMARYRENDERING SUMMARYRENDERING option.
Change at target. ON: Delete
ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO OFF: Keep target.

1. When you select either the Choose Source option or Choose Source for Unresolved Conflicts option.

6-10 Managing Administration Data PLM00504 12.0


Importing administration data

Preference import actions for Item dataset cases


Target preferences after Target action with
Source preferences Target preferences Action import source option1
Item. Item. Delete at source. Depends on SyncDelete SyncDelete
SUMMARYRENDERING SUMMARYRENDERING option.
ON: Delete
ItemSummary. ItemSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO OFF: Keep target.

Item. Item. Added at source Item. Add using source 2.


SUMMARYRENDERING SUMMARYRENDERING from source 2. SUMMARYRENDERING

ItemSummary. ItemSummary. Imported at target ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO from source 1. SUMMARY_REGISTEREDTO
Item. Item. Change at target. -override_ with_
SUMMARYRENDERING SUMMARYRENDERING source option,
update using
ItemSummary. ItemSummary. source package.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO
-choose_ source_
for_ unresolved_
conflicts option,
keep target.
Item. Item. Delete at target. Item. Add using source
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING package.

ItemSummary. ItemSummary. ItemSummary.


SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO

Preference import actions for Item Revision and Document Revision datasets cases
Target preferences after Target action with
Source preferences Target preferences Action import a source option2
ItemRevision. ItemRevision. Add at source. ItemRevision. Add at target
SUMMARYRENDERING SUMMARYRENDERING SUMMARYRENDERING site using import
Add at target. package data.
ItemRevisionSummary. ItemRevisionSummary. ItemRevisionSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO DocumentRevision
has it own
DocumentRevision. (DocumentRevision inherits DocumentRevision. stylesheet.
SUMMARYRENDERING ItemRevision’s summary SUMMARYRENDERING
style sheet.)
DocumentRevisionSummary. DocumentRevisionSummary.
SUMMARY_REGISTEREDTO SUMMARY_REGISTEREDTO

Modifying an administration data package


Normally, you do not need to alter the content of the administration data TC XML file. However, after
you export an administration data file, you can carefully modify the TC XML content of the file to
provide changes for specific sites or groups of sites.

2. Choose Source option or Choose Source for Unresolved Conflicts option.

PLM00504 12.0 Managing Administration Data 6-11


Chapter
Chapter 6: 6: Importing
Importing administration
administration data data

Note
Because mistakes in the TC XML file can cause corruption and possibly data loss during
import, import of a modified file requires an authorization key. You can obtain the key from
the Global Technical Access Center (GTAC) after passing the Manage Administration
Data self-paced course available from Learning Advantage. The course provides the
information necessary to avoid potential problems when editing the TC XML content of an
administration data file.

Following are rules for editing an administration data TC XML file:


• Ensure the uniqueness of elemId attributes across the TC XML file.

• Ensure the value of Boolean type attributes are Y (true) or N (false).

• Ensure the value of reference type attributes are formatted as:


#<elemId-of-the-GSIdentity-of-the-referenced-object>

• Ensure the value of date type attributes are in GMT format:


year-month-dayThour:minute:SecondZ

For example, for 09 September 2014 at 4:21:04 AM (GMT), 2014-09-23T04:21:04Z.

• Ensure the timestamp value is present.

• Ensure L10N attributes are list of values formatted as:


locale:M/S:M/A/P/R/I:sequence:[aA-zZ]^32:translation

A locale in the format of en_US: M/S is a master or secondary language.


M/A/P/R/I is the translation status.
The sequence number is 4 digits for multiple value attributes.
There are 32 characters reserved.
The rest is the translation, for example:

de_DE:S:A:0000::Proxy-Link,
en_US:S:A:0000::Proxy Link,
es_ES:S:A:0000::Enlace proxy,
fr_FR:S:A:0000::Lien proxy,
it_IT:S:A:0000::Collegamento proxy,
pt_BR:S:A:0000::Link de proxy

• When editing the attributes that are part of the candidate key, the GSIdentity label of the object,
and the label of the objects that reference the object, must be updated accordingly.

• Ensure all required attributes for the administration object have values.

• For out-of-the-box administration objects, a user's home, mailbox_folder, and newstuff_folder


attributes must not be added. Also, a dataset rev_chain_anchor attribute must not be added.
This is true even though these are required attributes.

6-12 Managing Administration Data PLM00504 12.0


Importing administration data

• After editing the file, validate the complete file content against LLTCXML.xsd file (low-level TC
XML schema) located in the TC_DATA directory to ensure the XML is valid.

Import a modified administration data package


Because mistakes in the TC XML file can cause corruption and possibly data loss during import,
import of a modified file requires an authorization key. You can obtain the key from the Global
Technical Access Center (GTAC) after passing the Manage Administration Data self-paced course
available from Learning Advantage. The course provides the information necessary to avoid potential
problems when editing the TC XML content of an administration data file.
1. In your Teamcenter environment, set the BULK_LOADER_AUTH_KEY environment variable to
the value of the authorization key.
This enables the bulk load capabilities that are used to import the modified package. If you do
not set this variable to a valid value, TEM returns an error message when you attempt to import
the modified package.

2. When importing the modified package in Teamcenter Environment Manager (TEM), select the
Ignore package validation check box.

This enables bulk load functionality that bypasses certain validation checks.

PLM00504 12.0 Managing Administration Data 6-13


Chapter 7: Reporting administration data

Overview of administration data reports


There are multiple reports that you can generate to help you manage the administration data at your
Teamcenter site. These reports are provided in an HTML format so you can use any browser to
view them.
• Administration data documentation report
Shows the specified administration data for the site where you run the utility or for an export
package.

• Administration data comparison report


Shows the differences between the administration data at two sites.

• Dry run import report


Shows changes that will occur due to importing an administrative data file from another site prior
to doing the actual import. Use this to determine the affects of importing the administration data
without changing the existing data.

• Import history report


Shows the administration data that was successfully imported at a particular point in time. A
separate report is generated for each successful import. The report file contains the site name
and a timestamp. You can use this to determine exactly what and when changes occurred
that may be affecting the behavior of the site.

Administration Data Documentation report


You can use interactive Administration Data Documentation reports to:
• Troubleshoot issues with configuration.
• Periodically review a production environment to ensure it complies with business objectives.
• Capture a snapshot of the configuration at a point in time for archiving or audit reviews.
• Train administrators.

Generate an Administration Data Report


Use the generate_admin_data_report utility to generate a report of site administration data.
• You can run the report for the current site or for an exported administration data package.
• You can report all Administration Data categories or only selected categories.

View an Administration Data Report


To view a generated report, browse to the output location and open the index.html file.

PLM00504 12.0 Managing Administration Data 7-1


Chapter
Chapter 7: 7: Reporting
Reporting administration
administration data data

The following image shows the summary page of an example report. In an actual report, you can
click links to navigate through the report to find summaries and details of administration data.

Administration Data Comparison report


You can use Administration Data Comparison reports to:

• Troubleshoot configuration differences between two environments to determine why the business
logic is behaving differently.
• Determine if a new setup environment is configured the same as a reference environment.
• Prepare for site consolidation by comparing sites to see what is in common and what is different.
• Determine the differences between a customer environment and an out-of-the-box Teamcenter
environment.
• Compare a baseline export of a site to the same site over time.

Generate an Administration Data Comparison report

Use the generate_admin_data_compare_report utility to generate a report comparing the source


site administration data export package file to either:

• The current site


• Another administration data export package file. (To create a site administration data export
package file, use the admin_data_export utility.)

7-2 Managing Administration Data PLM00504 12.0


Reporting administration data

View an Administration Data Comparison report

To view a generated report, browse to the output location and open the index.html file.
The following image shows the summary page of an example comparison report. Differences are
highlighted in yellow. In a real report, you can click links to navigate through the report to find
summaries and details of administration data.

Example
As you navigate to details of the report, you can easily identify even very small differences.
Permission difference in Access Manager.

Label difference in a Style Sheet.

PLM00504 12.0 Managing Administration Data 7-3


Chapter
Chapter 7: 7: Reporting
Reporting administration
administration data data

Administration Data Import (dry run) report


You can perform a dry run import to a target site in order to generate a report of the potential impact
before performing the actual import.

Generate an Administration Data Import (dry run) report

Perform a dry run import using either


• The admin_data_import utility with the -dryrun argument

• Or the Dry run import option in Teamcenter Environment Manager (TEM).

View an Administration Data Import (dry run) report

To view a dry run report, after the run completes, browse to the following location:
TC_ROOT\logs\admin_data_import_history\Import_date-and-time\index.html

The following image shows the summary page of an example partial administration data import dry
run report. In a real report, you can click links to navigate through the report to find summaries and
details of administration data.

7-4 Managing Administration Data PLM00504 12.0


Reporting administration data

Administration Data Import (history) report


You can use the interactive Administration Data Import (history) report for a site to:
• Track impacts of importing administration data.

• Determine when a particular change was introduced to a site.

Generate an Administration Data Import (history) report

An Administration Data Import (history) report is automatically generated after each successful import
of administration data. Imports can be performed using the admin_data_import command line utility
or Teamcenter Environment Manager (TEM).

View an Administration Data Import (history) report

To view an Administration Data Import (history) report, browse to:


TC_ROOT\logs\admin_data_import_history\index.html

The following image shows the summary page for an import report selected from the three available
historic reports. For this import, the only imported administration data category was Organization.
Impacts are highlighted in blue. In a real report, you can click links to navigate through the report to
find summaries and details of administration data.

PLM00504 12.0 Managing Administration Data 7-5


Appendix A: Managing Administration Data Video Gallery

Managing administration data across environments


Teamcenter has new tools to help manage your environment's administration data. These tools make
it very easy to perform tasks with administrative data.

Copy and compare administration data across environments


Teamcenter administrators have some new tools to help manage your environment's administration
data. The categories of data that are critical to your Teamcenter environment are supported.

PLM00504 12.0 Managing Administration Data A-1


Appendix
Appendix A: A: Managing
Managing Administration
Administration Data Data
VideoVideo Gallery
Gallery

Manage administration data tools

Generate an administration data report

A-2 Managing Administration Data PLM00504 12.0


Managing Administration Data Video Gallery

Generate dry run and import reports

PLM00504 12.0 Managing Administration Data A-3


Appendix
Appendix A: A: Managing
Managing Administration
Administration Data Data
VideoVideo Gallery
Gallery

Generate a comparison report

A-4 Managing Administration Data PLM00504 12.0


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

© 2018 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.

You might also like