Data model live updates

Purpose
The purpose of this lesson is to describe Teamcenter data model live updates.

Objectives
After you complete this lesson, you should be able to:

 Understand the live update process.

 Enable a template for live updates.
 Create a live update project.
 Deploy a live update project.

Help topics
Additional information for this lesson can be found in:

 Working with live updates

1
Introduction to live updates
Live updates is the revision on a live running system of nonschema data such as lists of values (LOVs)
that requires frequent update. The live updates functionality in the Business Modeler IDE allows an
administrator to revise data in the production database without shutting down the production server. It
also provides tighter control on which elements get updated live in a production database.
This table lists elements that can be used in live updates. To select the elements to allow for live updates,
use the Live Update preference.
Data elements that can be updated live (short list)

Display name
(Internal name) Description

Condition Defines conditional statements that resolve to true or false based on the
(Condition) evaluation of an expression.

Defines whether relational type objects can be copied as an object, copied

Deep Copy Rule
as a reference, or not copied when the user performs a save as or revise
(TcDeepCopyRule)
operation.

Display Rule Determines the members of the organization who can view a business
(TcTypeDisplayRule) object in the create menus in the Teamcenter user interface.

GRM Rule Limits which objects can be pasted to other objects. Generic Relationship
(TcGRMRule) Management rules (GRMs) are defined using relationships.

Defines localized display names for business objects, properties, legacy

Localization
change, view, status, LOV values and descriptions, ID context, occurrence
(Localization)
type, and note.

Defines pick lists of values accessed by end users from a menu at the end
LOV
of a data field. Lists of values (LOVs) ensure consistent data entries in the
(TcLOV)
rich client.

Naming Rule Defines the naming conventions for the string property value in different
(TcNamingRule) type objects.

Naming Rule Attaches the naming rule or revision rule to a property on a business object
Attachments so the rule can take effect.
(TcNamingRuleAttach)

Note Type Defines a note object associated with a product structure occurrence in a
(TcNoteType) Structure Manager bill of materials (BOM).

Provides default values to business object properties. Because these

Property Constant
constants are attached to properties, they are inherited and can be
(TcPropertyConstant)
overridden in the hierarchy.

Revision Naming Rule Defines the naming convention and sequence for a revision property.
(TcRevNamingRule)

Status Applies status to an object after it goes through a workflow. Typical statuses
(TcStatus) are Pending and Approved.

2
 Display name
(Internal name) Description

Represents a software application, such as Microsoft Word or Adobe

Tool
Acrobat. Associate a tool with a type of dataset so you can launch the
(TcTool)
dataset file from Teamcenter.

Defines a measurement category (for example, inches, millimeters, and so

Unit of Measure
on). Create a unit of measure (UOM) when you need a new measurement
(TcUnitOfMeasure)
for users.

Data elements that can be updated live

This table lists elements that can be used in live updates. To select the elements to allow for live updates,
use the Live Update preference.
Data elements that can be updated live (others list)

Display name
(Internal name) Description

Alias ID Rule Stores part numbers and other attribute information for similar parts.
(TcAliasIdRule)

Stores information about part numbers and attributes of the same

part from different perspectives. They allow different user
Alternate ID Rule
communities to identify and display an item or item revision
(TcAlternateIdRule)
according to their own rules rather than by the rules of the user who
created the object.

Allows for the configuration of applications using a decision table.

Application Extension Point
This extension point defines the table, inputs, and outputs that
(TcAppExtensionPoint)
customers can configure against it.

Application Extension Rule Determines when an application extension point is used, and
(TcAppExtensionRulev defines inputs and outputs.

Business Context Defines the user groups for whom a rule applies.
(TcBusinessContext)

Provides default values to business objects. Because these

Business Object Constant
constants are attached to business objects, they are inherited and
(TcTypeConstant)
can be overridden in the hierarchy.

Provides default values to business objects. Because these

Business Object Constant
constants are attached to business objects, they are inherited and
Value Override
can be overridden in the hierarchy. An override changes the value
(TcTypeConstantAttach
that you set in your template.

Change Represents an alteration to requirements.

(TcChange)

Dispatcher Service Config Defines the visualization file format that a dataset file is translated
(DispatcherServiceConfig) into.

3
Display name
(Internal name) Description

Configures information that is derived from an ECAD design such

EDA Derived Data as derived items and datasets. For example, a schematic drawing
(EDADerivedDataConfig) can be automatically generated from the schematic design and
saved along with the schematic item.

Provides consistent definitions that can be used throughout the

Global Constant
system. These constants have only one value, either the default
((TcGlobalConstant)
value or the value you set.

Provides consistent definitions that can be used throughout the

Global Constant Value
system. These constants have only one value, either the default
Override
value or the value you set. An override changes the value that you
((TcGlobalConstantAttach)
set in your template.

ID Context Defines when you use unique item IDs. ID contexts are used when
(TcIdContext) you create alias IDs or alternate IDs.

Defines how item revisions are handled. IRDCs standardize item

IRDC
revision behavior at specific times in the life cycle, such as during
(IRDC)
item creation, checkin, checkout, save as, and revise.

Determines how items occur in a product structure. An occurrence

Occurrence Type consists of one component in an assembly including its relative
(TcPSOccurrenceType) position with respect to its parent assembly. Occurrence types are
representations of the PSOccurrence business object.

Defines batch print settings. When you batch print an object such as
Print Configuration
an item revision, all the documents associated with that object are
(PrintConfiguration)
printed.

Provides default values to business object properties. Because

Property Constant Value
these constants are attached to properties, they are inherited and
Override
can be overridden in the hierarchy. An override changes the value
(TcPropertyConstantAttach)
that you set in your template.

Storage Media Defines a storage device category such as a hard disk or optical
(TcStorageMedia) device. It is used by third-party content-storage systems.

System Stamp Configuration Defines the system stamp (such as date or watermarks) on
(SystemStampConfiguration) documents in batch printing.

Specifies objects that can be used to create categories of model

Teamcenter Component
data. For example, Teamcenter Component objects are used to
(Teamcenter Component)
create categories for verification rules.

Verification Rule Configures conditions to be used with specific applications.

(VerificationRule)

Controls the name of a product structure view object. A view type is

View Type a BOM view revision (BVR) category. The product structure view
(TcViewType) types work with the item and item revision business objects to
maintain product structure information.

4
Working with live updates
Use one of the following processes to update live data:

 Single administrator
Use this process if you are a single administrator who makes live updates and distributes them to
servers. In this process, make your updates on a preproduction server before sending the updates
to production servers. This process is recommended in most situations.
 Multiple administrators
Use this process if you have multiple administrators who make live updates and distribute them to
servers. In this process, there is no preproduction server.
Caution:
Siemens PLM Software recommends using a single administrator if possible to better control
the live updates distributed to servers.

Live updates: single versus multiple administrators

Typically, Business Modeler IDE developers create a template that contains the data model extensions.
The server administrator then uses Teamcenter Environment Manager (TEM) to update the production
database with the custom template.
Previously, if further updates needed to be made to the custom template in the database (for example,
new LOV values need to be added):
1. The developer updated the custom template in the Business Modeler IDE with the new LOV values.
2. The server administrator shut down the production server and used TEM to install the template to
update the production database.
However, the recommendation to shut down the production server each time prior to updating the custom
template in the database was too restrictive for administrators who wanted to update live data (for
example, LOV values) on a regular basis. Therefore, the live updates functionality was devised to allow
administrators to update nonschema data on running production servers.
Now:

 A Business Modeler IDE developer works on a template project, tests the changes on the test site,
and during the next system downtime, packages the changes and sends them to the server
administrator.
 In addition to the developer, there is a live data Business Modeler IDE administrator. This
administrator works on the live update project. During system downtime, this administrator collects
the changes (packages) from the developers and performs a TEM deployment of these changes to
the preproduction and production servers. When the server is running, this administrator works on
the live update project to add any necessary live updates.

Single Business Modeler IDE administrator of live updates

In the single administrator environment, there is only one live updates administrator who is responsible for
distributing updates to all sites, both preproduction and production.
In the multiple administrator environment, there may be more than one live updates administrator per site,
and they share the responsibility of keeping their respective sites updated.

5
 Use this process if you are a single administrator who makes live updates and distributes them to
servers. In this process, make your updates on a preproduction server before sending the updates to
production servers. This process is recommended in most situations.
o Control all updates with one administrator.
o Perform live updates in one environment.
o Prevalidate updates.
o Package the template and deploy to each site through Teamcenter Environment Manager
(TEM).
Single administrator environment

6
Multiple Business Modeler IDE administrators of live updates
In the multiple administrator environment, there may be more than one live updates administrator per site,
and they share the responsibility of keeping their respective sites updated.

 Use this process if you have multiple administrators who make live updates and distribute them to
servers. In this process, there is no preproduction server.
o Perform live updates with multiple administrators.
o Clients at each site update live data.
Multiple administrators environment

Business Modeler IDE process review

Business Modeler IDE process flow

7
  Developing extensions and testing
First, create a new template project so that you can store your extensions in it for easy deployment
to database sites. Then, perform a live deploy to push your template to a test Teamcenter server
where you can validate it in a safe environment.
 Deploying a template to a production site
After you validate your template in the test environment, you can update your production
environment.
 Editing extensions in a live production site
After you deploy your extensions to a production server, you may want to create and perform a live
update because you are updating the data on a live system.
 Edit live data
Once the production site is running, you can edit the live data at any time.
 Incorporate live data updates from the production site
Incorporate all the live data updates performed at the production site back into the development
environment.
Note:
More details of this step are in the next topic.

Incorporate live data updates from the production site

Eventually, you must incorporate all the live data updates performed at the production site back into the
development environment. This event occurs as you prepare for your next system downtime.
If you do not perform this step, and you deploy your development environment template (which does not
include the latest live data updates) to the production site, the live data updates already present in the
production site are removed. Because this is undesirable, the system blocks the deployment. To ensure
that the deployment is not blocked, you must perform this step.
To incorporate the latest live data, you can run a wizard from the development environment Business
Modeler IDE to log on to the production Teamcenter server and retrieve the latest extensions. Or, if your
production site is offline from your Business Modeler IDE, you can ask an administrator to run a command
line to extract the latest updates from the site and send them to you for incorporation. In either case, once
the extensions are incorporated, you can continue with testing, packaging, and deploying to your
production site.

8
 Incorporating live data updates from the production site
1. Before you extract the latest live updates, it is a good practice to first block anyone from making any
more live updates to ensure you get the latest. You can do this by clearing the Allow Live
Updates check box in the Live Update preference dialog box in the rich client at the production
site.
2. From your development environment Business Modeler IDE, launch the Incorporate Latest Live
Update Changes wizard. Log on to the production site to pull the latest updates to your Business
Modeler IDE. The Business Modeler IDE presents the changes to you in a graphical merge tool.
Use this tool to determine which elements you want to keep or discard. Click Finish to save the
changes to your local Business Modeler IDE template.
3. At this point, you have integrated the latest live updates with your ongoing development work.
Deploy this template to your test environment and validate that it works as expected.
4. To update your production site, deploy the template to a production site.
5. Before allowing users to edit live data again, reset the Allow Live Updates check box on the Live
Update preference.

Live update process: single administrator

Follow this process when you are a single administrator who performs live updates to a production server.
1. In the developer environment, ensure that a template is enabled for live updates and deploy it to the
server. A custom template is enabled for live updates when the Enable Live Updates? check box
is selected on the template project.

9
 2. In Teamcenter, configure the Live Update preference to select the data model elements to update
on the server.
3. Create a live update project by choosing File→New→Project→Business Modeler IDE→New Live
Update Project.
4. Make changes to data in the template and perform live updates on the preproduction and
production servers by clicking BMIDE on the menu bar and choosing Deploy
Template or Deployment Page.
5. If other sites also require the data updates you have created, such as vendors or partners, you can
package the template and send it to each site so the updates can be installed using Teamcenter
Environment Manager (TEM).
6. After live updates have been installed on a production server, make live updates visible to end
users.
7. In the developer environment, incorporate the latest live updates from the production site by running
the Incorporate Latest Live Update Changes wizard.

Enable a template for live updates and deploy it

You must create a Business Modeler IDE template project and install it to the server before you create a
live updates project. The Business Modeler IDE template project holds the schema data such as business
objects and classes that can only be installed to a production server in a template using Teamcenter
Environment Manager (TEM); the live updates project contains the nonschema elements such as LOVs
and rules that can be installed to a production server using live update.
1. Create the Business Modeler IDE template project.
2. Enable the Business Modeler IDE template project for live updates with the Enable Live
Updates? check box.

Note:
This check box is selected by default when you create a new template project.
3. Install the Business Modeler IDE template project to the server.

10
 o Test server
If you are installing to a test server only, choose BMIDE→Deploy Template on the menu bar.
o Production server
Package the template and install it using Teamcenter Environment Manager (TEM).

Configure the Live Update preference

Use the Live Update preference to select the data model elements to enable for live update.

 To select the data elements to allow for live update use the My Teamcenter application in the rich
client Edit→Options and select Live Update in the left pane. Move the data elements from
the Available list on the left to the Selected for Live Updates list on the right and click Apply.
 If you have a four-tier environment, recycle servers in all server manager pools to ensure each
warm server receives the latest preference settings. For example, in the .NET server manager
administrative interface, click the Restart Warm Servers button.
Live update preference
When you perform a live update, only the selected data model elements are updated on the server.

Note:
When you select the Allow Live Updates? check box, it sets
the BMIDE_ALLOW_LIVE_UPDATES preference to true.

11
Create a live update project
A live update project is a project that manages live data in an already-installed custom template on the
server. A live update data project holds only data to be deployed to a running production server. Create
one live update project for each custom template enabled to receive live updates on the server.
1. Ensure that a template is installed on the server that is enabled to receive live data updates.
2. Choose File→New→Project, and in the New Project dialog box, choose Business Modeler
IDE→New Live Update Project.

3. Fill in the appropriate Teamcenter Login information and connect to the server and complete the
live update project creation process.
a. If there is only one template on the server that is enabled for live updates, the Next button is
unavailable. Click Finish.
b. If there are multiple templates on the server enabled for live updates, click Next.
Click the arrow in the Template Name box to select the template to use for live updates.
Click Finish.
4. The project is created and named template-name_live_update.

Perform live updates

After you create a live update project, you can revise data, such as lists of values (LOVs), and use
the Deploy Template feature to distribute the updates to a preproduction server. A preproduction server
is a Teamcenter server that has an exact copy of the templates that the production sites have. Use this
server to test a live update before deploying the live update to the production servers.
After testing, you can use the Deployment Page to deploy live updates to production servers. Only use
this if you are working in a single administrator environment.

Live updates steps

1. Create data in the live update project.

12
2. Revise data, such as lists of values (LOVs).
3. Deploy to a preproduction server for testing.
o Right-click the live update project in the Business Objects view and choose Deploy
Template, or choose BMIDE→Deploy Template on the menu bar.
o Type the password, click the Connect button, and when a connection is established,
click Finish.

4. Note:
5.The system checks if the live update project is synchronized with the server. If there is data on
the server that is not in the live update project, the Synchronize wizard runs, allowing you to
resolve the conflicts.

13
 6. Deploy to production servers.
o After you finish testing and are ready to deploy to the production servers,
choose BMIDE→Deployment Page or right-click the live update project in the Business
Objects view or the Extensions view and choose Open Deployment Page.

o Click the Deploy button to deploy the template to production servers.

Package a live update project for installation to other sites

If other sites also require the live updates you have created, such as vendors or partners, you can
package the template and send it to the administrators of each site. Administrators install the template to
their sites using the Update the Database (Perform Live Updates - System downtime not
required) option in Teamcenter Environment Manager (TEM).
1. Package the template.
o Select the live update project in the Business objects view or the Extensions view and
choose BMIDE→Package Template Extensions.
o Click the arrow in the Project box to select the live update project to package and click Finish.

14
The packaged files are saved in the packaging/live_update directory under the project.
Packaged files are placed in timestamped folders to keep track of packages. The most recent
package is in the top folder.

15
2. Copy the template-name_template_live_update.zip file from the packaging directory on your
Business Modeler IDE client to a directory that is accessible by the administrators at other sites.
3. Administrators at other sites perform the live update by installing the live updates using TEM. In this
scenario, TEM has already been used to install the template that the live updates are intended for.
o In the Feature Maintenance panel, under the Teamcenter Foundation section, select Update
the Database (Perform Live Updates Only - System downtime not required). This updates
the database with live updates that contain only nonschema data such as LOVs and rules.

Note:
The system checks if the live update project is synchronized with the server. If there is data
on the server that is not in the live update project, the update fails. You must synchronize
the data model from the Business Modeler IDE, repackage, and attempt the update once
more.
If installation of the live updates fails, check the message in the TEM panel. Installation
may have failed because the server you are attempting to install to does not have the Live
Update preference set to accept live changes. In this case, you must ask the administrator
of that production server to change the preference to accept the live updates.

16
Incorporate latest live updates
At the next system downtime, you must incorporate all of the latest updates from the production
environment into your standard template project. Run the Incorporate Latest Live Update Changes wizard
to either update directly from the production server or update from a template file obtained from the
production server using the package_live_updates utility.
1. Choose BMIDE→Incorporate Latest Live Update Changes. Click Next.

2. Using the Incorporate Latest Live Update Changes dialog box:

17
 o In the Project box, select the standard project into which you want to incorporate the live
updates.
o Under Database Site, select the mode to provide the data model:
 Teamcenter Server - Select if you want to incorporate all the custom live updates data
model on a server into your project. This option accesses the server directly to obtain the
templates from the server.
 Live Update Zip - Select if you want to incorporate all the custom live updates data model
from a template file into your project. Use this option if you cannot access the server
directly.
o Depending on your selection, perform one of the following in the Source Model dialog box:
 If you selected Teamcenter Server, in the dialog box, type your user name and password
and click Connect to log on to the server.
 If you selected Live Update Zip, click the Browse button to the right of the Template
Zip box to locate the packaged template's ZIP file.
The system checks if the live update project is synchronized with the server. If there is data on
the server that is not in the live update project, the Merge Data Model wizard runs, allowing you
to resolve the conflicts.
Caution:
Be patient. The incorporation may take some time.
3. In the Merge Data Model dialog box, resolve any conflicts that the merge compare identified
between the data model in your target project and in the source.
Note:
Because there are many different scenarios you may encounter when performing a merge,
samples are provided in the Merge Samples wizard. For tutorials, choose BMIDE→Merge
Samples.

18
4. Once you incorporate live update changes, you perform a full model update with Teamcenter
Environment Manager (TEM).
o Package your template by choosing BMIDE→Package Template Extensions.
o In the Feature Maintenance panel, under the Teamcenter Foundation section, select Update
the Database (Full Model - System downtime required). This updates the database with the
full data model in the standard (non live update) template.

19
 o Select your template in the table and click Next.

Live updates reference tasks

Reference tasks about live updates.

 Synchronize data model

The system checks if the live update project is synchronized with the server. You must synchronize
the data model with the server from the Business Modeler IDE.
 Data model compare preferences
Set your preferences for data model synchronize and merge between these choices:
o Automatic merge
o Always show Merge Tool during synchronization
o Show Merge Tool only for conflicts that need my resolution

20
  Make live updates visible to end users
 Package live updates in the database
Run the package_live_updates utility to package data model.
 Study the merge samples
Browse through the list of available samples to learn how to use the merge tool. Note that these are
only samples. Clicking the Finish button has no effect on your data model. To access merge
samples, choose BMIDE→Merge Samples.

Synchronize data model

Synchronize the data model to ensure your live update project and dependent templates have the most
up-to-date data model.

 Select the project to be synchronized and choose BMIDE→Synchronize with Server, or click

the Synchronize button on the toolbar.

The Teamcenter Login dialog box is displayed.
 In the Project box, select the live update project you want to synchronize.
 If there are changes to the custom template, the Merge wizard is shown based on the live update
synchronization preference settings to help resolve merge conflicts:
o If the preference is set to Always show Merge Tool during synchronization (the default),
the Merge wizard is shown to help reconcile the conflicts.
o If the preference is set to Show Merge Tool only for conflicts that need my resolution and
there are no change conflicts, all elements of the data model are automerged, and the Merge
wizard is not shown. If there are change conflicts, all other elements except for the change
conflict elements are automerged, and the Merge wizard is shown.

Data model compare preferences

Perform the following steps to set preferences for the Incorporate Latest Live Update Changes wizard:
1. Choose Window→Preferences.
2. In the Preferences dialog box, choose Teamcenter→Data Model Merge / Compare Tool.

21
 Automatic Merge - used to control the automatic merging of the data model when the Incorporate
Latest Live Update Changes wizard is launched. If the check box is selected, all differences except
for the change conflict differences are automatically merged when the wizard runs. If the check box
is cleared, no merges are done when the wizard is launched.
 Live Update Synchronization
o Always show Merge Tool during synchronization - displays the Merge wizard during
synchronization even if the tool can automatically reconcile all data model differences without
user intervention. This option allows you to inspect the incoming changes made by other users
to the live update data in the database. In this mode, you must merge each element. This is
the default selection.
o Show Merge Tool only for conflicts that need my resolution - automatically reconciles all
data model differences without user intervention. If any change conflict differences are found,
the Incorporate Latest Live Update Changes wizard is launched so you can address the
conflicts.

22
Make live updates visible to end users
After live updates have been installed on a production server, the updates are visible to end users who
log on after the update. However, users logged on when the update is made must log off and log on again
to ensure that the servers cycle through the changes.
When each user logs on, a server is started and assigned to the client. During startup, the types,
properties, and LOVs in the database are built into a cache for performance reasons. Each server has its
own cache. When a user updates an LOV to the database, each client still sees the original LOVs and
rules because server caches are not updated. Administrators ask users to log off and log on again to see
the changes so that a new cache is built.
In four-tier environments, administrators can use the server manager to restart servers at off-peak hours
to ensure all live update changes are reflected in servers. On J2EE consoles, a system administrator can
facilitate warm server refresh. (This is not available on .NET.)

Package live updates in the database

Run the package_live_updates utility to package data model for a template that resides on the server.
The template package file that is created includes all the live updates in the template. This is similar to
packaging a template within the Business Modeler IDE, but this utility is run on the Teamcenter server.
This utility can only be run on a template that is enabled for live updates deployment.
For example:
package_live_updates -u=user-id -p=password -g=group
-template=template-name -dir=directory

After running this utility, you can merge the live updates that the template contains into a template on your
system by running the merge wizard.

23
Study the merge samples
To become familiar with merge scenarios, study the merge samples. Choose BMIDE→Merge Samples.

Merge tool features

Key features of the merge tool are:

 Stepping - click the forward and backward arrows to step through each change.
 Filtering - tTo see only the rows where there are differences, click the Display Equal Rows button
so that it is unselected. This is a toggle button. When it is unselected, only rows with different
values are shown. When it is selected, all rows are shown, including all those with equal values.
 Automerge - click the Auto Merge button to let the tool merge all changes for you. Merged
(changed) elements display a light-blue background for easy identification.

24
Before automerge

25
After automerge

Summary
The following topics were taught in this lesson:

 Understand the difference between single administrator and multiple administrators live update
process.
 Enable a template for live updates.
 Create a live update project.

26
27