business modeler ide guide

Teamcenter 10.1

Business Modeler IDE Guide

Publication NumberPLM00071 J

Proprietary and restricted rights notice

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

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

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

2 Business Modeler IDE Guide PLM00071 J

Contents

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

Getting started with the Business Modeler IDE . . . . . . . . . . . . . . . . . . . 1-1

Introduction to the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1Before you begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Business Modeler IDE interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Basic concepts for using the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . 1-15Basic tasks when using the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . 1-18Using the Business Modeler IDE for the first time . . . . . . . . . . . . . . . . . . . . . 1-19

Learning about the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . 2-1

Workshops . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1Business Modeler IDE process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70Data model concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-76Development environments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-83SCM system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-86Getting help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-89

Installing and configuring the Business Modeler IDE . . . . . . . . . . . . . . 3-1

Install the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1Configure the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10Start the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-23Upgrade the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-24Uninstall the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30

Creating, deploying, and packaging templates . . . . . . . . . . . . . . . . . . . . 4-1

Template process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1Create a Business Modeler IDE template project . . . . . . . . . . . . . . . . . . . . . . 4-1Deploying templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10Package extensions into a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17Install a template using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21Update the database using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24Live updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26Tips for working with template projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-58Templates reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-70

Creating data model objects to represent objects in Teamcenter . . . . . 5-1

Add a new model element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1Business Modeler IDE administration tasks . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-4Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-99Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-111Lists of values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-150

PLM00071 J Business Modeler IDE Guide 3

Contents

Creating options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-212Document management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-226Working with applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-249Teamcenter Component objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-250Global constants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-253Managing data model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-276

Creating business rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Introduction to business rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1Naming rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2Business object display rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-23GRM rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-27Deep copy rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35Alternate ID rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-49Alias ID rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-54Multifield keys . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-55Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-74Application extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-90

Setting the displayed text and language in the Business Modeler IDE . . 7-1

Localization process in the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . 7-1Setting language support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Setting display names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-8Add the Localization button to properties . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-13Migrate a custom template to the newer language framework . . . . . . . . . . . . . 7-14Migrate property and relation names . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-15Create a default localization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Import localization files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Localization and live update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18

Using the Business Modeler IDE for codeful customization . . . . . . . . . . 8-1

Customization methods in the Business Modeler IDE . . . . . . . . . . . . . . . . . . 8-1Set up a project for coding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Data-model-based customizations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-33Extensions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-55

Using the Business Modeler IDE to configure Teamcenterapplications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

4th Generation Design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1Access Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4ADA License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4Aerospace and Defense . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-10As-Built Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12Audit Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-12Automotive Edition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21CAE Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22Change Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-22Classification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-63Dimensional Planning and Validation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-63Manufacturing Process Planner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-70Multi-Structure Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-71


Contents

NX CAM Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-87Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-87Product and manufacturing information (PMI) . . . . . . . . . . . . . . . . . . . . . . . 9-87Schedule Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-88Structure Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-95Supplier Relationship Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-110Systems Engineering . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-115Teamcenter EDA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-119Validation Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-127Wiring Harness Design Tools Integration . . . . . . . . . . . . . . . . . . . . . . . . . . 9-130Workflow Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-130

Using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Introduction to the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Enabling the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1Start the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Mapping Designer user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3Filtering rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-5Basic tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-6Advanced tasks using the Mapping Designer . . . . . . . . . . . . . . . . . . . . . . . . 10-15Mapping Designer perspectives and views . . . . . . . . . . . . . . . . . . . . . . . . . 10-28

Troubleshooting the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . 11-1

Reviewing the log files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1Deployment errors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1Business Modeler IDE has slow performance, an out-of-memory error, or does not

launch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-5Could not create the Java virtual machine error . . . . . . . . . . . . . . . . . . . . . . 11-6Workspace is locked error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7Type name collision error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-7Backup and recovery of Business Modeler IDE data . . . . . . . . . . . . . . . . . . . . 11-8BASE10001: ENCODING_VALIDATION_ERROR . . . . . . . . . . . . . . . . . . . . 11-8FND10001:

MULTIPLE_INTERDEPENDENT_LOV_ATTACHMENT_ERROR . . . . . . 11-10FND10002: INVALID_CONDITION_FOR_DEEP_COPY_RULE_ERROR . . . 11-11FND10003: THE_ELEMENT_HAS_BEEN_REMOVED_FROM_ITS

_DEPENDENT_TEMPLATE . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-11FND10004:

CANNOT_SET_LOCALIZABLE_CONSTANT_ATTACHMENT_ERROR . . 11-12

Business Modeler IDE reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

Business Modeler IDE best practices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1Business Modeler IDE utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-3Business Modeler IDE perspectives, views, and editors . . . . . . . . . . . . . . . . . A-7

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

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


Contents

Figures

Favorites folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Add to Favorites from context menu . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Add to Favorites from editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13Filter elements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14Customize hidden groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-14Configure business objects to display . . . . . . . . . . . . . . . . . . . . . . . . . 1-15Configure business objects to display dialog box . . . . . . . . . . . . . . . . . . 1-15Custom versus COTS template example . . . . . . . . . . . . . . . . . . . . . . . 1-18Model Element Type wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20Create a new business object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-21Creating a custom item business object . . . . . . . . . . . . . . . . . . . . . . . . 1-22Creating a custom item revision business object . . . . . . . . . . . . . . . . . . 1-23Finding custom business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-24Saving data model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25Select the New Business Modeler IDE Template Project wizard . . . . . . 2-2Create the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Item business object in the Business Modeler IDE user interface . . . . . . 2-3BMIDE view showing project files . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Project properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Server connection profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Online help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Model Element Type wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6Create a new business object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7Establish a connection to the server . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8Console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Business Object Type dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Custom business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10Properties tab of the custom business object . . . . . . . . . . . . . . . . . . . . 2-11Persistent Property dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Set the Enabled property constant . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13Operation Descriptor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13OperationInput Property dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14Custom properties on the item creation dialog box . . . . . . . . . . . . . . . . 2-16Custom properties on the item revision creation dialog box . . . . . . . . . . 2-16Starting the search for style sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17Searching for XMLRenderingStylesheet datasets . . . . . . . . . . . . . . . . . 2-18Viewing the search results for XMLRenderingStylesheet datasets . . . . . 2-18Viewing the style sheet contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19Saving XML style sheets with new names . . . . . . . . . . . . . . . . . . . . . . 2-20Registering style sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21Adding properties to style sheets . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22Custom item properties in the Summary view . . . . . . . . . . . . . . . . . . . 2-23Custom item properties in the Viewer view . . . . . . . . . . . . . . . . . . . . . 2-23Custom item revision properties in the Summary view . . . . . . . . . . . . . 2-24Custom item revision properties in the Viewer view . . . . . . . . . . . . . . . 2-25Adding an LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26Attaching an LOV to a property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27Cascading list of values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28Attaching the suppliers LOV to the supplier property . . . . . . . . . . . . . . 2-29Cascading list of values in the user interface . . . . . . . . . . . . . . . . . . . . 2-30List of values in the user interface . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31


Contents

Naming rule pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32Attaching the naming rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33After the naming rule is attached . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33Naming rule applied in the New Item wizard . . . . . . . . . . . . . . . . . . . 2-35Creating a new form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36Setting the Enabled property constant for properties on the form . . . . . 2-37Selecting the new form from the list . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38Creating an instance of the form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39New form under the workshop part revision . . . . . . . . . . . . . . . . . . . . 2-39Additional form under the workshop part revision . . . . . . . . . . . . . . . . 2-40Creating a GRM rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41GRM Rules tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42Error message caused by GRM rule restriction . . . . . . . . . . . . . . . . . . 2-43Operation error message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43Cardinality error message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43Create a CopyAsObject deep copy rule . . . . . . . . . . . . . . . . . . . . . . . . 2-44Create a CopyAsReference deep copy rule . . . . . . . . . . . . . . . . . . . . . . 2-45Create a NoCopy deep copy rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46Deep Copy Rules tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46Object with related documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48Revised object showing results of deep copy rules . . . . . . . . . . . . . . . . . 2-48Referenced dataset . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-49Adding infodba to the Designer role . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50Changing session user settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-50Validating that Designer role members can view the Workshop Part . . . 2-51Browsing for the organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-51Selecting the organization to which to apply the display rule . . . . . . . . . 2-52Viewing the business object display rule . . . . . . . . . . . . . . . . . . . . . . . 2-52Logging on to the Designer role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-53Validating that Workshop Part items are hidden from Designer rolemembers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-54

Confirming availability of the extension . . . . . . . . . . . . . . . . . . . . . . . 2-55Finding the postaction on an operation . . . . . . . . . . . . . . . . . . . . . . . . 2-56Adding the extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-56Adding extension arguments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57Finishing adding the extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-57Extension added as a postaction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-58Verifying extension rule behavior . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-59Viewing the source property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-60Viewing the target business object . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-60Selecting the compound property type . . . . . . . . . . . . . . . . . . . . . . . . . 2-61Creating a compound property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62Adding the first segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-62Selecting the source business object . . . . . . . . . . . . . . . . . . . . . . . . . . 2-63Viewing the first segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-64Selecting the originating property . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-65Viewing the final segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-66Viewing the completed compound property . . . . . . . . . . . . . . . . . . . . . 2-66Viewing properties on the workshop part revision . . . . . . . . . . . . . . . . 2-68Showing empty properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-68Viewing the compound property in the Properties dialog box . . . . . . . . . 2-69Adding the new compound property to the Summary style sheet . . . . . . 2-69Viewing the compound property on the Summary view . . . . . . . . . . . . . 2-70Business Modeler IDE process flow . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-70


Contents

Developing extensions and testing . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-71Deploying a template to a production site . . . . . . . . . . . . . . . . . . . . . . 2-72Editing live data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74Incorporating live data updates from the production site . . . . . . . . . . . 2-75Classes and attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-77Classes view (the POM schema) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-79Abbreviated view of POM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-80Inheritance to root for the WorkspaceObject class . . . . . . . . . . . . . . . . 2-81Install plug-ins . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8Organize Extensions button . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10Extension files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-11Business Modeler IDE preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13Server Connection Profiles preference . . . . . . . . . . . . . . . . . . . . . . . . . 3-15Sample server connection profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17Toolbar customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18Project Backup dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19Backing up project data at project close or shutdown . . . . . . . . . . . . . . 3-20Backing up project data at deployment . . . . . . . . . . . . . . . . . . . . . . . . 3-20Restoring a project from the database . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Locally backed-up project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-21Selecting the BMIDEProjectBackupRecovery saved query . . . . . . . . . . 3-22Business Modeler IDE resource dataset . . . . . . . . . . . . . . . . . . . . . . . 3-22Selecting the New Business Modeler IDE Template Project wizard . . . . 4-2Typing the project name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3Setting the template characteristics . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4Setting code generation for the project . . . . . . . . . . . . . . . . . . . . . . . . 4-6Setting build configuration information for the project . . . . . . . . . . . . . 4-7Setting services bindings for the project . . . . . . . . . . . . . . . . . . . . . . . 4-9Launching the deployment wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13Deploying template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14Deployment progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Deployment results . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15Console view after deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-16Launching the packaging wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-18Packaging a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-19Packaged files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-20Browsing for the template files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22Selecting the new feature . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23Viewing the templates to be installed . . . . . . . . . . . . . . . . . . . . . . . . . 4-23Starting a full model update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25Selecting the template for update . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26Single administrator environment . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28Multiple administrators environment . . . . . . . . . . . . . . . . . . . . . . . . . 4-29Enable a template for live updates . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31Live Update preference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-32Launch the live update project wizard . . . . . . . . . . . . . . . . . . . . . . . . . 4-34Deploying a template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36Deployment Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-36Package Template Extensions wizard . . . . . . . . . . . . . . . . . . . . . . . . . 4-37Packaged files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-38Updating live data using TEM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-39Launch the Incorporate Latest Live Update Changes wizard . . . . . . . . . 4-40Incorporate Latest Live Update Changes dialog box . . . . . . . . . . . . . . . 4-41Merge Data Model dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-42


Contents

Performing a full model update using TEM . . . . . . . . . . . . . . . . . . . . . 4-43Selecting the template for full model update . . . . . . . . . . . . . . . . . . . . 4-44Data Model Merge / Compare Tool preferences . . . . . . . . . . . . . . . . . . . 4-52Merge Samples dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-55Before automerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-56After automerge . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-57Viewing project properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-60Viewing project build information . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62Viewing project build service bindings . . . . . . . . . . . . . . . . . . . . . . . . . 4-63Viewing project code generation settings . . . . . . . . . . . . . . . . . . . . . . . 4-65Viewing incorporated database site information . . . . . . . . . . . . . . . . . . 4-66Viewing project backup settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-67Sample template project structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-72Initial template installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76Subsequent template installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-77Live update a template to a test server . . . . . . . . . . . . . . . . . . . . . . . . 4-78Install a packaged template to a production server . . . . . . . . . . . . . . . . 4-78Automotive Edition files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-81Launching the Add New Model Element wizard . . . . . . . . . . . . . . . . . . 5-1Add New Model Element wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Adding a new business object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5Creating a custom business object . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-6Creating a custom item business object . . . . . . . . . . . . . . . . . . . . . . . . 5-12Creating a custom item revision business object . . . . . . . . . . . . . . . . . . 5-13Finding custom business objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-14Creating a custom item in the rich client . . . . . . . . . . . . . . . . . . . . . . . 5-15Creating a custom form business object . . . . . . . . . . . . . . . . . . . . . . . . 5-19Creating a custom dataset business object . . . . . . . . . . . . . . . . . . . . . . 5-23Creating dataset references . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-24Creating dataset tool actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-25Creating a new relation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31Icons folder under the project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-42Fnd0Icon business object constant . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-43Property renderer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-46Packaged icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-47Custom business object with icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48Overlays on the icon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-48Adding a property for the CreateInput operation . . . . . . . . . . . . . . . . . 5-53Property configured for the CreateInput operation on the Operation Descriptortab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-55

Adding a property for the SaveAsInput operation . . . . . . . . . . . . . . . . . 5-57Property configured for the SaveAsInput operation on the OperationDescriptor tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-60

Attempting to create a class directly on the Item class . . . . . . . . . . . . 5-100Adding a new class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-101Creating a custom class . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-102Adding a class attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-104Creating a new class attribute . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-107Properties in the rich client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-112Adding a persistent property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-122A new property displayed on the Properties tab . . . . . . . . . . . . . . . . . 5-123Creating a compound property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-129Selecting the originating property . . . . . . . . . . . . . . . . . . . . . . . . . . 5-131Viewing the final segment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-131


Contents

Example of a list of values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-150Create a classic list of values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-156Create a batch list of values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-157LOV Value Management box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-158Sample LOV files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-159Convert to externally managed LOV using the LOV Value Managementbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-160

Converting to an externally managed LOV . . . . . . . . . . . . . . . . . . . . 5-161Viewing the output file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-162Convert to template LOV using the LOV Value Management box . . . . 5-162Converting to a template LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-163Sample dynamic LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-166Dynamic list of values in the end user interface . . . . . . . . . . . . . . . . . 5-166New Dynamic LOV wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-167Building the query clause . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-169Sample dynamic LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-171Results of testing a dynamic list of values . . . . . . . . . . . . . . . . . . . . . 5-172New Dynamic LOV dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-174Select the owning_group property . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-175Select the name property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-176Example 1 dynamic LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-177Example 1 results of the dynamic LOV test . . . . . . . . . . . . . . . . . . . . 5-178Select the IMAN_Rendering type . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-179Select the object_name property . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-180Example 2 dynamic LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-181Example 2 results of the dynamic LOV test . . . . . . . . . . . . . . . . . . . . 5-182Select the IMAN_Rendering type . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-183Select the owning_group property . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-184Select the name property on the Group business object . . . . . . . . . . . . 5-185Example 3 dynamic LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-186Example 3 results of the dynamic LOV test . . . . . . . . . . . . . . . . . . . . 5-186Search for Administrative List of Values type objects . . . . . . . . . . . . . 5-189Results of the search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-189Dynamic LOV using a imported dynamic list of values . . . . . . . . . . . . 5-190Dynamic LOV using the imported dynamic list of values . . . . . . . . . . 5-191Property displaying the imported dynamic list of values . . . . . . . . . . . 5-191TIEImportOptionSetDefault transfer option . . . . . . . . . . . . . . . . . . . 5-192Attaching an LOV to a property . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-194Creating a filter LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-196Creating a cascading LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-198Cascading LOV used to create an interdependent LOV . . . . . . . . . . . . 5-199Attaching an LOV to a property . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-199Creating an interdependent LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-200Interdependent LOV in the rich client user interface . . . . . . . . . . . . . 5-201Attaching LOVs with conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-203LOVs for first project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-209LOVs for second project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-209Viewing the new status type in Workflow Designer . . . . . . . . . . . . . . 5-220Viewing the new status type in the Modify Revision Rule dialog box . . 5-221Creating a naming rule pattern . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3Creating a naming rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Selecting a property to attach the naming rule . . . . . . . . . . . . . . . . . . . 6-9Attaching the naming rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-10Viewing naming rule results in the rich client . . . . . . . . . . . . . . . . . . . 6-11


Contents

Hide Display Rule wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-24Selecting an organization to hide the business object from . . . . . . . . . . 6-24Sample display rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-25Business object is visible (no display rule in effect for the logged-onuser) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26

Business object is hidden (the display rule in effect for the logged-onuser) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-26

Sample GRM rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-28Creating a GRM rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-30GRM Rules editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-31Pasting an object using Paste Special . . . . . . . . . . . . . . . . . . . . . . . . . 6-32Viewing the Related Datasets tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33Paste error message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33GRM rule error message . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-33Deep Copy Rule wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-35Deep Copy Rules editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-39Example of inheritance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-40Multifield key definition example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-56Viewing the MultiFieldKey business object constant . . . . . . . . . . . . . . 6-57New Multi Field Key dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-58Multifield key definition example . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-59Example multifield key domains . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-61Default multifield key definition for the Drawing business object . . . . . . 6-62Drawing business object in the New Multi Field Key dialog box . . . . . . . 6-63Changed Drawing multifield key definition . . . . . . . . . . . . . . . . . . . . . 6-63Creating the item instance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64Typing the item ID number . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-64Different objects with the same item ID . . . . . . . . . . . . . . . . . . . . . . . 6-65Searching in the rich client for an item ID used by multiple objects . . . . 6-65Searching in the thin client for an item ID used by multiple objects . . . . 6-66Searching in Structure Manager for an item ID used by multipleobjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-66

Default DisplayName business object constant for the Item businessobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-70

Default displayed name in the user interface . . . . . . . . . . . . . . . . . . . . 6-70Default displayed name in the Object box . . . . . . . . . . . . . . . . . . . . . . 6-70Modifying the DisplayName business object constant . . . . . . . . . . . . . . 6-71Property added to the DisplayName business object constant . . . . . . . . 6-71Modified DisplayName business object constant for the Item businessobject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-72

Modified displayed name in the user interface . . . . . . . . . . . . . . . . . . . 6-72Modified displayed name in the Object box . . . . . . . . . . . . . . . . . . . . . 6-73New Condition wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-75Client-server interaction in Teamcenter . . . . . . . . . . . . . . . . . . . . . . . 8-2Generated code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-24Framework interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-27New Service Operation wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-42Postaction extension example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-61Adding the extension to the postaction . . . . . . . . . . . . . . . . . . . . . . . . 8-62bmf_extension_workflow_sample.c source file . . . . . . . . . . . . . . . . . . . 8-67bmf_extension_workflow_sample.h include file . . . . . . . . . . . . . . . . . . . 8-69Confirming availability of the extension . . . . . . . . . . . . . . . . . . . . . . . 8-73Selecting an operation on the business object . . . . . . . . . . . . . . . . . . . . 8-74Attaching an extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-74


Contents

Default license categories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5Fnd0ADALicenseCategories list of values . . . . . . . . . . . . . . . . . . . . . . 9-6Adding a new license category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6New license category added to the list of values . . . . . . . . . . . . . . . . . . 9-7License categories LOV attached to the license category property . . . . . 9-8New license category in the Category box . . . . . . . . . . . . . . . . . . . . . . 9-9New Event Type dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-13New Event Type Mapping dialog box . . . . . . . . . . . . . . . . . . . . . . . . . 9-15New Audit Definition dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-16Adding primary audit definition properties . . . . . . . . . . . . . . . . . . . . . 9-17Adding a primary audit definition property . . . . . . . . . . . . . . . . . . . . . 9-18Custom event types found during upgrade . . . . . . . . . . . . . . . . . . . . . . 9-19Custom Change Management condition . . . . . . . . . . . . . . . . . . . . . . . 9-24Adding the creation extension rule . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27Change Management form creation . . . . . . . . . . . . . . . . . . . . . . . . . . 9-27New Related To folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-28New Change Management relation . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-29Change Management relation GRM rule . . . . . . . . . . . . . . . . . . . . . . . 9-30Change Management relation property . . . . . . . . . . . . . . . . . . . . . . . . 9-30Change Management relation business object constant . . . . . . . . . . . . . 9-31Selecting the condition for the business object constant . . . . . . . . . . . . 9-32Adding the relation to the preferences . . . . . . . . . . . . . . . . . . . . . . . . . 9-32New Related To folder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-33Availability of the Dpv0FormAttach extension . . . . . . . . . . . . . . . . . . . 9-64Adding a post-action to the create operation . . . . . . . . . . . . . . . . . . . . 9-65Selecting the Dpv0FormAttach extension . . . . . . . . . . . . . . . . . . . . . . 9-66Adding an argument to the Dpv0FormAttach extension . . . . . . . . . . . . 9-66Selecting a form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-67Completing adding a form to the Dpv0FormAttach extension . . . . . . . . 9-67Forms added to the Dpv0FormAttach extension . . . . . . . . . . . . . . . . . . 9-68Dpv0FormAttach extension added to the create operation . . . . . . . . . . . 9-68Creating an MEInspection operation . . . . . . . . . . . . . . . . . . . . . . . . . . 9-69Automatically created forms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-69Availability of the automateAndLink extension . . . . . . . . . . . . . . . . . . 9-72Adding a post-action to the create operation . . . . . . . . . . . . . . . . . . . . 9-73Selecting the automateAndLink extension . . . . . . . . . . . . . . . . . . . . . . 9-73Adding an argument to the automateAndLink extension . . . . . . . . . . . 9-74Selecting a relation hint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-74Sample argument for the automateAndLink extension . . . . . . . . . . . . . 9-75Argument added to the automateAndLink extension . . . . . . . . . . . . . . 9-75The automateAndLink extension added to the create operation . . . . . . . 9-76Selecting the Fnd0InheritFrom property constant . . . . . . . . . . . . . . . . 9-77Setting the value for the Fnd0InheritFrom property constant . . . . . . . . 9-77Inheriting property values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-78Selecting the business object to create . . . . . . . . . . . . . . . . . . . . . . . . . 9-79Creating a design . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-79Automatic alignment of the design and part . . . . . . . . . . . . . . . . . . . . 9-80Example of the automateAndLink extension with a condition applied . . 9-80Creating the Boolean property . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-82Boolean property on the design business object . . . . . . . . . . . . . . . . . . 9-82Adding the Boolean property to the design creation wizard . . . . . . . . . . 9-83Boolean property on the Operation Descriptor tab . . . . . . . . . . . . . . . . 9-84Creating the condition that uses the Boolean property . . . . . . . . . . . . . 9-85Adding the condition to the automateAndLink extension . . . . . . . . . . . 9-85


Contents

The Boolean property added to the design creation wizard . . . . . . . . . . 9-86Adding the new value to an existing status LOV . . . . . . . . . . . . . . . . . 9-89Viewing the new status in the Fnd0state_status LOV . . . . . . . . . . . . . . 9-90Creating a custom condition for the new status . . . . . . . . . . . . . . . . . . 9-91Viewing the new status in Schedule Manager . . . . . . . . . . . . . . . . . . . 9-91Editing the Fnd0BOMLineRevConfigProps global constant . . . . . . . . . . 9-97Fnd0BOMLineRevConfigProps constant . . . . . . . . . . . . . . . . . . . . . . . 9-98Viewing the custom properties on the BOMLine business object . . . . . . 9-98Setting the display name of the custom property . . . . . . . . . . . . . . . . . 9-99Custom property in the Change Columns dialog box . . . . . . . . . . . . . . 9-100Custom property added as a BOM column . . . . . . . . . . . . . . . . . . . . . 9-100O5_ItemItemRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-102O5_ItemGDERule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-103Verification rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-103Occurrence condition validation result success message . . . . . . . . . . . 9-104O5_ItemItemRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-105O5_ItemGDERule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-106O5_isPropertyValue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-107O5_ItemPropertyRule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-108Verification rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-108Occurrence condition validation result success message . . . . . . . . . . . 9-109Creating partition and template properties . . . . . . . . . . . . . . . . . . . . 9-111Creating cascading partition and template LOVs . . . . . . . . . . . . . . . . 9-112Attaching the partition LOV to the partition property . . . . . . . . . . . . 9-113Creating an interdependent LOV . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-114Verifying the partition and template LOVs . . . . . . . . . . . . . . . . . . . . 9-115Selecting the application domain for a diagram . . . . . . . . . . . . . . . . . 9-116Adding a new application domain to the Fnd0TcApplication list ofvalues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-117

Adding a new value to the NE_diagram_domains_for_perspectivesperspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-118

Selecting the application domain for a diagram . . . . . . . . . . . . . . . . . 9-118Extension dialog box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-132Setting the extension availability . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-133Viewing the extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-134Adding the extension to the BMF_SESSION_register_emp_handlersoperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-135

Adding the extension to the BMF_SESSION_register_emp_handlersoperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-135

Adding the extension to the BMF_SESSION_register_emp_handlersoperation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-136

Workflow templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-138Selecting the process template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-138EPM user exit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-139Making the EPM user exit available in the extension . . . . . . . . . . . . . 9-140EPM user exit made available on the extension . . . . . . . . . . . . . . . . . 9-140Adding the extension to the base action of the EPM user exit . . . . . . . 9-141Mapping Designer perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4Creating a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-11Creating a comma-separated value (CSV) file . . . . . . . . . . . . . . . . . . 10-21Creating an index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22Creating an association . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-22Lookup definition files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-23Lookup function file added to the factors libraries . . . . . . . . . . . . . . . 10-24


Contents

Lookup table in a map . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24Standard perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-7BMIDE view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8BMIDE Assistant view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-8Help view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-9Advanced perspective . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-10Business Objects view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11Classes view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11Extensions view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-11Event Type Mappings Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-14Deployment Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-27UML editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-41Console view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-45Navigator view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-45Outline view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-46Problems view . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-46

Tables

Encodings for Oracle databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-5Encodings for MS SQL databases . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-6


Chapter

1 Getting started with the BusinessModeler IDE

Introduction to the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

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

Business Modeler IDE interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4Orientation to the Business Modeler IDE interface . . . . . . . . . . . . . . . . . 1-4Business Modeler IDE menu commands . . . . . . . . . . . . . . . . . . . . . . . . . 1-6Set favorites in the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . . . . . 1-12Filter out visible elements in the Business Modeler IDE . . . . . . . . . . . . . . 1-13

Basic concepts for using the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . 1-15What is the Business Modeler IDE used for? . . . . . . . . . . . . . . . . . . . . . . 1-15Why create business objects? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16Introduction to templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-16Understanding custom versus COTS templates . . . . . . . . . . . . . . . . . . . . 1-17

Basic tasks when using the Business Modeler IDE . . . . . . . . . . . . . . . . . . . . 1-18

Using the Business Modeler IDE for the first time . . . . . . . . . . . . . . . . . . . . . 1-19Basic process for using the Business Modeler IDE to create data model

definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-19Create a sample extension . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-20Save your changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-25

PLM00071 J Business Modeler IDE Guide

Chapter

1 Getting started with the BusinessModeler IDE

Introduction to the Business Modeler IDEThe Business Modeler IDE (Integrated Development Environment) is a tool forconfiguring and extending the data model of your Teamcenter installation. The datamodel objects define the objects and rules used in Teamcenter.

To get started using the Business Modeler IDE, follow the steps in Basic tasks whenusing the Business Modeler IDE.

Administrators and business analysts use the IDE to:

Create new data model elements.

For more information, see Business Modeler IDE administration tasks andIntroduction to business rules.

Perform C++ customizations.

For more information, see Customization methods in the Business Modeler IDE.

Migrate data using the Mapping Designer.

For more information, see Introduction to the Mapping Designer.

Note The Business Modeler IDE is built on top of the Eclipse platform. Eclipseis a generic platform for tool development that is extended using itsplug-in and extension point technology. For more information aboutEclipse, go to the following Web site:

http://www.eclipse.org

For Business Modeler IDE best practices, see the Business Modeler IDEBest Practices Guide on GTAC (Global Technical Access Center) at thefollowing URL. You must have a WebKey account to access this page.

http://support.industrysoftware.automation.siemens.com/docs/teamcenter

PLM00071 J Business Modeler IDE Guide 1-1

Chapter 1 Getting started with the Business Modeler IDE

Before you beginPrerequisites The following are required on the client that runs the Business Modeler IDE:

Supported operating system

The Business Modeler IDE is supported on the same platforms asTeamcenter. For supported versions, see the Siemens PLM SoftwareCertification Database at the following URL:

http://support.industrysoftware.automation.siemens.com/certification/teamcenter.shtml

For more information about installing the Business Modeler IDE ondifferent operating systems, see Introduction to installing the BusinessModeler IDE.

Java

Prior to Teamcenter 10.1, Teamcenter included Java as part of theinstallation package. Now, Java is no longer provided with Teamcenter,and you must install Java before attempting to install the BusinessModeler IDE.

Install the following versions:

o Java Runtime Environment (JRE) 7 or later if you install thestand-alone version of the Business Modeler IDE

o Java JDK 7 or later if you install the Business Modeler IDE into anexisting Eclipse environment or if you want to create services

You can download the JRE and JDK from this Web site:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Caution You must install the 32-bit version of Java if you want toinstall and run the 32-bit version of Business Modeler IDE,or you must install the 64-bit version of Java if you have a64-bit machine and you want to install and run the 64-bitversion of Business Modeler IDE.

Before installing the Business Modeler IDE, you must set theJRE_HOME environment variable to point to the location of the 32-bitJRE on your system. If you have a 64-bit system, you must also setthe JRE64_HOME environment variable to point to the location ofthe 64-bit version of the JRE on your system. If you do not set theseenvironment variables, you may not be able to launch TeamcenterEnvironment Manager (TEM), which is used to install the BusinessModeler IDE.

For more information, see the Installation on Windows Clients Guide.

You must also set the JAVA_HOME and JDK_HOME environmentvariables to the location of the JDK.

1-2 Business Modeler IDE Guide PLM00071 J

Getting started with the Business Modeler IDE

One GB of RAM dedicated to the Business Modeler IDE

You can allocate memory to the Business Modeler IDE in theinstall-location/bmide/client/BusinessModelerIDE.ini file and in aBMIDE_SCRIPT_ARGS environment variable.

For more information, see Allocate memory to the Business Modeler IDE.

Note If you perform live updates, you must have a minimum of 4 GBof RAM on the system running the Business Modeler IDE toallow for other processes.

Eclipse 3.8

This is required only if you install the Business Modeler IDE into anexisting Eclipse installation.

For more information, see Install the Business Modeler IDE to an existingEclipse environment.

Administrator rights

Users of the Business Modeler IDE must be members of the databaseadministrators (dba) group on the Teamcenter server. Use theOrganization application in the Teamcenter rich client to add a user tothe dba group.

A C++ compiler for compiling code. For supported versions, see theSiemens PLM Software Certification Database at the following URL:

http://support.industrysoftware.automation.siemens.com/certification/teamcenter.shtml

When using Windows, use Visual Studio 2010 Service Pack 1. Ifcompiling on a 64-bit machine, you must install the x64 Compilers andTools option to Visual Studio.

For more information about writing code, see Customization methods inthe Business Modeler IDE.

Enable the BusinessModeler IDE

To enable the Business Modeler IDE, you must install it either as astand-alone application, or place the plug-ins into an existing Eclipseenvironment.

For more information, see Introduction to installing the Business ModelerIDE.

Start the BusinessModeler IDE

To start the stand-alone Business Modeler IDE application, run bmide.bat(Windows) or bmide.sh (Linux). To start the Business Modeler IDE when itis distributed in an Eclipse environment, run eclipse.exe.

For more information, see Start the Business Modeler IDE.Configure theBusiness ModelerIDE

Before you can use the Business Modeler IDE, you must configure it bycreating a project, setting preferences, and creating a server profile.

For more information, see Configure the Business Modeler IDE.



Note For Business Modeler IDE best practices, see the Business Modeler IDE BestPractices Guide on GTAC (Global Technical Access Center) at the followingURL. You must have a WebKey account to access this page.


Business Modeler IDE interface

Orientation to the Business Modeler IDE interface

The Business Modeler IDE utilizes the Eclipse user interface, which is composed ofperspectives, views, and editors. A perspective is an arrangement of views. A view isa tabbed window within the UI that provides a view of data. An editor is a windowthat allows you to edit source files. The user can rearrange the user interface in anyconfiguration by dragging and dropping views and editors.

The examples provided are a common arrangement of the interface.

For more information about the user interface, see Workshop 2: Explore the userinterface and Business Modeler IDE perspectives, views, and editors.

The user interface is comprised of two perspectives, Standard and Advanced. Toopen one of these perspectives, choose WindowOpen Perspective.

Standard perspective

Provides a simplified user interface. It contains the BMIDE view, which providesa centralized location for favorites, data model elements, and project files.



1 Toolbar Contains buttons for the most commonlyused actions.

2 BMIDE view Provides a single view for favorites, datamodel elements, and project files.

3 Editor Allows users to edit data model elements.4 BMIDE Assistant view Helps new users get started using the

Business Modeler IDE.

5 Help view Provides online help for the BusinessModeler IDE. You can launch this view bypressing the F1 key or clicking the questionmark button ? in the lower left corner of anydialog box.

Advanced perspective

Provides a full-featured user interface. Contains separate views for businessobjects, classes, project files, and data model extensions.

1 Toolbar Contains buttons for the most commonlyused actions.

2 Business Objects view Displays business objects, the fundamentalobjects that model business data.

3 Extensions view Displays extensions to the data model.4 Editor Allows users to edit data model elements.



5 BMIDE Assistant view Helps new users get started using theBusiness Modeler IDE.

6 Help view Provides online help for the BusinessModeler IDE. You can launch this view bypressing the F1 key or clicking the questionmark button ? in the lower left corner of anydialog box.

Business Modeler IDE menu commands

The following is a list of menu commands from the Business Modeler IDE userinterface. The commands are found in the menu bar and toolbar at the top of thewindow, and on the shortcut menu when you right-click in the user interface.

Menu command Description

Add Business Object Creates a business object, the fundamental object thatmodels business data.

For more information, see The general process foradding a new business object.

Add ConditionCreates a conditional rule.

For more information, see Add a condition.

Add Id ContextCreates an ID contexts for use with alias or alternateidentifiers.

For more information, see Add an ID context.

Add LOV Creates a list of values.

For more information, see Introduction to lists of values(LOVs).

Add Naming Rules Creates a rule to define how an object is named.

For more information, see Add a naming rule.

Add Status Creates a workflow status.

For more information, see Add a status type.

Add to FavoritesAdds the selected data model element to the favoriteslist.

Back Returns to the previous business object that wasselected in the view. (This menu item is available onlyin the Advanced perspective.) You can also use themenu next to the button to choose one of the previousclasses.




BookmarksProvides a list of bookmarked business objects.(This menu item is available only in the Advancedperspective.) Pull down the menu and choose abookmark to select a business object in the view. Thelist of bookmarks is preset with some of the commonbusiness objects. You can also add business objects tothe list using the Add Bookmark menu command onthe shortcut menu.

Delete Deletes the selected data model elements. You can onlydelete custom objects.

For more information, see Delete objects.

Deploy TemplateSends extensions to a server.

See How to deploy a template.

Editors Displays the following menu commands:

Global Constants Editor

Edits the values of global constants.

For more information, see Change the value of aglobal constant.

GRM Rules Editor

Edits Generic Relationship Management (GRM)rules.

For more information, see GRM Rules editor.

Verification Rules Editor

Specifies when Teamcenter Component objectscan be used in Teamcenter.

For more information, see Verification rule editor.

Event Type Mappings Editor

Displays characteristics of the selected eventmapping.

For more information, see Event Type Mappingeditor.




Filter Displays the following menu commands when youright-click an object.

Hide all COTS object elements

Hides all commercial-off-the-shelf (COTS) objectsand displays only the custom data model elements.

Hide this folder and all objects below

Hides the selected folder and its contents.

Customize Hidden Groups

Allows you to select the data model elements todisplay in the user interface.

Find objectSearches for a data model element. This menucommand appears when you right-click an object orfolder.

Forward Displays the next business object that was selectedin the view. (This menu item is available only in theAdvanced perspective.) You can also use the menu nextto the button to choose one of the next business objects.

Generate CodeC++Classes

Generates C++ source code for the selected businessobject.

For more information, see Introduction to generatingboilerplate code.

Hide COTSHides the COTS (commercial-off-the-shelf) data modelelements and displays only the custom data modelelements you have created.

Navigate Displays the following menu commands:

Expand Selection

Expands all the child objects below the selectedbusiness object.

Collapse Selection

Collapses all the child objects below the selectedbusiness object.

Go toParent

Takes you to the parent business object.




New object Runs a wizard to add a new object. This menucommand appears when you right-click an object orfolder.

You can also add objects using the New Model Element

button .

New Model ElementAdds custom data model elements.

Open Opens the selected object.

Open Event Type

Mappings Editor

Displays an editor to connect an event to a businessobject type.

For more information, see Create an event typemapping.

Open Global Constants

Editor

Allows you to modify existing global constants.

For information about creating global constants, seeCreate a global constant.

Open GRM Rules Editor Allows you to add, modify, or remove GenericRelationship Management (GRM) rules. A GRM ruleapplies constraints on the relationship between twobusiness objects.

For more information, see GRM Rules editor.

Open in UML Editor Displays the business object in the UML editor. Alsocreates a .tmd file for the UML view of the businessobject and places this file in the Project Files\outputfolder.

For more information, see Open a class or businessobject in the UML editor.

Open Verification Rules

Editor

Displays available verification rules that specify whenTeamcenter Component objects can be used inTeamcenter.

For more information, see Verification rule editor.

Organize Displays the following menu commands when youright-click a data model element:

Set active extension file

Sets the file in which to place model changes.The extension files reside in the ProjectFiles\extensions folder of the project.

For more information, see Set the active extensionfile.

Move to Extension File




Moves the selected custom model element to afile in which model changes are placed. Thismenu command is enabled only when a customitem is selected (custom items appear with a csymbol). The extension file resides in the ProjectFiles\extensions folder of the project.

For more information, see Move a custom object toan extension file.

Set as active Library

Sets the selected library as the one in which tosave library objects. This menu command isenabled only when a library is selected in theExtensions\Code Generation\Libraries folder.

For more information, see Create a library.

Set as active Release

Sets the selected release as the one in whichto associate custom data model elements.This menu command is enabled only when arelease level is selected in the Extensions\CodeGeneration\Releases folder.

For more information, see Create a release.

Organize Extensions Displays the following menu commands:

Set active extension file

Sets the file in which to place model changes.The extension files reside in the ProjectFiles\extensions folder of the project.

For more information, see Set the active extensionfile.

Add new extension file

Adds a file in which to place model changes.

For more information, see Add a new extension file.

Move Model Elements to Extensions File

Moves the selected custom model elements toa file in which model changes are placed. Thismenu command appears only when a customitem is selected (custom items appear with a csymbol). The extension file resides in the ProjectFiles\extensions folder of the project.




For more information, see Move a custom object toan extension file.

Add localization files

Adds language support files. The files reside in theProject Files\extensions\lang folder.

For more information, see Change the languagesthe template supports.

Import a localization file

Imports language support files from an externalsource. The files are imported to the ProjectFiles\extensions\lang folder.

For more information, see Import localization files.

Package Template

Extensions

Packages the custom data model objects for installationto a production server.

For more information, see Package extensions into atemplate.

Reload Data ModelReloads the data model for the selected project.

Rename Applies a new name to the business object.

For more information, see Rename a business object.

Reports Runs reports on the data model in the selected project.

For more information, see Run data model reports.

Save Data ModelSaves the custom data model objects in the project.

For more information, see Save your changes.

Search ConditionsAllows you to look for conditions in the system.Conditions are conditional statements that resolve totrue or false. You can also see all the conditions in theExtensions view in the RulesConditions folder.

For more information, see Search conditions.




Tools Displays the following menu commands:

Merge Samples

Provides samples to learn how to use the liveupdate merge tool

For more information, see Merge samples.

Push Template to Reference Directory

Copies a template to a reference directory so thatyou can build another project on top of it.

For more information, see Push a template to thereference directory.

Upgrade Tools Displays the following menu commands:

Re-run Template Project Upgrade Wizard

Upgrades the project template to the newestversion of the Business Modeler IDE.

For more information, see Upgrade a templateproject to the current data model format.

Property Name and Relation Name MigrationWizard

Migrates the text for property and relation namesfrom a previous project.

For more information, see Migrate property andrelation names.

Default Location Creation Wizard

Creates a default set of localization files for anupgraded project.

For more information, see Create a defaultlocalization.

Preferences Migration Wizard

Migrates your custom preferences to data modelobjects, such as business object constants.

For more information, see Migrate preferences todata model objects.

Set favorites in the Business Modeler IDE

The Favorites folder holds data model elements for quick access.



Favorites folder

To add elements to the Favorites folder, right-click an element and choose Add toFavorites from the context menu, or click the Add to Favorites button on an editor.

Add to Favorites from context menu

Add to Favorites from editors

Filter out visible elements in the Business Modeler IDE

Filtering hides the selected element category or only hides COTS(commercial-off-the-shelf) elements. This reduces screen clutter.

Hide elements

Right-click a folder and choose FilterHide All COTS element-name elements orHide this folder and all element-name below.



Filter elements

Customize hidden groups

Choose FilterCustomize Hidden Groups to quickly hide entire categories ofelement types.

Customize hidden groups

Configure business objects to display

To filter business objects, right-click the Business Objects folder and chooseFilterConfigure Business objects to display.



Configure business objects to display

Select the Customize Business Objects to Show check box to display only theselected business object types.

Configure business objects to display dialog box

Basic concepts for using the Business Modeler IDE

What is the Business Modeler IDE used for?

The Business Modeler IDE is a tool for adding your own data model objects on top ofthe default Teamcenter data model objects. The Business Modeler IDE accomplishesthis by separating your data model into its own set of files that are kept apart fromthe standard data model, known as the COTS (commercial off-the-shelf) data model.

Data model objects are collected into templates that contain the data model for anapplication (also known as a solution). For example, the foundation_template.xml



file contains the data model for the Foundation solution, the base Teamcenterapplication. When you use the Business Modeler IDE to create data model, yourdata model is rolled up into its own template.

As you develop data model, you can deploy it onto a test server to verify that itbehaves the way you want it to. After you are finished testing, you can packagethe data model into a template that can be installed to a production server usingTeamcenter Environment Manager (TEM).

Why create business objects?

Business objects are the fundamental objects used to model business data. Businessobjects were formerly known as types in Engineering Process Management. Oneof the most important jobs you perform in the Business Modeler IDE is to createbusiness objects to represent different kinds of parts, documents, change processes,and so on. Your company uses business objects to organize all the things it producesinto categories for accuracy and consistency.

For instructions about how to create business objects, see The general process foradding a new business object.

Siemens PLM Software strongly urges you to plan out your business object creation.Perform an object-oriented analysis to determine the optimal business objectstructure, and the custom properties you want to place on the new business objects.

Typically, you start by creating new business objects as children of the Part businessobject to represent product parts, and children of the Design business object torepresent designs. (This automatically creates a master form, a revision, and anrevision master form.) You also use the Dataset business object to represent a filefrom a specific software application. (For example, files created in Microsoft Wordare represented by the MSWord dataset object, text files are represented by theText dataset object, and so on.)

For more information about what business objects you should create, see Commonbusiness objects you can subclass.

Introduction to templates

A template is an XML file that contains the data model for an application (alsoknown as a solution). For example, the foundation_template.xml file contains thedata model for the Foundation solution, the base Teamcenter application. When youuse the Business Modeler IDE to create data model, the new data model is rolledup into a template.

For reference information about templates, see Templates reference.

You can deploy your template to a Teamcenter test server for testing purposes bychoosing BMIDEDeploy Template on the menu bar. This is also known as liveupdate. You can also use live update to send operational data such as LOVs andrules to a production server.

For more information, see Introduction to deploying templates.

You can also package your data model into a template for installation to aTeamcenter production server by choosing BMIDEPackage Template Extensions.

For more information, see Package extensions into a template.

Templates can exist in three locations:



install-location\bmide\templates

This folder stores templates that are used for reference only within the BusinessModeler IDE. The templates in this location are used when you create a project,and supply the base model for your data model extensions. This folder is ofinterest only to the Business Modeler IDE and does not affect your databasestatus.

TC_DATA\model

This folder represents the current status of your database. Templates areplaced here when you use Teamcenter Environment Manager (TEM) to installFoundation or new templates, or when you deploy templates from the BusinessModeler IDE to a test server. All Business Modeler IDE utilities that update thedatabase look here to find the templates to be applied to the database. This is acrucial folder for any installation or upgrade that makes database changes.

workspace-location\version\project\output\packaging

This folder is the default location where templates are packaged by the BusinessModeler IDE. Templates here are a consolidation of all data model extensionsyou performed in your project. Once generated, you can open the template fileand dependency file and verify for correctness. If you also have an installation ofTeamcenter to which you want to install your template using the TEM installer,you browse to this location to obtain the template during the installation.

For more information, see Install a template using TEM.

Understanding custom versus COTS templates

Custom data model objects are those objects you create and store in a customtemplate. COTS (commercial-off-the-shelf) data model objects are the objects thatyour custom data model objects are dependent on. Therefore, custom templates aredependent on COTS templates. You can change or delete only the custom objectsin the data model.

The Foundation template is always a COTS template. When a customer creates theCCC_DEV template, it is considered custom. If a customer provides their templateto a partner to extend, the CCC_DEV template is a COTS template to the partner.The Partner template is considered custom to the partner.



Custom versus COTS template example

Note The state of the COTS or custom templates is not stored in the database, butis determined at run time by the Business Modeler IDE.

Basic tasks when using the Business Modeler IDEPerform the following main tasks in the Business Modeler IDE:

1. Create a template project to hold your custom data model.

For more information, see Create a Business Modeler IDE template project.

2. Create data model objects to represent objects in Teamcenter.

a. Create business objects.

For more information, see Introduction to creating business objects.

b. Create properties on the business objects.

For more information, see Introduction to properties.

c. Create lists of values for the properties.

For more information, see Introduction to lists of values (LOVs).

d. Create rules for the business objects.

For more information, see Introduction to business rules.

3. Deploy the template to a test server for verification.


4. Package the files so the template can be installed to a production server.




5. Install the template to a production server.

For more information, see Install a template using TEM.

For examples of how to perform these basic tasks, see Preparing to use the BusinessModeler IDE workshops.

Using the Business Modeler IDE for the first time

Basic process for using the Business Modeler IDE to create datamodel definitions

Whenever you extend the data model using the Business Modeler IDE, you followthis process.

1. Ensure that you have created a Business Modeler IDE template project.

Before you can extend the Teamcenter data model, you must create a templateproject. A project provides an environment that manages your Teamcenter datamodel extensions in a template. The project contains folders and files that areused to organize your template XML files and to package your template fordeployment.

For more information, see Create a Business Modeler IDE template project.

2. Perform the extension work.

For example, create a new business object, list of values, and so on.

For more information, see Create a sample extension.

3. Save your work.

Choose BMIDESave Data Model, or click the Save Data Model button onthe main toolbar.

For more information, see Save your changes.

Note To check for data model errors, right-click your project and select ReloadData Model. See the Console view for errors.

4. Verify your extensions by deploying them to a Teamcenter test server.

Choose BMIDEDeploy Template on the menu bar.


5. After you verify your extensions, you can package your data model into atemplate that can be installed on a production server.




Note For Business Modeler IDE best practices, see the Business Modeler IDEBest Practices Guide on GTAC (Global Technical Access Center) at thefollowing URL. You must have a WebKey account to access this page.


Create a sample extension

A good way to learn how to use the Business Modeler IDE is to create a new businessobject. Business objects are the fundamental objects used to model data. Createbusiness objects to represent product parts, documents, change processes, and so on.

This example shows you how to create a child of the Item business object. Item isthe most common business object under which children are created, and it is used torepresent product parts.

For more extensions you can perform, see Business Modeler IDE administrationtasks.

Perform the following steps to create a child of the Item business object:

1. Right-click the project in which you want to create the new business object andchoose OrganizeSet active extension file.

For more information, see Set the active extension file.

2. On the menu bar, choose BMIDENew Model Element.

The Model Element Type wizard is displayed.

Model Element Type wizard



3. Type Item in the Wizards box and click Next.

The Business Object wizard is displayed.

Creat

business modeler ide guide

Documents