team center engineering v10 admin

Teamcenter EngineeringApplication Administration

Student GuideJanuary 2006

MT14350 – Version 10.0

Publication NumberMT14350-SG-100

Manual History

ManualRevision

ProductVersion

PublicationDate

A V9.0 March 2004B V9.1.2 September 2004C V10.0 January 2006

This edition obsoletes all previous editions.

Software Copyright and Trademark Notices© 2006 UGS Corp. All Rights Reserved. This software and relateddocumentation are proprietary to UGS Corp.

UGS and Teamcenter are registered trademarks or trademarks of UGS Corp.or its subsidiaries in the United States and in other countries.

Java and all Java-based marks are trademarks or registered trademarks ofSun Microsystems, Inc. in the United States and other countries.

All other trademarks or registered trademarks belong to their respectiveholders.

©2006 UGSAll Rights Reserved.Produced in the United States of America.

2 Teamcenter Engineering Application Administration MT14350-SG-100

Contents

Manual History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Software Copyright and Trademark Notices . . . . . . . . . . . . . . . . . . . . 2

Course Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Course Description . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Course Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Key Benefits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Participants . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12Student Responsibilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12How to Use This Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

The Teamcenter Engineering Environment . . . . . . . . . . . . . . . . . . . 1-1

Teamcenter Engineering Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Teamcenter Engineering Installation Directories . . . . . . . . . . . . . . . . 1-3

Teamcenter Engineering Rich Client . . . . . . . . . . . . . . . . . . . . . . 1-4Teamcenter Engineering Base Installation (IMAN_ROOT) . . . . . . 1-5Database Configuration Settings Directory (IMAN_DATA) . . . . . . 1-6

Teamcenter Engineering Environment Variables . . . . . . . . . . . . . . . . 1-7Setting the Teamcenter Engineering Environment . . . . . . . . . . . . . . 1-8Setting the Classroom Teamcenter Engineering Environment . . . . . . 1-9

Activity: Get Acquainted with your TcEng Installation . . . . . . . 1-10Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

User Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Person, User, Role and Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2The infodba Account and its Privileges . . . . . . . . . . . . . . . . . . . . . . . 2-5System Administration Accounts . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6Creating an Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

Creating a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8Creating a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Creating a Sub-Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10Creating a Person . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Creating a User . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13

Tips in Creating your Organization . . . . . . . . . . . . . . . . . . . . . . . . . 2-16Activity: Add a User to the dba Group . . . . . . . . . . . . . . . . . . . . 2-18Activity: Interactively Create a Group and Role . . . . . . . . . . . . . 2-23

Teamcenter Engineering Volumes . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28Creating a Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31

©UGS, All Rights Reserved Teamcenter Engineering Application Administration 3

Contents

Activity: Interactively Create a Volume . . . . . . . . . . . . . . . . . . . 2-36Steps Required to Enable Volume Access through FMS . . . . . . . 2-38

Creating Accounts with the make_user Utility . . . . . . . . . . . . . . . . 2-39Class Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44

Activity: Create User, Group, Role using make_user . . . . . . . . . 2-45Activity: Create Organization using a script . . . . . . . . . . . . . . . 2-46Optional Activity: Create Hierarchical Group Organization . . . . 2-50

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52

Form Types and LOVs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

Form Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2Activity: Automatic Form using Form Type Wizard . . . . . . . . . . . 3-7Activity: Create Automatic Form using Form Type Wizard . . . . . 3-13

Classes, Types and Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14Optional Activity: Form Storage Class Types and Properties . . . 3-16

Lists of Values (LOV) for Form data . . . . . . . . . . . . . . . . . . . . . . . . 3-18Activity: Create LOV for ChangeReason property . . . . . . . . . . . 3-20Activity: Create Hierarchy of LOVs for ChargeCode property . . . 3-25

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31

Item Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

Item Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2Activity: Creating Item (and Master Form) Types . . . . . . . . . . . . 4-4

Using Schema Editor to add POM Classes for Forms . . . . . . . . . . . . . 4-6Activity: Classes for Forms Using the Schema Editor . . . . . . . . . . 4-9Activity: LOV for Item Type Form . . . . . . . . . . . . . . . . . . . . . . . 4-18

Item Type Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-21Activity: Customizing the New Item Dialog . . . . . . . . . . . . . . . . 4-22

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27

Dataset Types and Importing Non-CAD Data . . . . . . . . . . . . . . . . . 5-1

Dataset Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2Dataset Creation/Modification Process . . . . . . . . . . . . . . . . . . . . . . . 5-3Creating Dataset Types and Tools . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-5

Activity: Dataset Type Using the Wizard . . . . . . . . . . . . . . . . . . . 5-6Activity: Creating Dataset Types Using the make_datasettype

utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-10Activity: Creating Dataset Types Using the Standard Method . . 5-12

Importing Non-CAD Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-19Importing Files Interactively . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-20Importing Files Using the import_file Utility . . . . . . . . . . . . . . . 5-26

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31

Product Structure Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

Units of Measure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

4 Teamcenter Engineering Application Administration ©UGS, All Rights Reserved MT14350-SG-100

Contents

Occurrence Note Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4Activity: Creating Units of Measure . . . . . . . . . . . . . . . . . . . . . . 6-6Activity: Creating Occurrence Note Types . . . . . . . . . . . . . . . . . . 6-7

PSView Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-9Activity: Creating PSView Types . . . . . . . . . . . . . . . . . . . . . . . . 6-11

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-12

Creating and Modifying Preferences . . . . . . . . . . . . . . . . . . . . . . . . 7-1

Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2Important Preferences to Consider . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3Creating and Modifying Preferences . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Activity: Modify a Site Preference . . . . . . . . . . . . . . . . . . . . . . . . 7-5Activity: Create a User Preference . . . . . . . . . . . . . . . . . . . . . . . . 7-8Activity: Create a Group Preference . . . . . . . . . . . . . . . . . . . . . 7-12

The preference_manager utility . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-17Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-18

Queries and Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

Defining Saved Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2Activity: Create a Query that Finds Home Folders . . . . . . . . . . . . 8-7

Query Access to Other Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12Activity: Modify Access of the Find Homes Query . . . . . . . . . . . 8-14Activity: Custom Item Type Query . . . . . . . . . . . . . . . . . . . . . . 8-17

Importing/Exporting Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-25Activity: Import a query . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26

Creating Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-28Activity: Create a Report using the EndItem query . . . . . . . . . . 8-30

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-41

Status Types and Revision Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

Status Types for Release Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2Activity: Create Status Types . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-5

Revision Rules Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-6Revision Rules Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-8

Activity: Create Revision Rules . . . . . . . . . . . . . . . . . . . . . . . . . 9-14Activity: Verify Revision Rule Preference Settings . . . . . . . . . . . 9-19

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-21

Access Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

Teamcenter Engineering Data Protections . . . . . . . . . . . . . . . . . . . . 10-2Viewing Data Privileges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-4

Activity: View Default Protections . . . . . . . . . . . . . . . . . . . . . . . 10-6Setting Object Based Exception Privilege Data . . . . . . . . . . . . . . . . 10-9

Activity: Modify Single Object Protections . . . . . . . . . . . . . . . . 10-10How Rules-Based Protections Work . . . . . . . . . . . . . . . . . . . . . . . . 10-13


Contents

Editing the Rule Tree . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-24Activity: Add Access Manager Rule . . . . . . . . . . . . . . . . . . . . . 10-27

Exporting and Importing the Rule Tree from a File . . . . . . . . . . . . 10-33Exporting the Access Manager Rule Tree . . . . . . . . . . . . . . . . . . . 10-34Importing an Access Manager Rule Tree . . . . . . . . . . . . . . . . . . . . 10-35

Activity: Reset the Rule Tree from a File . . . . . . . . . . . . . . . . . 10-36Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-38

Project Creation, Administration and Control . . . . . . . . . . . . . . . 11-1

Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2Activity: Create a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-6Project Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-13Activity: Setting Security Rules . . . . . . . . . . . . . . . . . . . . . . . . 11-14Assigning Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-16Activity: Add objects to a Project . . . . . . . . . . . . . . . . . . . . . . . 11-18

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-24

Workflow Process Modeling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-1

Overview of Teamcenter Engineering Workflow . . . . . . . . . . . . . . . . 12-2Review of the Teamcenter Engineering Process Model . . . . . . . . . . . 12-3Process Terms and Functionality . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-4

Result of Releasing Data with a Process . . . . . . . . . . . . . . . . . . . 12-5Two Usage Modes with Workflow . . . . . . . . . . . . . . . . . . . . . . . . 12-6Controlling the Workflow with Process Templates . . . . . . . . . . . 12-7

Creating Process Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-8Process Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-9Creating new Workflow Processes . . . . . . . . . . . . . . . . . . . . . . 12-10Modifying existing Workflow Processes . . . . . . . . . . . . . . . . . . 12-12Create a Process Template That Does Not Require Signoff . . . . 12-13Creating a Single Signoff Release Process . . . . . . . . . . . . . . . . 12-14Activity: Create a Quick Release Process . . . . . . . . . . . . . . . . . 12-16Activity: Create a Single Signoff Release Process . . . . . . . . . . . 12-20

Quick Release Technique . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-26release_man Utility . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-27Activity: Status data using Quick Release Process . . . . . . . . . . 12-29Activity: Using release_man to Status Data . . . . . . . . . . . . . . . 12-31

Using Task Handlers in a Process Template . . . . . . . . . . . . . . . . . 12-32Some Useful Canned Handlers . . . . . . . . . . . . . . . . . . . . . . . . 12-33Activity: Add a Reviewers Handler to a Process . . . . . . . . . . . . 12-38Using Handlers to Create JT data . . . . . . . . . . . . . . . . . . . . . . 12-41Activity: Review the system setup . . . . . . . . . . . . . . . . . . . . . . 12-44Activity: Add the tessellation Handler to the Quick Release

process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-47Creating a Multi Task Process . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-51Using ACLs in a Process Template . . . . . . . . . . . . . . . . . . . . . . . . 12-52


Contents

Activity: Create a Process Template for CM . . . . . . . . . . . . . . . 12-53Importing/Exporting Workflow Processes . . . . . . . . . . . . . . . . . . . 12-69

Activity: Importing process templates . . . . . . . . . . . . . . . . . . . 12-70Secure Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-73

Activity: Secure Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-75Resource Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-83

Activity: Resource Pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-85Conditional Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-95

Activity: Conditional Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-99Assigning Default Process Templates . . . . . . . . . . . . . . . . . . . . . 12-113

Activity: Assign Default Process Templates . . . . . . . . . . . . . . 12-115Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12-119

Change Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-1

Benefits of the CM Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-2Change Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-3Types of Changes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-4Change Object Folder Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-5Creating Change Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-6

Activity: Create the TRCN Change Type . . . . . . . . . . . . . . . . . . 13-8Process Model Design for Change Management . . . . . . . . . . . . . . . 13-15TR Change Notice Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-16

Activity: Add CM Handlers to TR Change Notice . . . . . . . . . . . 13-17Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13-21

Command Suppression and Business Modeler . . . . . . . . . . . . . . . 14-1

Command Suppression . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-2Activity: Modify Command Suppression Definitions . . . . . . . . . . 14-4

Business Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-7Type Display Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-8

Activity: Creating Type Display Rules . . . . . . . . . . . . . . . . . . . . 14-9Naming Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-13

Activity: Creating and Attaching Item Naming Rules . . . . . . . 14-16Activity: Test Item Naming Rules . . . . . . . . . . . . . . . . . . . . . . 14-23

Property and Compound Property Rules . . . . . . . . . . . . . . . . . . . . 14-26Activity: Creating Item Property Rules . . . . . . . . . . . . . . . . . . 14-29Activity: Creating Compound Property Rule between EndItem

properties and Items . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-37Extension Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-41

Activity: Default Item Create and Display Behavior . . . . . . . . . 14-44Activity: Assign an Extension Rule . . . . . . . . . . . . . . . . . . . . . 14-47Activity: Test Extension Rule Assignment . . . . . . . . . . . . . . . . 14-52

Deep Copy Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-54Activity: Observe Default Item Revise and Save As . . . . . . . . . 14-55Activity: Create Deep Copy Rules for Items . . . . . . . . . . . . . . . 14-57


Contents

Activity: Test Deep Copy Rules for Items . . . . . . . . . . . . . . . . . 14-58Business Modeler Import/Export Rules . . . . . . . . . . . . . . . . . . . . . 14-61

Activity: Use the UI to Export Business Rules . . . . . . . . . . . . . 14-62Activity: Use the UI to Import Business Rules . . . . . . . . . . . . . 14-64The import_export_business_rules utility . . . . . . . . . . . . . . . . 14-68

Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14-69

Setup for NX Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-1

Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-2Item Structure and Named References . . . . . . . . . . . . . . . . . . . . . . 15-3Create Part Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-6Storage of Associated Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-8Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-9UGMASTER / UGPART Behavior . . . . . . . . . . . . . . . . . . . . . . . . . 15-10Seed Part Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-11Seed Part Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-13

Activity: Organize the NX Seed Parts folder . . . . . . . . . . . . . . . 15-14Mapping TcEng Attributes to NX Part Attributes . . . . . . . . . . . . . 15-16Default Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-17Extending Attribute Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-18Attribute Mapping Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-19Comments and Contexts Symbols . . . . . . . . . . . . . . . . . . . . . . . . . 15-21

Activity: Teamcenter Engineering/NX Attribute Mapping . . . . 15-22Process Templates for NX Related Data . . . . . . . . . . . . . . . . . . . . 15-31Preference Settings for NX Integration . . . . . . . . . . . . . . . . . . . . . 15-33Preference Settings to Consider for NX Integration . . . . . . . . . . . . 15-34Environment Variable Settings for NX Integration . . . . . . . . . . . . 15-35NX Customer Default Files for NX Integration . . . . . . . . . . . . . . . 15-36

Activity: Modify NX Integration Preferences . . . . . . . . . . . . . . 15-37Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15-39

NX Integration Import and Data Release . . . . . . . . . . . . . . . . . . . . 16-1

Introduction to NX Data Import . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-2Parts and Assemblies to be Imported . . . . . . . . . . . . . . . . . . . . . . . . 16-3Prepare to Import NX Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-5

Recognize the NX Files and Attribute Data . . . . . . . . . . . . . . . . 16-6Overview of the ug_import Capabilities . . . . . . . . . . . . . . . . . . . . . 16-10

Introduction to Using Mapping Files . . . . . . . . . . . . . . . . . . . . 16-11Introduction to Using Command Line Keywords . . . . . . . . . . . 16-12

Understanding Various NX Integration Import Scenarios . . . . . . . 16-13Command Line Keywords With ug_import . . . . . . . . . . . . . . . . . . 16-16Import Component/Assembly Parts without a Map File . . . . . . . . . 16-17Import an Assembly using a Map File and Search File . . . . . . . . . . 16-19The Import Log File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-25

Activity: Using ug_import to Import the Seed Parts . . . . . . . . . 16-26


Contents

Activity: Import the 1600 Wheel Assembly . . . . . . . . . . . . . . . 16-29Import a Non-Master Drawing File . . . . . . . . . . . . . . . . . . . . . . . . 16-30

Activity: Import the 1250 Axle Drawing . . . . . . . . . . . . . . . . . . 16-31Import Files Associated to a (Master) Part File . . . . . . . . . . . . . . . 16-33

Activity: Import the 1250 Axle Associated Files . . . . . . . . . . . . 16-35Import Files Associated to the DWG (Non-Master) Part File . . . . . 16-36

Activity: Import the Axle Drawing Associated Files . . . . . . . . . 16-37Import Files Using a Full Map File . . . . . . . . . . . . . . . . . . . . . . . . 16-38

Activity: Import 2105 Frame Assy with Mapping File . . . . . . . 16-42Importing Non-CAD Files into an Item . . . . . . . . . . . . . . . . . . . . . 16-44

Activity: Import the Heat Treat Text File . . . . . . . . . . . . . . . . . 16-45Releasing Previously Imported NX Data . . . . . . . . . . . . . . . . . . . . 16-46

Activity: Release the 2111 Item Revision . . . . . . . . . . . . . . . . . 16-47Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16-49

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


Course Overview

Course DescriptionTeamcenter Application Administration addresses setup of the TeamcenterEngineering environment through realistic data and process implementationscenarios. You will learn how to define business data and process models in aTeamcenter Engineering database.

This course illustrates a best practice process for defining a company’s dataand process models in Teamcenter Engineering. It also illustrates managingthe Teamcenter Engineering environment and importing legacy data intoTeamcenter Engineering

Course Objectives• Overview of Teamcenter Engineering System Environment

• Build Group/User/Role Organization

• Model Item Data, Form Data, and Dataset Data

• Model Product Structure Data

• Define Statuses and Configuration Rules

• Extend Query Tools and Create Reports

• Define Access Rules

• Create Projects and Control Access to Project Data

• Design Workflow Templates and Model Change Management Data

• Define Type Display, Naming, Extension, Property, Compound Propertyand Deep Copy Rules

• Set Site, Group, Role and User Preferences and Options

• Configure an NX Integration

• Import Legacy Data


Key Benefits

Key Benefits• Increase productivity by learning through realistic projects.

• Participate in hands-on work sessions with Teamcenter Engineering andNX Integration

• Benefit from personal assistance of a UGS-certified instructor

• Demonstrate best practices for implementing and using TeamcenterEngineering

ParticipantsAnyone responsible for defining, configuring or maintaining a TeamcenterEngineering implementation, in particular, implementation planners,application administrators, UNIX/Windows system administrators andOracle DBAs.

Student Responsibilities• Be on time

• Participate in class

• Stay with the subject matter

• Listen attentively and take notes

• Practice on the job what you have learned

• Have fun


Course Overview

How to Use This ManualInside each lesson are sections that include key concepts followed by anactivity to allow you to practice the concepts.

The format of the activities is consistent throughout this manual. Steps arelabeled and specify what will be accomplished at any given point in theactivity. Below each step are action boxes which emphasize the individualactions that must be taken to accomplish the step.

Activity Example

For your benefit, each activity is organized in the following manner.

Activity: Login to Teamcenter Engineering

In this activity, you will login to Teamcenter Engineering.

Step 1: Login to Teamcenter Engineering

Choose the Admin application.

Choose the Organization icon.

Enter the UserID and Password assigned to you

The Step is intended to be an increment to complete the activity.

Indented from each step is a series of actions, represented by square bullets.These actions are intended to provide the button pushes to complete the step.

Each lesson ends with a Summary page.


Lesson

1 The Teamcenter EngineeringEnvironment

Purpose

The purpose of this lesson is to acquaint you with some important parts ofthe Teamcenter Engineering system environment.

Objectives

Upon completion of this lesson, you will be able to:

• Identify the different types of user interfaces for accessing and working inTeamcenter Engineering.

• Locate key directories containing data you need to configure a TeamcenterEngineering site.

• Prepare the Teamcenter Engineering system environment for commandline interface tools.

©UGS, All Rights Reserved Teamcenter Engineering Application Administration 1-1

The Teamcenter Engineering Environment

Teamcenter Engineering InterfacesThere are different user interfaces for accessing and working inTeamcenter Engineering. Depending on the type of access needed,a person can be assigned to log in and use one of these interfaces.

Rich Client The main Rich Client interface is for the person whodeals primarily with Configuration Management,Workflow, Change Management, and ProductStructure creation and maintenance.Start-up scripts:

Windows: portal.batUnix: start_portal

NX Manager NX Manager is designed for the person who spendsa large portion of their time in a CAD application.The interface is a scaled down version of the fullRich Client interface with limited Workflow, ChangeManagement, and Product Structure capabilities.Start-up scripts:

Windows: ugmanager_portal.batUnix: start_ugmanager_portal

Thin Client The Thin Client is intended for those users who willbe mostly viewing and reviewing. There are limitedsignoff and application access capabilities.

1-2 Teamcenter Engineering Application Administration ©UGS, All Rights Reserved MT14350-SG-100


Teamcenter Engineering Installation DirectoriesThe following material will describe the installation directories thatcontain data used by the administrative user to configure the TeamcenterEngineering implementation:

• Teamcenter Engineering Rich Client (Site Dependent)

• Teamcenter Engineering Base Installation (IMAN_ROOT)

• Teamcenter Engineering Database Configuration Settings Directory(IMAN_DATA)



Teamcenter Engineering Rich Client

The Teamcenter Engineering Rich Client software may be installed in severalconfigurations, based on your site requirements. The installation directorycontains the JAVA binaries for the client application and numerous propertiesfiles that can be modified to change the default behavior of the portal software.

The following files will be discussed as the course progresses:

portal.jar The JAVA archive of the Rich Clientapplication. When un-archived,included properties files can be usedto change the default behavior of thePortal application.

portal.properties Contains high level Rich Client defaults.The Application listings within thePortal GUI can be added or subtractedfrom the interface using settings in thisfile.

client_specific.properties Defines settings that affect the RichClient Viewer application and choicesfor the database selections on theTeamcenter Engineering logon dialog.

site_specific.properties Defines Help library location



Teamcenter Engineering Base Installation (IMAN_ROOT)

The Teamcenter Engineering base installation is identified by theIMAN_ROOT system environment variable. This directory contains the coreTeamcenter Engineering product binary executables.

The IMAN_ROOT directory has a specific directory structure and contentwhen the product is shipped. It is very important that this structure andcontent is maintained.

Maintaining integrity (directories and files) allows technical supportpersonnel to quickly troubleshoot a problem and determine if the problem iscaused by customization or if the problem is a defect of the core product.

Modifying the directory structure or the files contained in these directoriescan greatly affect product support. Therefore, we strongly recommendadhering to the following guidelines for customizing Teamcenter Engineering.

The following table list some of the IMAN_ROOT directories we will beexposed to during this course.

Directory RemarksIMAN_ROOT/bin Contains the core product binary files

including command line interface utilities.IMAN_ROOT/data Contains default values for an IMAN_DATA

directory shipped with the product.IMAN_ROOT/lang Contains the /textserver directory which

contains XML files used for localization ofTeamcenter Engineering.

IMAN_ROOT/web Contains the Web access application forTeamcenter Engineering.

The IMAN_ROOT/bin directory contains many TeamcenterEngineering utilities that will be used in this class.

Although the IMAN_ROOT directory may also be referred toas the TC_ROOT directory in some of the help files and systemdocumentation, the environment variable, IMAN_ROOT is used toidentify the Teamcenter Installation directories. This may change infuture releases as the IMAN references are phased out.



Database Configuration Settings Directory (IMAN_DATA)

The IMAN_DATA directory is created (based on a copy of theIMAN_ROOT/data) directory during the database installation and initialconfiguration.

An IMAN_DATA directory is created and used for each database instancea site may have created - for example, prod (Production), test (Test), andtrng (Training).

The IMAN_DATA directory contains files and sub-directories that areintended to be modified to support configuration. Among these are:

tc_preferences.xml Stores Teamcenter Engineering site preferencesused to import Site/Group/Role/User preferencesusing the preferences_manager utility.

gpfiles directory Stores Teamcenter Engineering grouppreference files used to import Grouppreferences using the preferences_managerutility.

rpfiles directory Stores Teamcenter Engineering role preferencefiles used to import Role preferences using thepreferences_manager utility.

am directory Stores BACKUP definitions of the AccessManager setup .

gs_info directory Stores definitions of Dataset types.

The IMAN_DATA directory also contains other files maintained on theoperating system and tied to a particular database. More explanation of thefiles and sub-directories in the IMAN_DATA directory will be discussed asthe course progresses.



Teamcenter Engineering Environment VariablesA working knowledge of Teamcenter Engineering environment variablesis essential for Teamcenter Engineering administrators. The followingparagraphs discuss the basic concepts and terminology used to documentTeamcenter Engineering environment variables.

Teamcenter Engineering stores environment variable settings in a script file:iman_profilevars (Unix) or iman_profilevars.bat (Windows). The Unix versionof this script can be executed directly by Bourne or Korn shells.

The following environment variables must be set before usingiman_profilevars.

IMAN_ROOT Top (root) directory of the Teamcenter Engineeringdirectory structure. This environment variablemust be set before running the TeamcenterEngineering application or command line utilities.

IMAN_DATA Directory containing Teamcenter Engineeringdata files. This variable is set duringTeamcenter Engineering installation and added toIMAN_DATA/iman_profilevars.

The following are some of the environment variables set withiman_profilevars.

IMAN_BIN Location of the Teamcenter Engineeringutilities.

ORACLE_SERVER Oracle server network node.ORACLE_SID Unique name of Oracle database instance

associated with IMAN_DATA.IMAN_DB_CONNECT The userid and password the Teamcenter

Engineering software uses when it interactswith the Oracle software.



Setting the Teamcenter Engineering EnvironmentThe command line interface utilities documented in this class run from thecommand line inside operating system command shells. The TeamcenterEngineering environment must be set manually before these utilities canbe run. It is only necessary to perform this procedure once for each shellsession. The environment will remain configured until the shell is closed orthe settings are overridden by other shell commands.

Each Teamcenter Engineering utility documents the environment requiredto successfully run. The environment information included with each utilityassumes that the Teamcenter Engineering environment has been set asdescribed in the following paragraphs.

In the following procedures default path names are used. If other pathnames were specified during Teamcenter Engineering installation,use those path names instead.

To set the environment, do the following:

1. Open a command prompt window on your workstation.

2. Type one of the following sets of commands:

Bourne/Korn

Shell

IMAN_ROOT=/usr/tceng2005; export IMAN_ROOTIMAN_DATA=/usr/tceng2005/imandata; export IMAN_DATA. $IMAN_DATA/iman_profilevars

C Shell setenv IMAN_ROOT /usr/tceng2005setenv IMAN_DATA /usr/tceng2005/imandatasource $IMAN_DATA/iman_cshvars

Windows set IMAN_ROOT=d:\tceng2005set IMAN_DATA=d:\tceng2005\imandatacall %IMAN_DATA%\iman_profilevars



Setting the Classroom Teamcenter Engineering EnvironmentA script has been written to set environment variables for this class namedenv-sitea.

env-sitea (Unix) env-sitea.bat (Windows)

Utilities used in this class require that the Teamcenter Engineeringenvironment variables be set. Using env-sitea sets up the TeamcenterEngineering environment variables and paths for the utilities.IMAN_ROOT, IMAN_DATA, and certain other environmentvariables (as designated below) are set with env-sitea and thenthe rest of the Teamcenter Engineering environment variables areset by sourcing IMAN_DATA/iman_profilevars inside env-sitea.

IMAN_BIN=/usr/tceng2005/binIMAN_DATA=/disk1/imandata <- set by env_siteaIMAN_DB_CONNECT=imandev1:tbwiabd@devliIMAN_HELP_FILE=/usr/tceng2005/help/imanhelp.hlpIMAN_INCLUDE=/usr/tceng2005/includeIMAN_LANGUAGE=/usr/tceng2005/langIMAN_LIBRARY=/usr/tceng2005/libIMAN_LOG=/disk1/imandata/log_sltrora_devliIMAN_ONLINE_HELP=/usr/tceng2005/help/imanhelp/imanhelp.kshIMAN_PRINTER=/usr/bin/lpIMAN_ROOT=/usr/tceng2005 <- set by env_sitea

ORACLE_SERVER=sltroraORACLE_SID=devli

POM_SCHEMA=/disk1/imandata/pom_schema_sltrora_devliPOM_TRANSMIT_DIR=/usr/tceng2005/pom_transmit

PATH=/usr/tceng2005/bin:/usr/tceng2005/bin:/disk1/imandata/local/bin:/usr/eds130/bin/

SHLIB_PATH=/usr/tceng2005/lib/CC:/usr/tceng2005/lib/oracle:/usr/tceng2005/lib:/usr/lib

XBMLANGPATH=/disk1/imandata/bitmaps/%BXFILESEARCHPATH=:/disk1/imandata/bitmaps/%N:/disk1/imandata/%N%S:

/usr/lib/X11/app-defaults/%N%S_=/usr/bin/env



Activity: Get Acquainted with your TcEng Installation

In this activity, you will login to your workstation and get acquaintedwith the Teamcenter Engineering installation for this classroom.

Step 1: Login to your workstation.

Step 2: Look at the environment variables for your workstation, payingclose attention to those used for Teamcenter Engineering.

Open a command prompt window and use the appropriatecommands to display the Teamcenter Engineering environmentvariables.

Type:

Unix: env | grep IMANWindows: set iman

Notice that there are no Teamcenter Engineering environmentvariables defined.

Close the command prompt window.

Set the Teamcenter Engineering environment variables forthis class.

Unix: Type . env-sitea in current windowWindows: Double-click env-sitea.bat

The env-sitea script has been written specifically forthis class. Use it to set the Teamcenter Engineeringenvironment variables in this class. Environmentvariables must be set to run the TeamcenterEngineering utilities.

Use the appropriate commands to display the TeamcenterEngineering environment variables.

Unix: env | grep IMANWindows: set iman

Step 3: Look at how the Teamcenter Engineering environment variablesare set.

Identify the location of the IMAN_DATA directory.

View/list the files in the IMAN_DATA directory.



Notice the iman_profilevars or iman_profilevars.bat file.

Open the iman_profilevars file in a text editor.

This file shows how the Teamcenter Engineering environmentvariables have been set.

Find the IMAN_DB_CONNECT environment variable setting.

Notice the setting.

IMAN_DB_CONNECT=infodba:tbwiabd@prod (may be different)

IMAN_DB_CONNECT is set to the Oracle user accountthat performs database transactions, i.e., infodba. The wordprod represents the name of the database the TeamcenterEngineering user is connecting to.

Exit the editor application without filing.

Step 4: Look at the Teamcenter Engineering install directories by usingthe IMAN_ROOT environment variable.

Identify the location of IMAN_ROOT.

View/list the files in the IMAN_ROOT directory.

Notice the subdirectories that were explained earlier.

View the contents of the bin directory

Notice the Teamcenter Engineering utilities. Youwill be using some of these utilities this week (e.g.make_user, install, import_file, lock_db, unlock_db).

You are now acquainted with the classroom setup andready for the rest of the course activities.

This concludes the activity.



SummaryIn this lesson you got an overview of:

• The different Teamcenter Engineering interfaces and their key uses.

• The location and content of key directories containing data used toconfigure a Teamcenter Engineering site.

• The process to prepare Teamcenter Engineering Environment forcommand line interface tools.


Lesson

2 User Organization

Purpose

The purpose of this lesson is to manage the User Organization in theTeamcenter Engineering database.

Objectives


• Use the Organization Application to manage Persons, Users, Groups,Roles and Volumes

• Use the make_user utility to manage Persons, Users, Groups, Roles andVolumes


User Organization

Person, User, Role and GroupIn order to explain the basic Teamcenter Engineering concepts of persons,users, groups and roles, we will consider an individual, Robert Green, whois employed at a Company.

• In the Company organization matrix, Robert Green primarily worksin the high_performance product group, but he is also assigned to thestandards group.

• Robert Green has many skills that he applies appropriately whileworking in her assigned groups with roles: Engineering Manager, DesignEngineer, Standards Engineer.

Robert Green also is an Administrator for the TeamcenterEngineering implementation and has access to the administrationgroup (dba) and applies her administration skills (DBA role).

What is a Person?

The Person name describesthe individuals who work atyour site. A Person containsproperties such as PersonName, Street Address, andEmployee Number. EachPerson Name must beunique.

PersonGreen,Robert10824 Elm StreetWheeling, Il 60021Organization: Company BBEmployee Number: 150Email: [email protected]

What is a User?

The User is a Person withan account know to theTeamcenter Engineeringsystem. One person canhave several user accountsin Teamcenter Engineering.

PersonGreen,Robert10824 Elm StreetWheeling, Il 60021

The TeamcenterEngineeringimplementation of “user” iscompletely separate fromany OS user account.

UsergreenDefault Group=high_performance

Each user must belong to a group.


User Organization

What is a Group and a GroupMember?

In Teamcenter Engineering, agroup serves two purposes:

1. A group defines a list ofselected roles for the group.There can be multiple roles pergroup.

GroupGroup=high_performanceRoles=Engineering ManagerDesign Manager

2. A Group Member defines auser with an assigned role in aGroup. There can be multiplegroup members in a group,providing multiple users withmultiple roles.

PersonGreen, Robert10842 Elm StreetWheeling, Il 60021

UserGreenDefault Group=High_Performance

Group MemberGreen, Robert (green)Group=High_PerformanceRoles=Engineering ManagerDesign Manager

Group MemberGreen, Robert (green)Group=StandardsRole=Standards Engineer

One user can be a member of many groups. For example, Robert Green canbelong to the high_performance and standards groups.


User Organization

What is a Role?

In Teamcenter Engineering, a role is an object that models the type of work auser is expected to perform in a particular Teamcenter Engineering group.One group can have many roles. One user can perform multiple roles in agroup. For example, Robert Green is an Engineering Manager. In additionto his responsibilities as Engineering Manager, Robert must also performdesign work from time to time. Therefore, user green has been assigned twoTeamcenter Engineering roles in the high_performance group: EngineeringManager and Design Engineer.

Groups can be organized by function or project.

What is a Sub-Group?In Teamcenter Engineering,a Sub-Group is a Group withanother Group designated asits parent. A Sub-Group canalso be designated as a ParentGroup itself. The positionof Sub-Groups within theorganization hierarchy can bemanaged by parenting andre-parenting Groups.

Parent Group

Group=Suppliers

Sub-Group Sub-GroupGroup=abc Group=acme


User Organization

The infodba Account and its Privileges

The infodba accountis the only accountinTeamcenter Engineeringafter the installation.

The infodba accout consists of:

A Person object named infodba

A User object named infodba

A Group object named dba

A Role object named DBA and agroup Member object

Person

infodba

User

infodba

Group Member

infodba (infodba)Group=dbaRole=DBA

The infodba account has all the Teamcenter Engineering system levelprivileges, including a Bypass switch to override access protections.

Users in the dba group have a Bypass toggle which canbe turned On with the User Setting dialog (Edit→UserSetting...→Administrative). Bypass privilege supercedes other privileges.


User Organization

System Administration AccountsPersonGreen, Robert10842 Elm StreetWheeling, Il 60021

UserGreen, RobertDefault Group=high_performance

Group MemberGreen, Robert (green)Group=high_performanceRole=Engineering ManagerRole=Design Manager

Group MemberGreen, Robert (green)Group=standardsRole=Standards Engineer

Group MemberGreen, Robert (green)Group=dbaRole=DBA

Using the earlier example with Robert Green, an account could be created asshown above (for example, Person object named Green, Robert; User objectnamed green; Group object named dba; Role object named DBA).

Then the green account has all the Teamcenter Engineering system levelprivileges, including the Bypass switch to override access protections, whenRobert switches to the dba group.

Administrator Privileges

Setting PrivilegesSystem Administrator Member of the dba group or

another dba groupAll system administrationprivileges

Group Administrator Set as a group administratorin the group member dialog

Special access privilegesfor data owned by thegroup.

DBA Role Set as the role of a user in agroup

The DBA role for a userin a non-dba group has noadditional privileges overany other group member.


User Organization

Creating an AccountIf you are a new Teamcenter Engineering site, follow the recommended order.

Create Organization Structure

1. Create role(s).

2. Create volume(s).

3. Enable FMS Control of new volumes.

4. Create group(s) and sub-groups.

Create Persons and Users next as they start using TcEng

1. Create person definition(s).

2. Create user account(s)

Independent Definitions

Roles, Volumes, and Persons are independent definitions. Any of these can becreated without consideration of the other definitions.

Dependent Definitions

Groups and Users are dependent definitions. To create the Group and Userdefinitions, other definitions must exist as follows:

Group definitions require a Role to be defined.

Group definitions suggest a Volume to bedefined.

User account definitions require a Persondefinition.

User account definitions require a Groupdefinition.


User Organization

Creating a Role

By default, the DBA role is defined during installation. The DBA role providesno administrative privileges. Administrative privileges are provided withthe dba Group membership.

To create a role:

• Select Roles.

• Enter the name in the Role field.

• Choose Create.

The Role name can be up to 32 characters and the Description canbe up to 240 characters.

There are some out-of-the-box roles defined to support TeamcenterEngineering Projects. Do not delete these roles from the databaseunder any circumstances. Teamcenter Engineering will not functionproperly without this group.


User Organization

Creating a Group

Double-clicking on Groups in the Organization application expands to showthe groups previously defined in Teamcenter Engineering. As you select eachgroup, its corresponding information is displayed the Group fields. If this is anew installation, only the dba and system groups are listed.

When the Default Volume setting is used to specify a volume, a sub-directoryis created within the volume’s defined path. The sub-directory’s name isthe group Name.

All members of a System Administration group (dba) have SystemAdministration privileges. System administrators are allowed to performTeamcenter Engineering maintenance like upgrades and troubleshooting.

With the Security setting, administrators can choose whether this groupis subject to Internal or External project-level security rules. This field canalso leave this field blank, in which case project-level security rules are notapplied. These rules will be discussed in the Access Manager lesson.

Teamcenter Engineering provides a special system group which is used forperforming specialized tasks in an overall administration strategy. Currently,members of the system group are primarily responsible for archiving andrestoring objects. Although any Teamcenter Engineering user can mark anobject for archive or restore, only members of the system group are allowed toperform the actual object archive and restore operations.

Do not delete the system group from the database under anycircumstances. Teamcenter Engineering will not function properlywithout this group.


User Organization

Creating a Sub-Group

There are two methods for creating Sub-Groups.

Method 1

One method is to identify an existing Parent Group when the Group iscreated for the first time (or edited thereafter). This is done by selecting theParent Group button in the Group creation dialog (as shown below) and thenchoosing the Parent Group from the list of existing Groups.


User Organization

Method 2

A second method for creating Sub-Groups is done in the Organization areaof the Organization application. First, select the Group you wish to be theParent Group (as shown below). Then choose the Add Sub-Group buttonthat appears at the bottom of the dialog. The Add Sub-Group option allowsyou to add an existing Group or create a new Group, which is then addedas a Sub-Group.


User Organization

Creating a Person

A Person is a Teamcenter Engineering object associated with a real-worldindividual. A person is an individual who contributes to the company andmay have more than one user account. Each Person Name must be unique.

To create a Person:

• Select Persons.

• Enter the appropriate person information (minimum of Lastname,Firstname in the Name field).

• Choose Create.

Double-clicking on Persons in the Organization dialog expands to show thePersons previously defined in Teamcenter Engineering. As you select eachperson, their corresponding information is displayed the Person fields. If thisis a new installation, only infodba is listed.

This E-mail definition is the one used if notification is necessary Workflow.


User Organization

Creating a User

To create a User:

• Select Users.

• Enter the appropriate user information.

• Choose Create.

If this is a new installation, infodba is the only user listed.

The Teamcenter Engineering implementation of user is completely separatefrom any OS user account.

Double-clicking on Users in the Organization dialog expands to show theUsers previously defined in Teamcenter Engineering. As you select each user,their corresponding information is displayed in the User fields. These fieldsare also used to modify user information.


User Organization

Manage Group Members

As your real-world organization evolves and changes, your TeamcenterEngineering virtual organization will also change. Implementing newprojects, promoting personnel, and restructuring your organization are allexamples of real-world events that would necessitate changes involving Groupmembers. This topic discusses the procedures for removing a Group memberfrom a Group/Role and changing the Role of a member within a Group.

Setting a Group Administrator

By checking the Group Administrator toggle a user is assigned the GroupAdministrator by a Database Administrator. This will give the user GroupAdministrator privileges discussed later in the Access Manager lesson.

Deactivating a Group Member

A user who is no longer in the organization or moves away from a particulargroup/role hierarchy, can be deactivated from that group/role combination.This disallows the deactivated group member from logging into the system asa member of the previously associated group/role, thus negating their abilityto access information related to the previously associated group/role.

Only an system administrator or a group administrator can change a groupmember’s status from active to inactive or vice versa.


User Organization

Passwords

When creating a user account and assigning a password, TeamcenterEngineering provides companies the ability to specify particular requirementsthat their passwords must meet. These password restrictions are controlledthrough preferences settings and take effect upon password creation.Existing passwords are not affected.

The following are examples of these preferences.

• Minimum Length required.

PASSWORD_minimum_characters=0

• Mixed case required.

PASSWORD_mixed_case_required=false

• Minimum number of alpha characters required.

PASSWORD_minimum_alpha=0

• Minimum number of numeric characters required.

PASSWORD_minimum_digits=0

• What non alphanumeric characters are considered acceptable specialcharacters.

PASSWORD_special_characters=#,*,%

• Minimum number of special characters required.

PASSWORD_minimum_special_chars=0


User Organization

Tips in Creating your Organization

Person Names

Consider creating all persons at your site using the following namingconvention:

<Last Name>, <First Name>, <Middle Initial>

This will allow alphabetic sorting of persons by last name.

Assign Default Volumes to Groups; Do Not Assign Them to Users

When creating new users, leave the Default Volume field blank. This willensure that project data files are stored in a central location (for example, thegroup volume). Otherwise, project data files will be stored in each user’svolume.

Create Groups Along Project Lines

It is recommended that you create your Teamcenter Engineering groupsalong project lines, not functional lines. This will greatly enhance group androle functionality, as well as make Teamcenter Engineering much easierto maintain.

Create Roles Along Functional Lines

It is recommended that you create your Teamcenter Engineering roles alongfunctional lines (for example, real-world job descriptions, skills and/orresponsibilities). This will allow users to move freely from project to projectsimply by adding them to the appropriate group.

User Must be in System Group for Archive/Restore

Most users will mark an object to be archived or restored. A few system userswill be designated to actually archive or restore objects. These users shouldbe added to the system group.

Best Practice

Typically System Administrators will want to create the necessary groupsand define appropriate roles within those groups before considering whichusers should be assigned to those roles (populating a group with members).


User Organization

Important Workflow Impact

Changing existing group and role names in the database can impact workflowfunctionality. Workflow jobs will not complete if the group and/or role namesare changed after they are started. Therefore, all workflow processes must bemodified to reflect any changes in group and/or role names or they will fail.Additionally, all current (i.e., started) EPM jobs affected by group and/orrole name changes must be terminated and new jobs must be started fromupdated procedure templates.

Important Policy with dba group and DBA role

A site policy should be in place that no one applies an ACL entry against thedba group or the DBA role. Nothing prevents users from removing access tothe dba group. If users remove access to the dba group, then the dba groupcannot fix anything (unless the Bypass option is turned on).


User Organization

Activity: Add a User to the dba Group

In this activity, you will interactively add yourself to the "dba" group.

Step 1: Enter the Organization application.

Start Teamcenter Engineering.

From the Application Manager section of the DefaultApplication window, choose Admin.

Choose Organization.

Login to Teamcenter Engineering as infodba. The passwordis infodba.

The Organization application displays.


User Organization

Step 2: Create a Person.

Double-click on Persons in the bottom section of theOrganization window.

The existing Persons are displayed (only infodba).

Using the format, Your Last Name, Your First Name, enteryour Person Name in the Name field.

Throughout the course, the name Green, Robert is usedin place of the user you are creating. You will be usingyour user name unless otherwise specified.

Choose Create.


User Organization

Step 3: Create a User.

Double-click on Users in the bottom section of the Organizationwindow and the Users are displayed.

Enter your Person Name (or use the icon to select your PersonName by double-clicking on it).

Enter your Teamcenter Engineering User ID (Provided by yourinstructor).

Enter your OS Name (Provided by your instructor).

Enter your Teamcenter Engineering Password This is onlyintended for use in this class. Previously created scripts expectthe username and password to be the same..

Select the Default Group icon.

In most cases, User ID, OS Name, and Password arethe same, but may be different if desired.


User Organization

The Default Groups dialog appears.

Double-click on the dba group.

Choose Create.

The new User is created.

A Default Volume was not specified, therefore, filescreated by this account, while in the dba group, will bewritten to the volume used by the dba group.

You have now added a second user to the dba group for DBAwork (in addition to infodba).


User Organization

Step 4: Exit Teamcenter Engineering.

Choose File→Exit.

Choose Yes to the "Is it OK to Exit?" question.

Step 5: Test the new account.

Start Teamcenter Engineering again.

In the Default Application window, choose the Adminapplication group.

Choose Organization.

Login to Teamcenter Engineering using your new User ID andPassword.

From this point on, you will no longer use the infodba accountto do Administrator tasks. You will use your new account.



User Organization

Activity: Interactively Create a Group and Role

In this activity, you will interactively create a group (standards), androle (Standards Engineer). You will also add your User to the newgroup with the new role and assume group administrator privilages.

Step 1: Verify that you are in the Organization application.

Step 2: Create a Role named Standards Engineer.

Select Roles (bottom section of Organization window).

Enter the following information:

Role: Standards Engineer

Description: <optional>

Choose Create.

The new role is created.


User Organization

Step 3: Create a standards group with the previously created role.

Double-click Groups in the bottom section of the Organizationapplication.

Enter standards (in lowercase) for Name.

Enter a Description <optional>.

Choose the Default Volume button.

Double-click on the pdm_vol listing.

Select the Standards Engineer role from the List of Defined

Roles, then choose .

The role is added to the List of Selected Roles.


User Organization

Choose Create.

The standards group is created.

Step 4: Add your User to the standards group.

Expand the standards group in the upper section of theOrganization application.

Select the role of Standards Engineer.

Choose the Add User button.

The Organization User Wizard dialog is displayed.

Make sure the Add existing user to the group/role button isselected, then choose Next.


User Organization

Select your User ID from the list of Existing Users and choose

to move the user to the Selected Users list.

Choose Finish.

Choose Yes to Do you want to add selected user(s)?

Choose OK to The user(s) have been successfully added! dialog.

Close the Organization User Wizard dialog.

Expand the Standards Engineer role under the standardsgroup to see your User ID listed.

Your database now has the standards group with you as a user.


User Organization

Step 5: Assume the responsibilities of Group Administrator for thestandards group.

Expand the standards group in the upper section of theOrganization application.

Expand the Standards Engineer role and select Green, Robert.

Select the Group Administrator button in Group MemberSettings.

Choose to save the change.



User Organization

Teamcenter Engineering VolumesTeamcenter Engineering employs FMS (File Management System) toprovide file storage, caching, distribution, and the access system to manageuploading and downloading file data between clients and volumes. It works inconjunction with TCFS (Teamcenter File Services), which provides a varietyof volume-related services.

Volumes are directories that are created and used by Teamcenter Engineeringto store files created while running integrated applications from TeamcenterEngineering. Volumes are also used to store other files created during aTeamcenter Engineering session. The database retains the information forthe volume location and the file name in the volume. Users cannot directlyaccess files in Teamcenter Engineering volumes but instead do so via aTeamcenter Engineering session.

When a user performs an action that causes Teamcenter Engineering tocreate a new file, the new file is created within a Teamcenter Engineeringvolume. This allows the database to control the file and ensure that it willbe there when it is needed.

Files in a Teamcenter Engineering volume are never modified, they arealways versioned. The distinction is that Teamcenter Engineering createsor deletes files but never modifies a file in place (i.e., saves changes to anexisting file).

A Teamcenter Engineering volume is an operating system directory controlledby Teamcenter Engineering. Volumes are used to store files that TeamcenterEngineering is managing. Teamcenter Engineering supports UNIX andWindows volumes in homogeneous and heterogeneous environments. ATeamcenter Engineering volume is controlled by one and only one database.Teamcenter Engineering volumes can be anywhere on the network.


User Organization

File Management System (FMS)

Teamcenter Engineering employs two file management systems:

• File Management System FMS

FMS downloads and uploads file data for the rich client, TeamcenterEngineering Visualization, and the thin client configured with TeamcenterVisualization. Multi-Site Collaboration also uses FMS servers to transferdata.

• Teamcenter File Services TCFS

The Teamcenter Engineering Organization application uses TCFS tocreate volumes and perform other administrative functions. TCFS alsosupports file access for NX and Teamcenter Visualization when you usethese products with Teamcenter Engineering.

FMS and TCFS are installed on Teamcenter Engineering server hosts usingthe Teamcenter Environment Manager installation program. The operatingsystem user running FMS must be the same operating system user runningTCFS.

For this class, access to this system level user account is not available,just as in a real-world deployment of Teamcenter Engineering thisaccount would be accessed by a systems manager. Creation of newvolumes must be coordinated with your systems managementpersonnel.

Volume Management

Sound volume management practices are an essential element of aTeamcenter Engineering administration strategy. Volume management isdesigned to be flexible in order to allow each administrator to determinewhere files will be stored.

Suggestions for volume management:

• Place the volumes on large centralized file servers and use one volume foreach team.

• Setup group access to volumes because this is easier to manage. Thisseems to be a popular strategy among Teamcenter Engineering sites.

• When a volume becomes full, it can either be moved to a larger disk orhave its write access revoked and create a new volume on another disk.


User Organization

Data Access

Access to volumes is not the same as and must not be confused withcontrolling access to objects. If Teamcenter Engineering determines that auser has Read access to an object (based on the Access Manager), that userwill be able to read the associated operating system file in the TeamcenterEngineering volume. If the same user has Write access to that object, the newversion of that file would be written to the current volume they access.

Volume Access

When a new file is created, its location is dependent upon how the user orgroup is defined.

When a user is defined, the administrator has the option of assigning them adefault volume. If assigned, a sub-directory for the user will be created underthe full path name for the volume. The sub-directory name is the user name.

When a group is defined, the system administrator has the option ofassigning it a default volume. If assigned, a sub-directory for the group willbe created under the full path name for the volume. The sub-directory nameis based on the group name.

If the default volume is assigned to the user, all files created by the user willbe written to the path name and volume sub-directory used by the user. Usingthis technique will produce files in multiple directories (one for each user).

If the default volume is assigned to the group, all files created by the userwill be written to the path name and volume sub-directory used by the group.Using this technique will produce all files in one group directory (even thoughthe files were created by different users).

Files will continue to be written to the default volume until the currentvolume is changed in one of the following ways:

• When the user changes their group with group volume access in use.• When the user changes their current volume to another volume in which

they have access.• If Teamcenter Engineering cannot read or write a file, an error will be

reported to the user.• Access to volumes must be granted to users or groups in order to allow

them to write files to Teamcenter Engineering volumes.• When a user is granted access to a Teamcenter Engineering volume,

a new sub-directory is created with that user’s name. The systemadministrator granting access to volumes must be logged into theTeamcenter Engineering dba group.


User Organization

Creating a Volume

To create a Volume:

• Select Volumes.

• Enter the appropriate volume information.

• Choose Create.

The Volume Name field is a unique and descriptive character string.

The Node Name field is the network node name that will physically containthe new volume.

The Path Name fields are the full UNIX and/or Windows path of the newvolume.

All but the last directory of the specified path name must already exist.Teamcenter Engineering will create the last directory of the path name,which coincides to the created volume. It is good practice to have the VolumeName and last directory of the specified path name be the same.

Teamcenter Engineering volumes and group names should be lowercase to accommodate some applications that load lower case filenames. Create the volume on the machine where the disk physicallyresides. It is very important that you choose a location that all userswill be able to access Teamcenter Engineering volumes in order toaccess Teamcenter Engineering files.


User Organization

Adding a New Volume to FMS

Although Application Administrators are able to create data volumes, FMS ismanaged by a system administration level account. This dictates the need fornew volume information to be manually added to the fmsmaster_fsc_id.xmlfile, which is read when the FMS services are started. When creating a newvolume, a Organization application user will receive a warning messagestating the new volume id and root path.

The line which displays the volume id definition may be selected and thencopied to the OS clipboard, using the CTRL-C keyboard command.

In an installation where the user account creating the volume is thesame as the account that owns the FMS services, the line may bepasted directly into the fmsmaster_fsc_id.xml file. More often, as isthe case in this classroom environment, the account that managesthe FMS services is not a general user account.

The process for adding a newly created volume to FMS control iscovered in the Teamcenter Engineering Installation course. A moredetailed explanation of the FMS system architecture and functionscan also be found in the Installation CD Help files.


User Organization

Fail-Safe Volume(s)

Each user will have a volume where files are written based on the user’scurrent group setting. If this volume should become full or some other reasonTeamcenter Engineering cannot write to the volume a No Access error willbe displayed.

To continue to save files, the User Settings dialog (Edit→UserSetting...→Session Settings), can be used to select a different volume (set upspecifically by the Administrator for temporary use). The failsafe_vol shownbelow is used temporarily by users as required.

When the original volume becomes available again, the user can reset thecurrent volume in the User Settings dialog. This will automatically be reseteach time the user logs into Teamcenter Engineering.


User Organization

Setting Volume Access

The Accessors area of the Volumes dialog allows you to Grant (or Revoke)group and user access to an Teamcenter Engineering volume.

The Grant button allows you to grant Write access to a selected user or group.Once the Grant button is selected, the appropriate Group can be chosen fromthe list.

When access is granted, a sub-directory is created in the volume for thatgroup. This directory will be used for the saved files.

Volume access can be revoked by first selecting a user or group and thechoosing the Revoke button.

The example shown above applies to a typical installation where eachgroup has a volume of their own.


User Organization

Monitoring Volume Disk Usage

Selecting a Volume from the Organization List tree displays the Volumefields. The fields are used to create and manage Volume definitions.

The Statistics area (in the center section of the Volume panel) displaysinformation about the disk (not the volume) that the volume resides on, suchas, size, disk space used, and percentage full.


User Organization

Activity: Interactively Create a Volume

In this activity, you will interactively create a volume.

Step 1: Create a Volume that will be used to demonstrate the process ofcreation and FMS

Double-click on Volumes in the bottom section of theOrganization application.

Select pdm_vol.

Modify the pdm_vol fields to reflect the following:

Volume Name: test_volNode Name: (same as pdm_vol node name)Machine Type: (same as pdm_vol Machine Type)Change end of Path Name from pdm_vol to test_vol.

Choose Create.

The new volume is created.


User Organization

Step 2: Note the FMS Configuration Information warning.

When you press Create, the system will respond with thewarning similar to the one shown below

In order to gain access to the volume, you must use thesystem account which owns the FMS processes to edit thefmsmaster_fsc_id.xml file with the line of information providedin the warning.

Select OK to close the warning.

All user accounts in this classroom do not have theprivileges necessary to edit the fmsmaster_fsc_id.xml file.This is typically a system administration function, sinceit may involve security, hardware and networking issues.Therefore, configuration of additional volumes must bea joint effort involving both system and application levelsupport.

Although we will not complete this process in the activity,the steps required to do so are listed at the end of thislesson for your reference.

If you ignore or forget the FMS Configuration Informationwarning, you will be reminded when you attempt to savedata to the new volume by this error message.


Choose File→Exit.

Choose Yes.



User Organization

Steps Required to Enable Volume Access through FMS

1. Open the fmsmaster_fsc_id.xml file in Wordpad.

2. Create a new volume id line with the information copied from the FMSConfiguration Information warning message.

3. Save the fmsmaster_fsc_id.xml file.

4. Choose Start→Settings→Control Panel. Open the AdministrativeTools window and select Services. Locate the Teamcenter FSC ServiceFSC_host_id service and Stop, then Restart the service.

5. The volume is now under FMS control.

If the Teamcenter FSC Service does not start, or starts and then stops,there is either a problem with the edit you made or the wrong useraccount was used to perform the edit.


User Organization

Creating Accounts with the make_user UtilityThe make_user (or make_user.exe) utility (IMAN_ROOT/bin) is a programthat allows you to create Teamcenter Engineering users, groups, persons,roles and volumes from the command line. You can use this utility to set upyour organization with accounts in the Teamcenter Engineering database.

The make_user utility can also be placed inside a shell script and used to setup an organization in Teamcenter Engineering quickly. The script can bemaintained for records and also used to set up additional databases withthe same organization, if necessary.

Furthermore, creating a simple shell script will allow you to maintain aseparate (disaster) backup copy of this information outside of TeamcenterEngineering. Because you can re-run make_user as often as necessary, manyTeamcenter Engineering administrators find that maintaining an up-to-datecopy of the make_user shell script is a fast way to completely restore thisinformation during installations.

Important concepts about the make_user utility:

• It can be run in batch mode.

• It can be run multiple times.

• It can be used to set defaults.

• It cannot be used to delete/remove Users, Roles, Persons, and otherorganization objects.

• It requires the Teamcenter Engineering environment to be set.


User Organization

The format for the command is:

IMAN_ROOT/bin/make_user -u=<user_id> -p=<password>-g=<group> [-user=<user_id>] [-group=<group_name>][-person=<person_name>] [-role=<role_name>][-volume=<volume_name>] [-node=<node_name>][-path=<path_name>] [-v] [-h]

Uses common command line arguments listedin the synopsis and the following other arguments:

-user=<user_id> New user that will be created.

-password=<password> Password for the new user.

-group=<group_name> Group that new user will be added to.

-person=<person_name> Person associated with the new user.

-role=<role_name> Role the new user will be assigned to.

-volume=<volume_name> New volume to be created.

-node=<node_name> Network node where the new volume will be located.

-path=<path_name> Full path where the new volume will be located.

-file=<file_name> After other arguments are processed; read file <file_name> tocreate users. Each record in the file contains:person|user|password|group|role|

If a password is not specified it will be the same as the user id. If you specifya user and group, the user will be made a member of that group. If you donot specify a person, a person will be created with the same name as thespecified user. If you specify a role as well a user and group, then the membercreated will be given that role.

If the -volume switch is specified, then all of the groups that are createdwill be granted access to the volume. If the specified group already existsand does not have a default volume, then the volume will be designated asthe group’s default volume.

The source code for the make_user utility is supplied with theTeamcenter Engineering product as the file make_user_main.cxx inIMAN_ROOT/sample/utilities. This code can be modified, compiledand linked to operate based on customer requirements.

Creating Volumes with the make_user utility still requires that theappropriate user account enables recognition of the new volumes asdescribed in the Activity: Interactively Create a Volume.


User Organization

The following examples demonstrate how you can use the make_user utilityin a variety of different situations.

1. Create a person and user and add them to a group with a specific role.make_user -person="Smith, John" -user=smith -group=design

-role=engineer -v

The first role specified when creating a group member (user with arole in a group) will be the default role for that group. This role willshow in the Workspace banner as the default role.

2. Assign a user to another group.make_user -v -user=smith -group=dba -role=DBA

This adds existing user smith to the group dba with the role DBA.

User IDs must be unique.

3. Create a volume as a default to a group.make_user -group=design -volume=design_vol -node=node1

-path=/user/volumes/design_vol


User Organization

Using the make_user utility in a Script

These commands can be placed in a script that can be run to create an entireorganization or a new project beginning to use Teamcenter Engineering.

Below is an example:

Make Users in Group(s) with Role(s)

IMAN_BIN/make_user -user=tracytr -person="Tracy, Stacy"-group=high_performance -role=Product_Engineer -v

IMAN_BIN/make_user -user=tracytr-group=corrective_action -role=Product_Engineer -v

In the case above, tracytr will have the high_performance default group. Alsotracytr will have the default roles:

Group Default Rolehigh_performance Product_Engineercorrective_action Product_Engineer

Put an infodba-like user in Tooling group with DBA role.

IMAN_BIN/make_user -user=green -group=tooling-role=DBA -v

Put additional user in dba group with DBA role.

IMAN_BIN/make_user -user=tracytr -group=dba-role=DBA -v

Put additional user in system group with DBA role.This is to allow these users to do Archive and Restore.

IMAN_BIN/make_user -user=green -group=system-role=DBA -v

Create Volume for Tooling Group.

IMAN_BIN/make_user -group=tooling -volume=tooling_vol-path="$ES_VOLS/tooling_vol" -node="$NFS_SERVER" -v


User Organization

Class Organization


User Organization

Activity: Create User, Group, Role using make_user

In this activity, you will use the make_user utility tocreate a single User, Group and Role for the organization.

Step 1: Create the user and related organizational data.

Open a command window with Teamcenter Engineeringenvironment set.

Enter the following command:

make_user -u=(your userid) -p=(your password) -g=dba-person="Smith, John" -user=smith -group=design-role=Engineer -v

Step 2: Review the results.

Log into Teamcenter Engineering and select the Organizationapplication.

From the Admin group, select the Organization application.

Login with your UserID.

Browse through the application expanding Groups, Roles,Users and Persons to view the results of the make_usercommand for John Smith.


Choose File→Exit.



User Organization

Activity: Create Organization using a script

In this activity, you will create Organization in the TeamcenterEngineering database using the make_user utility in a script.

Step 1: View/edit the make_user script.

Locate the mu.scr.bat file (mu.scr if on Unix) in theaa_class/make_user directory.

Open the mu.scr.bat file (mu.scr if on Unix) in a text editor.

If required, set the DBAUSER variable to your userID, asdescribed by your instructor.

Notice, that the make_user command is executed five times toassign new groups to the pdm_vol volume (previously created).

Also, notice that the make_user command is executed onlyonce to create all the remaining users in the database. This isbecause of the use of the –file argument, which accesses a textfile containing the user definitions.

Finally, notice that the make_user command is executedseveral times to assign your student userID to each group withthe role of DBA. This could have been done in the mu.txt file,but was included here to eliminate modifications to the mu.txtfile to add your userID.

Close and save the script file.

Step 2: View the file associate with the –file argument in the make_userscript.

Locate the mu.txt file in the aa_class/make_user directory.

Open the mu.txt file in a text editor.

Notice, the first section of the file creates the necessary usersin the database, along with assigning them to a group witha particular role.

Next, notice that the second section assigns the existinginfodba user to all groups with the role of DBA.

Finally, notice that the last section creates a new user accountcalled legacy and assigns it to all groups with the role of DBA.This account will be used in the activities for the part filesimport lesson.


User Organization

Close the file without saving.

Step 3: Use the script to create the organization.


Use the cd command to navigate to the aa_class directory

Type the following command: cd make_user

Type the following command: mu.scr.bat (mu.scr if on Unix)

Wait until the script completes to move on to the next step.

Step 4: Verify the additional organization objects.

Log back in to Teamcenter Engineering.

Choose the Admin group.

In the Admin group, choose Organization.

Login using your UserID.


User Organization

Expand Groups, Roles, Users, Persons, Volumes, etc. to viewthe organization created by the make_user script.

The Organization is now fully built in the database.


User Organization

Step 5: Assign the responsibilities of Group Administrator for the highperformance group.

Expand the high_performance group in the upper section ofthe Organization application.

Expand the Design Engineer role and select .

Select Group Administrator and Default Role in the GroupMember Settings.




User Organization

Optional Activity: Create Hierarchical Group Organization

In this activity, you will create a hierarchical group structure using acombination of the Organization application and the make_user utility.

Step 1: Create the Group/Role structure and one User using theOrganization application.

Using the top-down-wizard approach, create the followingorganization structure, assigned to the pdm_vol volume.

Close the Organization application (File→Close).

Step 2: Populate the suppliers organization with Users by using themake_user utility with the -file argument.

Open suppliers_users.txt (in the ...aa_class/make_userdirectory) in a text editor and review the file format.

Close the text editor.


Use the cd command to navigate to the aa_class directory.

Type the following command: cd make_user

Execute the following command:

make_user -u=(your userid) -p=(your password) -g=dba-file=suppliers_users.txt


User Organization

Log back in to the Admin/Organization application.

Observe the three users that were added to the suppliers grouporganization.



User Organization

SummaryIn this lesson you:

• Interactively created Persons, Users, Groups, and Roles

• Interactively created a Volume and reviewed the process of enabling FMScontrol.

• Used the make_user utility to create Persons, Users, Groups, Roles andVolumes


Lesson

3 Form Types and LOVs

Purpose

The purpose of this lesson is to prepare the Teamcenter Engineeringdatabase with Types for Forms and Lists of Values (LOVs).

Objectives


• Create Form Types

• Create Lists of Values (LOVs) including hierarchical LOVs


Form Types and LOVs

Form Types

Review of Forms

Forms are one of the various ways of storing information in TeamcenterEngineering. Generally, the information manipulated through forms is of asimilar format. Forms are specifically meant for handling small amounts ofinformation in a fixed format. Forms typically store their data in the Oracledatabase as opposed to a file on the volume.


Form Types and LOVs

End-User Form Creation

Forms are most often created by one or more of the following functions:

• File→New→Form – Used to create a stand-alone form object in acontainer (like a Folder) or a form associated with an existing Item orItem Revision object. End-users select the type of form they are creatingfrom the list of form types on the New Form dialog.

• File→New→Item – When an Item is created, at least two form objectsare also created; the Item Master and Item Revision Master. In additionto these forms, additional forms for the Item Revision object can beautomatically created if specified using the Action Rules section of theBusiness Modeler application.

• File→New→Change – When change objects are created, one to n numberof forms may be automatically created for the Change Revision object.How many forms and of what type, is setup using the Change Type sectionof the Type application.

• Via workflow handler – Form objects may be created automaticallyduring a workflow process by using the EPM-create-form action handler.Handlers for workflow process will be discussed later on in this course.


Form Types and LOVs

Creating Form Types

Form Types can be created or modified from the Admin application group,Type application.

The Form Type dialog is used to create a new form type.

The Form type name field is used to specify the form type name that willbe selected by the users. This type name is best used to reflect the generalpurpose of the form instances as they are created by the users.

The POM class field is used to save the form content data to a pre-definedClass established in the Teamcenter Engineering Persistent Object Model(POM) schema. The POM schema Class defines the list and style of attributesfor data stored with the form.

The Class definition table shows the attribute list for the displayed POMclass.


Form Types and LOVs

Attribute Types

Arrays Allows multiple Values

Character A single character ’A’, ’B’, ’Z’.

Date A date. The form will display a popup date selector.

Double Used to store a 8 byte decimal number from theranges 1.7E +/- 308

Float Used to store a 4 byte decimal number from theranges 3.4E +/- 38

Integer Used to store an integer number. No decimal places.In the ranges +/- 999999999.

Logical This is a boolean True or False datatype.

Short Used to store an integer number. No Decimal places.In the ranges +/- 9999.

String Used to store a string of ASCII characters with thelength specified at the time of creation.

Typed Reference Used to point only to the specified class ofEngineering data. This class is selected from apop-up POM browers at class definition time.

Untyped Reference Used to point to any class of Engineering data.

Note A string of unspecified length.


Form Types and LOVs

Using the Form Type Wizard

The Form Type Wizard will walk you through all the necessary steps tocreate a new Form Type including the creation of a new POM Schema Classfor storage of the form’s data.

Important Considerations:

• The Form Type name must be unique and different than the POM Classname. When the Form Definition Class is added to the Persistent ObjectModel (POM), a default Type is automatically created with the same nameas the Form Definition Class name.

• Creating a new Class is an important decision. Extending the TeamcenterEngineering POM schema by adding Classes can affect performance.Once a Class is instanced, it cannot be deleted.

• New Classes added to the POM schema cannot have spaces in theirnames. Also, the name for new POM schema Classes should be uniquein the current environment as well as for future possible additions madeduring base Teamcenter Engineering version upgrades. A commonapproach to naming Classes added to the POM schema is to begin thename with the initials of the company or the underscore (_) character.

• Names for attributes for POM schema Classes cannot contain spaces.

Automatic Form

An Automatic form is a form for which no custom User Interface (UI) hasbeen specifically developed. The base Portal UI code includes definition fordisplaying forms. The default display for an automatic form is similar to thestandard Portal Properties dialog.

All Form Types defined during this course will leverage the Automatic formconcept. The topic of creating custom UI for a new Form Type is beyondthe scope of this course as it requires understanding and usage of the JAVAprogramming language.


Form Types and LOVs

Activity: Automatic Form using Form Type Wizard

In this activity, you will create a new Form Type using theForm Type Wizard. An automatic form is a form for which nocustom user interface display definition (JAVA) has been defined.

Step 1: Create the Form Type.

Start the Admin/Type application.

Select Form Type in the Types tree.

Choose the icon.

The Form Type Wizard dialog appears.

Step 1 of the wizard is used to define the Form Type Nameand the name of the POM Schema Class that will store theform data.

Enter Change Description for the Form Type Name.

Enter TRChangeDescription (no spaces) for the Class Name.

Spaces cannot be used in POM Schema Class names.TR stands for Training. In actual practice you maywant to use your company initials or an underscorecharacter at the beginning of the Class name to ensureuniqueness.


Form Types and LOVs

Choose Next.

Step 2 of the wizard is used to define the list of attributes forthe POM Schema Class (TRChangeDescription) associatedwith the Form Type.

In the initial row of the dialog, create the following:

Name: AuthorizingDocument

Type: String

Leave the remaining attribute parameters at their defaultvalues.

Choose to add another attribute row.

In the new row, create the following:

Name: ChangeReason

Type: String

Leave the remaining attribute parameters at their defaultvalues.

Continue to add attributes as shown below.

Remember, spaces cannot be used in attribute names.


Form Types and LOVs

Choose Next to continue.

Step 3 of the wizard asks if you want to create a display class.

Make sure this is set to No, then choose Next to continue.

Choosing No will skip to Step 5.

Choose Yes to create the form type.

Choose OK in the Form Type Created dialog.


Form Types and LOVs

Step 2: Verify the creation of the Form Type.

Expand the Form Type node of the Types list and locate thenew Form Type.

Select Change Description and verify the definition of theForm Type.

Step 3: Test the Form Type.

Go to the Teamcenter/My Navigator application.

Select your Home folder.


Form Types and LOVs

Choose File→New→Form...

Choose More... in the New Form dialog to display the list ofForm Types.

Select the Change Description form type.

Enter Change Description Test in the Name field, then chooseOK to create the form.

The new form object appears in the Home folder.


Form Types and LOVs

Viewing or editing the form can be done two different ways.

1. Select the form object, then select the Viewer tab.

2. Double-click the form object to access the form window.



Form Types and LOVs

Activity: Create Automatic Form using Form Type Wizard

Using the Form Type Wizard, create and test the Form Type described below.



Form Types and LOVs

Classes, Types and Properties

The Persistent Object Model

The following is an abbreviated view of the Teamcenter EngineeringPersistent Object Model (POM) Schema.


Form Types and LOVs

Key Definitions

The following terms are used to describe classes, types and properties.

Class A class is the definition of an object implemented in theTeamcenter Engineering data model. A class has a setof attributes, some of which are inherited from parentclasses and some of which are defined directly for theclass.

Attribute An attribute is a persistent piece of information thatcharacterizes all objects in the same class.

Type A type is the specialization of a Teamcenter Engineeringclass based on properties and behavior

Primary Type A primary type is a default ImanType that directlycorresponds to each POM class (i.e., the primary typename is the same as the POM class name). TeamcenterEngineering will automatically create the primary typewhen a new POM class is instantiated. The primary typecan also be defined by using the install_types utility.

Sub-Type Sub-types are all types except the primary type thatbelong to the same POM class. Sub-types inherit all theproperties and behavior of the primary type. Sub-typesmodel the actual objects that end-users create.

Property A property is a piece of information that characterizes allobjects of the same type. As a minimum, all Sub-typeshave properties that correspond to the attributes for theassociated class.

Before we can attach a List of Values (LOV) to one of the attributes, wemust make sure there is a corresponding primary type for the new classescreated while using the Form Type Wizard. If the new POM classes weren’tinstantiated, we will use the install_types utility to perform this task.


Form Types and LOVs

Optional Activity: Form Storage Class Types and Properties

In this activity, you will create the Primary Type and Properties thatcorrespond to the Classes and Attributes that were created earlierusing the Form Type Wizard. This must be done before we can attacha List of Values (LOV) to the display of an automatic form, but sincewe instanced the forms this activity is optional and unnecessary.

Step 1: Create the Primary Type (and Properties) for theTRChangeDescription Class.

This POM Schema Class will be associated with the ChangeDescription Form Type.

Exit Teamcenter Engineering.


In the command window, execute the following command:

install_types -u=infodba -p=infodba -g=dba -f=add-c=TRChangeDescription -t=TRChangeDescription


Form Types and LOVs

Step 2: Create the Primary Type (and Properties) for the TRChangeCostsClass.

This POM Schema Class will be associated with the Change CostsForm Type.


install_types -u=infodba -p=infodba -g=dba -f=add-c=TRChangeCosts -t=TRChangeCosts

Step 3: Regenerate the POM Schema file in the IMAN_DATA directory.

The Form Type Wizard during the previous activity actually didthis for us. The command shown below is how this step is manuallyperformed using the command line interface. If your site has twoIMAN_DATA directories (UNIX and Windows), you would have torun this command for the IMAN_DATA directory not affected bythe Form Type Wizard.


install -regen_schema_file infodba infodba dba



Form Types and LOVs

Lists of Values (LOV) for Form dataLists of Values (LOVs) are used to assist users with entering data into thesystem. Often, Teamcenter Engineering is expecting a particular kind of entryin a field as opposed to a user-defined text entry. In these situations, it makesa great deal of sense to assist users by implementing an LOV for these fields.

The default Teamcenter Engineering configuration already extensivelyimplements LOVs for the default Persistent Object Model (POM) schema.However, anytime you extend your POM schema by adding additional classesor attributes, there are potentially additional areas where LOVs can be usedat your site.

When you implement an LOV for a field, an LOV icon ( ) is displayed nextto that field as shown below:

The user simply clicks the LOV button and an object selection dialog isdisplayed that lists allowable entries for that field. Consider that a smallamount of effort setting up LOVs can greatly improve productivity at yoursite and prevent incorrect user data entries.

When you associate an LOV, you link this LOV to any field where that datacan be entered and display an LOV button to the user.

Value Types

There are six valid value types used to construct LOVs. Each LOV cancontain only one of these value types (i.e., value types cannot be mixed in thesame LOV). These value types are:

Integer Whole numberDouble Double-precision floating point decimal number (sometimes

called a "real")Char Single ASCII characterString String of ASCII charactersDate Date and time in the format used at your siteReference Reference to a list of unique tags in the database (for

example, Item ID)


Form Types and LOVs

Usage Types

Each LOV must also be assigned one of three usage types:

Exhaustive Used to define all allowable entries. If a user tries to entera value that is not contained in an exhaustive LOV, anerror will be displayed to the user.

Suggestive Used to provide a suggested list of allowable values. Forexample, a suggestion LOV could be used to list commonlyused description strings. Because Description fieldstypically accept any user-defined string, the user can selectone of the suggested description strings from the LOV orenter another user-defined string.

Range Used to provide the user with a constrained subset ofallowable entries. For example, a range LOV could be usedto construct a small consecutive list of serial numbers. If auser tries to enter a value that is not contained in rangeLOV, an error will be displayed to the user.


Form Types and LOVs

Activity: Create LOV for ChangeReason property

In this activity, you will create a List of Values (LOV) for theChangeReason Property of the Change Description Form.

Step 1: Log in to the List of Values application.

Start Teamcenter Engineering.

Choose the Admin application group.

Choose the List of Values application.

Enter your User ID and Password.

Step 2: Create the LOV.

Enter the following LOV parameters:

Name: TR Change ReasonDescription: ChangeReason on Change Description FormLOV Type: LisitOfValuesStringUsage: Exhaustive

Choose (on the far right) to add an entry line.


Form Types and LOVs

In the Value field, enter Product Improvement

Continue to add the following entries:

Marketing Request

Field Request

Cost Reduction

Safety

Engineering Error

If wanted, values can be moved up or down in the list byselecting the line and choosing the proper arrow.

Choose to create the LOV.

Step 3: Attach the LOV to the ChangeReason Property.

Notice, that after creating the LOV, it shows No Attachmentat the bottom of the window.

Choose No Attachment.


Form Types and LOVs

This window lists all the Teamcenter Types and theircorresponding Properties. Previously, you created two newTypes along their corresponding Properties.

Scroll down the list to locate TRChangeDescription.

Expand TRChangeDescription.

Select the ChangeReason Property, then choose .


Form Types and LOVs

The LOV is now attached to the ChangeReason property.

Choose OK.

Notice, that the LOV is now attached to the ChangeReasonproperty of the TRChangeDescription type.


Close the LOV application.

Step 4: Test the LOV usage.

Start the Teamcenter/My Navigator application.

In your Home folder, double-click on the Change DescriptionTest form you created earlier.


Form Types and LOVs

The Change Description Test form appears.

A drop-down selector should now appear in the ChangeReasonfield with the values from the LOV.

Choose Cancel to close the form.



Form Types and LOVs

Activity: Create Hierarchy of LOVs for ChargeCode property

In this activity, you will create a hierarchy of List of Values (LOVs)for the ChargeCode Property of the Change Description Form.

Step 1: Create the first level LOV.

Return to the Admin/List of Values application.


Name: TR Charge Code – L1Description: Level 1 ChargeCode Reason on Change

Description FormLOV Type: LisitOfValuesStringUsage: Exhaustive

Choose (on the far right) three times to add three lines.

In the Value fields, enter the following values.

A10

A20

A30


Form Types and LOVs


Step 2: Attach the LOV to the ChargeCode Property.

Notice, the LOV shows No Attachment at the bottom of thewindow.

Choose No Attachment.

Scroll down the list to locate TRChangeDescription.

Expand TRChangeDescription.

Select the ChargeCode Property, then choose .


Form Types and LOVs

Choose OK.

The LOV is now attached to the ChargeCode property.

Notice, that the LOV is now attached to the ChargeCodeproperty of the TRChangeDescription type.

Choose .

Step 3: Create the second level LOV.

Choose to clear current LOV information.


Name: TR Charge Code – L2

Description: Level 2 ChargeCode Reason on ChangeDescription Form

LOV Type: LisitOfValuesStringUsage: Exhaustive

Choose (on the far right) three times to add three lines.


Form Types and LOVs

In the Value fields, enter the following values.

B001

B002

B003


Step 4: Assign the hierarchy to the levels.

Select the TR Charge Code – L1 LOV in the LOV tree.

Select the Hierarchy tab.

The window should look like the following.

Select A10 in the list of L1 Charge Codes.

Choose Add Filter (on the far right).


Form Types and LOVs

Double-click TR Charge Code – L2 in the list.

Notice, that the L2 LOV has been added as a level below theL1 LOV.

Repeat the process until the A20 and A30 sub-levels have becreated.

When finished, choose .

Step 5: Test the hierarchical LOV.

Return to the Teamcenter/My Navigator application.

In your Home folder, double-click on the Change DescriptionTest form.


Form Types and LOVs

Notice, that the ChargeCode field now displays a differentLOV icon.

Select the new LOV and expand the first level options.

Options from the second level are selected by double-clicking.

Choose Cancel to close the form.



Form Types and LOVs


• Created Form Types

• Created Lists of Values (LOV) including hierarchical LOVs


Lesson

4 Item Data Types

Purpose

The purpose of this lesson is to prepare the Teamcenter Engineering databasewith Types for Items.

Objectives


• Create Item Types

• Create POM Schema Classes for Form Data

• Add Custom Attributes for Item Creation


Item Data Types

Item TypesItems are the fundamental object used to model data in TeamcenterEngineering. They are commonly used to identify an element of product(component, assembly, end-item) or other data such as ProcurementSpecification, Test Procedure, Standard Part, Shop Tooling, EngineeringChange, etc.

Data modeled using the Item object is generally revision controlled data andall revisions of the information must be maintained, tracked and recoverable.Data must also be modeled using the Teamcenter Engineering concept of Itemif it is desired to build structure of the Items as in building Bill of Material(BOM) for Items that represent product.

In the initial setup for Teamcenter Engineering, two Types of Items havebeen provided:

• Item – Generally used for data that represents an element of productthat is CAD defined and for which Product Structure (BOM) data ismaintained in the system.

• Document – Generally used for all other data that is considered revisioncontrolled but not necessarily considered product or is not defined usingCAD applications.

Basic Item Data Model

An Item in Teamcenter Engineering is a structure of related objects. Thebasic structure of any Item consist of the following minimum objects:

ItemItem Master (Form)ItemRevision

ItemRevision Master (Form)

• Item – Collects data that is globally applicable to all revisions of the Item.

• Item Master (Form) – A form object that is often used to extend the storedproperty data for an Item to include data unique to the customer.

• Item Revision – Collects data that is applicable to a single revision ofthe Item.

• ItemRevision Master (Form) – A form object that is often used to extendthe stored property data for an Item Revision to include data unique tothe customer.


Item Data Types

Extending Item Types

The Type application within the Portal Admin program group can be used todefine more Item Types in addition to those provided with base TeamcenterEngineering (Item and Document).

Reasons for extending the Types for Items:

• Having more types for Items may be a useful approach of categorizingdata making it easier for users to find data and understand the differencesbetween different kinds of data stored in the system.

• Different rules for naming convention, action rules and deep copy rules,etc., can be configured for one Type of Item compared to another Type.

• Default process model association for one Type of Item versus another iseasier to implement.

• Different designs for the Item Master and ItemRevision Master forms maybe desired. Each Type of Item can have unique and different "Master"form definitions.

In the example below, a new Type of Item (EndItem) has been defined so thatthe customer can define customer specific attribute data that TcEng willstore for this kind of data.

EndItemEndItem Master (Form)EndItem Revision

EndItem Revision Master (Form)

EndItem Master (Form) EndItem Revision Master (Form)


Item Data Types

Activity: Creating Item (and Master Form) Types

In this activity, you will create a new Item type andcorresponding Master Form types for the new Item Type.

Step 1: Start the Admin/Type application.

Step 2: Create the Item Type.

Select Item Type in the Types list.

Enter EndItem in the Item type name field.

Choose Create.

The new Item type is listed in the Item Type node of the Typeslist.

Step 3: Verify the creation of the Form types.

Expand the Form Type node of the Types list.

It may be necessary to select the Form Type node and refreshthe view for the new form Types to appear.

Locate the new EndItem Master and EndItem Revision MasterForm types.


Item Data Types

Select EndItem Master and observe the definition of the Formtype.

Initially, the EndItem Master Form type definition is identicalto the Item Master Form type definition. We will change this ina subsequent activity.

Select EndItem Revision Master and observe the definitionof the Form type.

Again, the EndItem Revision Master Form type definition isidentical to the ItemRevision Master Form type definition. Wewill change this in a subsequent activity.

Step 4: Close the Admin/Type Application.

In a subsequent activity, you will use the Schema Editorapplication to create new POM Schema Classes for theseForm types and then go back to the Admin/Typeapplication to modify the Form type definitions.



Item Data Types

Using Schema Editor to add POM Classes for FormsThe Schema Editor provides a graphical method of creating and viewing theTeamcenter Engineering POM schema. The display and interaction with thedatabase schema is a useful feature within a PDM system.

The TcEng Administrator will use Schema Editor to create, modify, and viewdatabase schema definitions and attributes.

You use the Application Manager to launch Schema Editor. To use SchemaEditor, you must have DBA status. Users without DBA status will have viewonly access upon launching Schema Editor.

The Schema Editor window is displayed on the next page. You can view thePOM schema definitions from it conveniently.

View Classes

The Schema Tree displays the POM class hierarchy in a tree style format.When you click on a class within the tree, the Class Attribute Tree willdisplay that class and its attributes.

You will also notice that some classes will have a plus sign (+) in front of it.This is indicating that there are sub-classes attached to that class. Click the+ and the list of sub-classes will expand.

View an Attribute

The Class Attribute Tree is similar to the Schema Tree. Its purpose is todisplay the class currently selected on the Schema tree and its attributes.

The icons contained within the Class Attribute Tree symbolize their type,therefore if an attribute is of the type String, then the icon for that attributewill be a string.


Item Data Types

Schema Editor Window

Create a Class

The TcEng Administrator uses Schema Editor and the Schema Editor Wizardto create new classes and attributes in the database. The new class andattributes will display in the Class Attribute Navigation Tree.

To create a new SubClass and attributes, select a POM class from the ClassNavigation Tree and choose Create Class.

The Schema Editor Wizard displays. Follow the steps to continue the createoperation.


Item Data Types

Delete a Class

Only those classes that are created or extended and have no objects created inthe database, un-referenced classes, and classes for which there are no objectspresent can be deleted from the database.

To delete a class, select a class from within the Class Navigation Tree andchoose Delete Class.

The system displays a message asking you to confirm this delete operation.Click Yes to complete the delete operation.

Schema Editor deletes the class and displays a confirmation message ifthe operation completed successfully. The class is removed from the ClassNavigation Tree. If the operation was not successful, an error message willdisplay.


Item Data Types

Activity: Classes for Forms Using the Schema Editor

In this activity, you will create new POM Schema Classes using the SchemaEditor application. You will create a new Class each for the EndItem Masterand EndItem Revision Master Form types you created in the previous activity.

Step 1: Start the Admin/Schema Editor application.

Step 2: Create the Classes for the form types.

Select POM_object in the Class tree.

Choose the Create Class icon.

This launches the Schema Editor Wizard dialog.

For Step 1, leave Create a Sub Class toggled on.

Choose Next.


Item Data Types

For Step 2, enter TREndItemMaster for Sub Class Name.

Spaces cannot be used in Class names.

Choose Next.

For Step 3, define the following Attributes for the Class. Unlessotherwise specified, leave the other parameters at their defaultvalues.

Name: CustomerType: String

Name: ShippedType: Logical

Type: PartTypeType: String

When finished defining attributes, choose Next.


Item Data Types

Select Yes to create another Sub class, then choose Next.

For Step 2, enter TREndItemRevMaster for Sub Class Name,then choose Next.

Ensure that you have entered the name correctly withRev.


Item Data Types

For Step 3, define the following Attributes for the Class.Unless otherwise specified, leave the other parameters at theirdefault values

Name: ContractType: String

Name: WeightType: Double

Name: DateWeighedType: Date

When finished defining attributes, choose Next.

For Step 4, choose No, then choose Next.


Item Data Types

To complete Step 4, choose Yes.

Choose OK.

For Step 5, choose No, then choose Finish.

Choose Close on the Schema Editor Wizard dialog.


Item Data Types

Browse the Class tree and verify the creation of the two classes.

Step 3: Modify the Form Type Definitions.

Go to the Admin/Type application.

Expand the Form Type node.

Select EndItem Master in the Form types list.

Change the POM class setting to TREndItemMaster.

Choose Modify.


Item Data Types

Select EndItem Revision Master in the Form types list.

Change the POM class setting to TREndItemRevMaster.

Choose Modify.

Close the Admin/Type application.

Step 4: Test the EndItem Item type usage.



Choose File→New→Item...

Choose Select Type to display the list of Item Types.


Item Data Types

Select EndItem from the list, then choose Next.

The Select Type dialog changes to the Enter Item Informationdialog.

Enter the following values:

ItemID: EI001Rev: 001

Name: EndItem Test

Choose Finish.

Choose Close on the New Item window.

Expand the Item and ItemRevision objects.


Item Data Types

View both Item Master and ItemRevision Master Forms byselecting them with the Viewer tab active or by double-clickingthem to activate the windows.

In a subsequent activity, you will use the Item Type Wizard tocustomize the New Item window so that end-users can provideMaster form values during the creation of new Items.



Item Data Types

Activity: LOV for Item Type Form

In this activity, you will create and attach two exhaustive LOVs for theCustomer and PartType fields of the EndItem Master form.

EndItem Master Form:

Before LOV:

After LOV:

You may want to refer to the Create LOV for ChangeReason propertyactivity in the previous lesson.


Item Data Types

Step 1: Create and Attach LOV for Customer Attribute using LOVApplication

Enter the values in the tables below as shown.

LOV parameters:

Name: TR CustomersLOV Type: ListOfValuesStringUsage: Exhaustive

Values: Customer ACustomer BCustomer CCustomer DCustomer E

Attached to: Customer property of TREndItemMaster type


Item Data Types

Step 2: Create and Attach LOV for PartType Attribute using LOVApplication

Name: TR PartTypeLOV Type: ListOfValuesStringUsage: Exhaustive

Values: MachiningCastingForgingPlasticCompositeUndecided

Attached to: PartType property of TREndItemMaster type



Item Data Types

Item Type WizardFollowing the definition of Item Types, and definition of their associatedMaster forms, the Item Type Wizard may be used to customize the NewItem dialog. The Item Type Wizard is used to add mandatory attributerequirements to the New Item dialog and add default values for optionalattributes.

The Wizard is used to identify a subset (or all) of the attributes from eitheror both the Master and Revision Master forms that should be consideredmandatory attributes.

ItemMaster Form Data ItemRevision Master Form Data


Item Data Types

Activity: Customizing the New Item Dialog

In this activity, you will use the Item Wizard to add mandatoryattributes and default values to the New Item dialog.


Step 2: Set up custom attributes using the Item Wizard.

Expand the Item Type node and select the EndItem type.

Select the icon.

This invokes the Custom Attributes Wizard.

For Step 1, leave Add an attribute selected.

Choose Next.


Item Data Types

For Step 2, define the following Custom Attributes:

When finished defining the attributes, choose Next.

For Step 3, choose Yes to Save the Custom Attributes.

Choose OK on the Add Custom Attribute(s) window.

You are returned to Step 1 of the Wizard,

Choose Close to terminate the Wizard.


Item Data Types

Step 3: Observe the stored definition of the Custom Attributes.


Choose .

Select General... from the query selector.

Clear all Fields.

Enter item types custom attributes in the Name field, then

execute the query.

Close the Search panel.

Expand the Item Types Custom Attributes folder in theGeneral...(1) tab.

Open the Item Type Custom Data Text dataset.

Review the contents of the file.

The Item Type Custom Data dataset stores the customattribute setup you performed using the Item Wizard in theType application. You had to find the folder (and dataset) sincethe folder is referenced by default in infodba’s Home folder.



Item Data Types

Step 4: Test the Setup.

Select your Home folder and choose File→New→Item...

Select EndItem for the Item Type, then choose Next.

Choose Assign to automatically assign the ItemID and Rev.

Enter Test for the Name.

Notice that all mandatory fields are now highlighted.

Choose Next.


Item Data Types

Fill out the Item Master Form by selecting Customer A fromthe pull-down menu.

Choose Next.

Fill out the Rev Master Form by entering 1234–5678 in theContract field.

Choose Finish to create the EndItem.

Close the New Item dialog.

Expand the newly created EndItem and EndItem Revision andopen the EndItem Master and EndItem Revision Master forms.

Review the information, then close the forms.



Item Data Types


• Created Item Types

• Created POM Classes for Form data

• Added attributes for the New Item dialog


Lesson

5 Dataset Types and ImportingNon-CAD Data

Purpose

The purpose of this lesson is to establish new Types for Dataset objects inyour Teamcenter Engineering database environment and to import non-CADfile data into the Teamcenter Engineering environment..

Objectives


• Create a new Dataset Type using the Dataset Type Wizard method

• Create or modify a Dataset Type using the standard method

• Create a new Dataset Type with the make_datasettype utility

• Import file data into Teamcenter Engineering using the Rich Clientinterface

• Import file data into Teamcenter Engineering using the import_filecommand line interface utility


Dataset Types and Importing Non-CAD Data

Dataset Objects

What is a Dataset?

Datasets are objects used to manage file data associated with externalsoftware applications. They typically consist of a single application data fileor logical groupings of application data files. There are numerous Types ofdatasets predefined in TcEng. However, your site may need to add moreTypes to be able to manage your site’s specific application data files and theviewing/editing software applications associated with these files.

What are Named References?

Named References are Teamcenter Engineering objects that relate to aspecific data file. A single dataset object may have one or more NamedReferences. To view the Named References of a Dataset from Rich Client,select the Dataset object and choose View→Named References... from theRich Client pull-down Menu area. Named References can also be viewed fromthe pop-up menu when using the right mouse button on a Dataset object.



Dataset Creation/Modification ProcessThe standard dataset creation/modification process (also referred to as theGeneric Shell process) is described as follows:

• When a new dataset is created, initially there are no Named Referencesfor the dataset or physical files stored on a Teamcenter Engineeringvolume.

When a Rich Client user Opens the new dataset, the following chain of eventstake place:

• If the user has write access to the dataset object, an implicit (automatic)check-out occurs. Thereby the user maintains exclusive write access tothe data during the modification session.

What happens next is not directly visible to the user:

• Teamcenter Engineering creates a temporary operating system (OS)directory in the %IPR%/temp directory. %IPR% is defined in the RichClient start-up script (portal.bat for Windows).

• Since initially there is no file associated with the dataset, TeamcenterEngineering will create a 0-size file and Export the file to the temporaryOS directory. The format of the file (binary/text) and the extension of thefile are as defined in the References part of the dataset type definition.

• Teamcenter Engineering executes the OS software application associatedwith the Dataset Types corresponding Teamcenter EngineeringTcEngTool definition and passes the file to the application as a Parameter.

What the user sees:

• The OS software application executes with the 0-size file loaded.

• The user modifies the file using the OS software application.

• When a modified file is saved (without terminating the application), themodified file is written back to the temporary OS directory overwriting theinitial Exported 0-sized file. Each save performed (without terminatingthe application) continues to overwrite the file in the temporary directorywithout updating the data file stored in Teamcenter Engineering.

• The user terminates the OS software application.



What happens next is not directly visible to the user:

• TcEng senses that the application process has terminated and checks thetemporary OS directory to see if the file it originally Exported there hasbeen changed or if new files have been added to the directory.

• If there are changed or new files, TcEng will Import these files back toTcEng and create the next Version of the dataset object.

• The implicit check-out on the dataset object is reversed (implicit check-in).

If the dataset is opened again, the same process is repeated with the exceptionthat the current file for the dataset is Exported instead of a 0-size file.



Creating Dataset Types and ToolsThere are three methods to create new Dataset Types and Tools inTeamcenter Engineering.

• The Wizard Method (GUI)

• The Standard Method (GUI)

• Using the make_datasettype command line interface utility

Regardless of the method used, the procedure to create a dataset type willrequire you to create or define the following:

Dataset type name - What you specify as the Dataset type name is what theend-user will see when choosing the Type from the New Dataset dialog. TheType name is also useful during searches and is used to specify a uniqueGUI icon for the Type.

Dataset type description - This is optional information you can provide todescribe the purpose or function of the Dataset type.

References - A Reference definition consists of the following:

• A default Reference name for each Reference associated with the datasettype

• Whether the Reference is a File or Object (e.g. Form)

• File template naming restrictions (e.g. *.txt, *.pdf)

• Format of the file (either TEXT or BINARY)

Tool - The term Tool describes a software application behaving in a specificmanner. The Teamcenter Engineering Tool definition relates to the OSapplication by specifying the MIME/Type definition for the softwareapplication on the workstation.

Parameters - When using the parameters dialogs you will identify thebehavior of Operations (Open, Open..., Print, etc.) by specifying which filesto export during an Operation and what Parameters to pass to the Toolduring the operation.



Activity: Dataset Type Using the Wizard

In this activity, you will define a new Dataset Type and Tool using theDataset Type Wizard.


Step 2: Create the new Dataset Type using the Wizard.

Select Dataset Type in the Types listing.

Choose the Wizard icon.

In the Dataset Types Wizard window, enter the following:

Name: WizTextDescription: <optional>File Template: *.txt

After entering the information, choose Next.

For Step 2, select Define a new tool, then choose Next.



For Step 3, provide the following Tool parameters:

Name: WizTextEditorDescription: <optional>Format: ASCIIMIME/Type: text/plain

After entering the information, choose Next.

For Step 4, choose Yes to define the Tool, create the DatasetType, add the Reference Type and add the Open Action.

The Dataset Type Created message appears.

Choose OK.



Expand the Dataset and Tool Types to see the additions.

Step 3: Test the new Dataset Type.


Select your Home folder, then choose File→New→Dataset...



Use the More... link to locate and select the WizText Type.

Enter test wiztext in the Name field.

Choose OK.

Double-click on the new dataset to open it in a text editor.

Enter some text.

Save the file and exit the text editor.

Open the dataset again to verify that the text you added tothe file was saved.




Activity: Creating Dataset Types Using the make_datasettype utility

In this activity, you will define a new DatasetType and Tool using the make_datasettype utility

Step 1: Create a PDF Dataset using the make_datasettype utility

Open pdf_datasettype.dat (in the ...aa_class/dataset_typesdirectory) in a text editor and review the file format.




Type the following command: cd dataset_types


make_datasettype -u=(your userid) -p=(your password) -g=dba-definition=pdf_datasettype.dat -v


Go to the Teamcenter/My Navigator application. .

Select your Home folder and choose File→New→Dataset.

Enter test pdf in the Name field

Use the More link to locate and select the PDF type.



Select to import a PDF file into the database.

Browse to the aa_class\dataset_types directory and select theNXCAM.pdf file to import.

Choose OK.

Double-click on the dataset to open it.

Close the pdf.




Activity: Creating Dataset Types Using the Standard Method

In this activity, you will define a new Dataset Type and Tool using theStandard (Non-Wizard) approach.

Step 1: Go to the Admin/Type application.

Step 2: Create the Tool.

Select Tool in the Types list.

Enter StdTextEditor for the Tool name.

In the Formats section, enter ASCII in the Input field, then

choose .

Enter ASCII in the Output field, then choose .

Enter text/plain in the MIME/Type field.



The window should look like the following:

Choose Create.

Verify StdTextEditor appears in the Tool listing.



Step 3: Create the Dataset Type and assign a Tool.

Select Dataset Type in the Types list.

Enter StdText in the Dataset type name field.

In the Tools panel, select StdTextEditor in the List of definedtools.

Choose to move the tool to the List of selected tools.


Choose Create.



Step 4: Define References for the Dataset Type.

Locate and select StdText in the Dataset list.

Choose References icon.

The References window appears.

Choose to define a Reference.

In the row that was added, enter/verify the followingparameters:

Reference: TextFile/Object: FileFile: *.txtFormat: TEXT




Choose OK.

Step 5: Define Parameters (and Operations) for the Dataset Type.

Choose Parameters in the window.

Select StdTextEditor in the Tools list.

Verify the Operations setting is Open.

In the References List, check the boxes for Select and Export.

In the Parameters List section, choose .

The row in the parameters list acts as a pull down box.

Double-click the row and select $Text from the list.

$Text is the Reference you defined during the previousstep of this activity.




Choose Create to finish defining the Open operationparameters.

Notice the addition of the Open operation to the StdTextEditortool in the Tools list. Although two listings for Open mayappear, only one will remain after closing the dialog.

Choose Close to close the Parameters dialog.



Select your Home folder and choose File→New→Dataset...



Use the More... link to locate and select the StdText type.

Enter test stdtext in the Name field.

Choose OK.

Double-click on the dataset to open it in a text editor.

Add some text.

Save the file and exit the text editor.

Open the dataset again to verify your edit to the file was indeedsaved.




Importing Non-CAD DataYou can use Teamcenter Engineering to manage information created in thenative environment. Importing data is the introduction of files or objects intoTeamcenter Engineering. When you import files, a dataset is created withnamed references to a copy of the original files located in an TeamcenterEngineering volume.

You may import files for these reasons:

• Import document/image data

• Migrating legacy data

• Placing data created outside of Teamcenter Engineering into the database

You can use both interactive and batch mechanisms to import data. Any ofthe following approaches are available to you for importing data:

• Interactive File Import for importing files

• The import_file utility for batch importing files

The ug_import utility, which will be discussed later, isrecommended for importing NX part files.

Key Points

• You can import more than one file into one dataset.

• You can use the Named References window to add additional files to thedataset after the initial import process.

• The import process will set User and Group ownership on the newlycreated dataset. Make sure you are in the correct group for appropriateownership.



Importing Files Interactively

You can use either of the following methods for interactively importing filesinto Teamcenter Engineering.

Create New Dataset and Import File at the same time

This interactive File Import method allows you to create a dataset and importthe file into it all at the same time.

Import File into an existing Dataset

This interactive File Import method allows you to import a file into a datasetthat currently resides in the Teamcenter Engineering database.



Activity: Create New Dataset and Import File

In this activity, you will interactively importan ASCII file into Teamcenter Engineering.

Step 1: Change your current group so that the dataset created during theimport will be owned by the standards group.

Start My Navigator application.

Choose Edit→User Setting....

Select Session.

Set the Group to standards.

Choose OK.

Step 2: Import the selected file into Teamcenter Engineering.

Select the Newstuff folder.

Choose File→New→Dataset...

The New Dataset dialog is displayed.

Enter Rubber Specs 1 in the Name field.

Change the Type to Text.

Select Import File.

The Import File window is displayed.



Navigate to the ...aa_class/import_file directory.

Select the rubber_specs.txt file, then choose Import (or simplydouble-click on rubber_specs.txt).

The Import File dialog disappears. Notice the rubber_specs.txtfile name in the New Dataset window. Also, notice that thedirectory path is listed in the Import field.

Choose OK.

This completes the Import process. The text dataset shouldnow be in your Newstuff folder.



Step 3: Review the imported file.

Expand the Newstuff folder.

If the new dataset is not visible, select the Newstufffolder and choose View→Refresh.

Open the Rubber Specs 1 dataset.

Review the file contents.

Exit the editor application without making any changes.

Step 4: Change back to the dba group.

Choose Edit→User Setting....

Make sure Session is selected.

Set the Group to dba.

Choose OK.

You have successfully imported the rubber_specs.txt file.




Activity: Import File into Existing Dataset

In this activity, you will interactively import a native file into an existingdataset in Teamcenter Engineering.

Step 1: First, create an empty dataset.

Select the Newstuff folder.


The New Dataset window is displayed.

Enter Rubber Specs 2 in the Name field.

Make sure Type is set to Text.

Choose OK.

The Text dataset is created in your Newstuff folder.

Step 2: Import the rubber_specs.txt file into the dataset.

Select the Rubber Specs 2 dataset.

Choose View→Named References...

The Named References dialog is displayed with a warning thatNo named references are found.

Choose OK to close the warning message window.

Select Import...

The Import File dialog is displayed.



Navigate to the aa_class/import_file directory.

Select the rubber_specs.txt file.

Choose the Import button.

The Import File window disappears and the rubber_specs.txtfile is now listed in the Named References window.

Choose Close.

Open the rubber_specs.txt file.

Review the file contents.





Importing Files Using the import_file Utility

The import_file utility allows you to import files into the TeamcenterEngineering database according to a set of user-specified arguments. Thesearguments supply user identification information and dataset informationto be associated with the imported file. The arguments may be specified onthe command line for a single file import or in a command file for multiplefiles (bulk) import.

Important Concepts

• This utility imports one file at a time into a dataset.

• You can subsequently add more files to a dataset.

• Use the import_file utility to import various files.

• The dataset is placed in the Newstuff folder.

• The import_file utility will set User and Group ownership on the newlycreated dataset.

In this case the import_file utility will be used to import a single ASCII textfile. The following arguments are necessary.

IMAN_ROOT/bin/import_file -u=user-id -p=password -g=group -f=file-name

-type=datasettype -d=dataset-name

-ref=named-reference

The following example demonstrates using the import_file utility:

1. To import a single operating system file report.dat into TeamcenterEngineering as Text dataset report1, enter the following command on asingle line:

IMAN_ROOT/bin/import_file -f=report.dat -type=Text-d=report1 -ref=Text -vb -log=import.log



Arguments

-u =<username> Specifies the user ID username. This is generallya user with administration privileges. If thisargument is used without a value, the operatingsystem user name is used.

-p=<password> Specifies the password password. If used withouta value, the system assumes a null value. If thisargument is not used, the system assumes theuser-name value to be the password.

-g=<group> Specifies the group groupassociated with theuser. If used without a value, the user’s defaultgroup is assumed.

-f=<filename> Import a single file filename into TeamcenterEngineering. The full path must be provided ifthe file does not reside in the current workingdirectory. The -f and -i arguments are mutuallyexclusive.

-i=<filename> Imports multiple files into TeamcenterEngineering using a specified import file thatcontains the following information:

-f=bike1.dat -d=my_bike1_dataset-type=UGPART -ref=UGPART

-f=bike2.dat -d=my_bike2_dataset-type=UGPART -ref=UGPART

The -f and -i arguments are mutually exclusive-vb Runs utility in verbose mode. Displays

maximum amount of information. Non-verbosesessions only display error messages.

-log=<filename> Log created datasets to <filename>. Otherwise-log=- can be used to print to your terminalwindow.

-log Creates a log of items and datasets created.-ref=names_reference Type of named reference associated with the file.

Each dataset type defines one or more NamedReferences associated with it.

-log=<filename> Log created datasets to <filename>. Otherwise-log=- can be used to print to your terminalwindow.



-type=<datasettype> Defines the dataset type in TeamcenterEngineering, for example, TEXT or UGPART

datasets.-d=<dataset_name> Dataset you are importing the file to.-de={n|e|a|r} Indicates that a dataset exists. Used when a

dataset of the same name already exists.=n Specifies that a new dataset be added even if one

with the same name exists. If it does exist, it isadded to the same item folder.

=e Specifies that the dataset should be added ifit already exists and that this dataset typesupports multiple instances of the same dataset.

=a Specifies that the imported file be added as anamed reference to the existing dataset. Whenthis is done, a new dataset version that containsthe additional imported named reference file iscreated.

=r Specifies that a new dataset revision be createdand referenced only to the imported file.

-item=<itemid> Specifies the ItemID of the item containing thedataset that references the imported file.

-revision=<item-rev-num> Specifies the item revision number and revisionID.

-ie={n|y} Specifies behavior if the item already exists.=n Specifies that the dataset will not be added if

the item already exists.=y Specifies that the dataset may be added if the

item already exists. If the item exists, butthe item revision does not, an item revision iscreated.

-desc=<string> Specifies a user-defined text description of anitem that is created by the import function. Ifthe import_file utility is creating a new revisionof an existing item, this is the description of theitem revision.

-v=<volume-name> Specifies the full path of the TeamcenterEngineering volume where the imported file isplaced.

To override the default object ownership, use the -u=<user>-p=<password> -g=<group> arguments. Make sure the file will beimported to the desired volume.



Activity: Import File using import_file Utility

In this activity, you will import other files into the Teamcenter Engineeringdatabase using the import_file utility.

To do this activity you will execute a pre-written script that contains theimport_file command. The import_file command used by the script is listed inthe activity.

Step 1: Import a file using the import_file utility

If necessary, locate and modify the import_file.scr.bat(import_file.scr on Unix) script per the instructor’s instructions

Open a terminal window with the Teamcenter Engineeringenvironment set.


Type: cd import_file

Type: import_file.scr.bat (import_file.scr on Unix)



The following command is used in the script to import theplastic_specs.txt file.

import_file -f=plastic_specs.txt -d="Plastic Specs"-type=Text -ref=Text -log=-

The -u=<user> -p=<password> -g=<group> argumentshave also been used to set the object group ownershipto standards (-group=standards).

Close the terminal window.

Step 2: Review the imported file.

Expand the Newstuff folder.

If the new dataset is not visible, select the Newstuff folder andchoose View→Refresh.

Double-click on the Plastic Specs dataset to view the file.

Review the file.


You have successfully imported the Plastic Specs file.





• Created a Dataset Type using the Dataset Type Wizard

• Created a Dataset Type using the Standard Method

• Created a Dataset Types Using the make_datasettype utility

• Imported file data into Teamcenter Engineering using the Rich Clientinterface

• Imported file data into Teamcenter Engineering using the import_filecommand line interface utility


Lesson

6 Product Structure Data Types

Purpose

The purpose of this lesson is to setup the Teamcenter Engineering databasewith Types that model Product Structure.

Objectives


• Create Item Unit of Measure Choices

• Create Specialized Note Types for Product Structure Occurrences

• Extend Types for PSView Objects


Product Structure Data Types

Units of MeasureBy default, Items have no Units of Measure (UOM). This implies that Itemquantities are expressed in terms of each or pieces. In other words they referto a discrete number of component parts. Additional Units of Measure may beneeded to define an accurate Bill of Material (BOM).

Units of Measure (UOMs) are created so that Items and Item Revisions canbe expressed in standardized units (e.g., inches, millimeters, etc.) across anentireTeamcenter Engineering site. When a user chooses the selector in theUnit of Measure field of either the New Item (Revision) or Properties dialogs,the user is restricted to entering one of the pre-defined values.

Choosing Unit of Measure from the Type application dialog displays theUnits of Measure fields.

The Symbol field is for the Unit of Measure symbol.

The Name field is for the Unit of Measure name.

In PSE, if no specific quantity value is associated with Items, thedefault quantity is each (one component).

In PSE, if UOM is anything other than <null>, the component willnot open in NX.



Units of Measure you will define in your system:

Units of MeasureSymbol Namein inchesoz ounces

The Symbol in will be used to specify linear quantity of certainmaterials in a BOM and the Symbol oz to specify the quantity ofcertain bulk materials.



Occurrence Note TypesOccurrence Note Types may be associated with an Occurrence in a PSE Billof Material (BOM). Users will then be able to specify a value for any NoteType that has been defined for the site.

The Occurrence Note Types that are defined will be listed in the PSEColumns, BOMLine Properties, and Notes Editor dialogs. The user can useany of these dialogs to enter a value for a particular occurrence.

Choosing Note from the Type application dialog displays the Note Type fields.

• Note type name – This field is for the Note Type name.

• Note description – This field is for the Note Type description.

• Attach Value List? – This is initially set to No. If toggled to Yes, the dialogwill change to allow you to define a list of values for the Note type.

• Default value: – This allows you to define a default value whether ornot a List of Values is used.

The initial list of Note Types shown are standard Note Typessupplied with the system that are required for TeamcenterManufacturing and for synchronizing object attributes from NX.These should not be deleted.



Note Types you will add to your system:

• SFCode – This Note Type is used to apply a three digit numeric finishcode in accordance with standard material processing requirementdocumentation.

Note type name SFCodeNote typedescription

Standard finishcode

Attach Value List? NoDefault Value <none>List of Values <none>

• ICode – This Note Type is used to apply a two character code to anoccurrence in the BOM to identify a condition where it is either "required"or "suggested" that the component not be modified during assemblyfabrication. IR is used to identify "Interchangeability Required" and IS isused to identify "Interchangeability Suggested"

Note type name ICode

Note typedescription

Interchangeabilitycode

Attach Value List? YesDefault Value IRList of Values IR

IS



Activity: Creating Units of Measure

In this activity, you will create various Units of Measure.


Step 2: Create two Units of Measure.

Select in the Types Tree.

The Unit of Measure fields appear.

For Symbol, enter: in

For Name, enter: inches

Choose Create.

For Symbol, enter: oz

For Name, enter: ounces

Choose Create.

The new Units of Measure have been created in the database.




Activity: Creating Occurrence Note Types

In this activity, you will create Note Types in your database.

Step 1: Create the SFCode Note Type.

Select in the Types tree.

The Note Type fields appear.

For Note type name, enter: SFCode

For Note description, enter: Standard finish code

Leave Attach Value List? set to No.

Choose Create.

Step 2: Create the ICode Note Type.

For Note type name, enter: ICode

For Note description, enter: Interchangeability code

Toggle Attach Value List? to Yes.

In the Value field, enter IR, then choose .

In the Value field, enter IS, then choose .

In the List of Values section, select IR.

Choose Set Default.

Notice that IR appears (greyed out) in the Default value field,just above the List of Values section.



Choose Create.

The new ICode and SFCode Note Types have been createdin your database.




PSView TypesA PSView type is a definition that controls the name of a PSView object. ThePSView object works with an Item and Item Revision to maintain productstructure information in Teamcenter Engineering.

Default View Type Named "view"

Choosing View Type from the Type application dialog displays the PSViewtype name field.

The default configuration is a single PSView type defined for the entire sitecalled view.

During the class, you will add two other PSView types.

This should be done before importing any parts (Items). Theps_rename_bvrs utility can be used to change any existing PSViewtype names.

Multiple View Types

Consider a site that has used PSE primarily for modeling engineering data. Iftransitioning to multiple PSViews, this site should consider renaming view tosomething that will be more meaningful in the context of multiple PSViewsand that will also appropriately describe the legacy product structure data.

In this case, engineering might be a good choice. This would allow anotherPSView such as shipping to be defined. From that point forward, differentgroups and users could use the most appropriate PSView to model their data.



Related Preferences

In the Edit→Options menu you may examine the default PSView type, whichis set for PSE with the PSE_default_view_type preference. Initially, thispreference is set to the following:

PSE_default_view_type=view

In the Edit→Options menu you may examine the default PSView type, whichis set for Unigraphics with the IMAN_UG_View_Type preference. Initially,this preference is set to the following:

IMAN_UG_View_Type=view

If you rename and/or add View Types, these preferences may need to bechanged to other values.



Activity: Creating PSView Types

In this activity, you will create two new PSView types.

PSView Types you will define:

PSView TypesPSView type

namePurpose

shipping represents shipping view ofproduct

engineering represents engineering view ofproduct

Step 1: Create a new PSView type for shipping.

In the PSView type name field, enter shipping.

Choose Create.

Step 2: Create a new PSView type for engineering.

In the PSView type name field, enter engineering.

Choose Create.





• Created Item Unit of Measures

• Created Occurrence Note Types

• Created PSView Types


Lesson

7 Creating and ModifyingPreferences

Purpose

The purpose of this lesson is to modify and create User, Role, Group and Sitepreferences. Command Suppression of menu options will also be covered.

Objectives


• Set Preferences for Users, Roles, Groups and Sites


Creating and Modifying Preferences

PreferencesPreferences are environment variables stored in the Teamcenter Engineeringdatabase and read whenever a preference value is set or modified. Preferencesallow you to configure many aspects of a session such as user login names andthe columns displayed by default in a properties table. Basic system behaviorsuch as business rules and security access are also determined by preferences.

Preferences are managed using the Options window (Edit→Options). Thiswindow is used to search for preferences, set preference values, create newpreferences, and remove existing preferences. Preferences can also bemanually modified in the tc_preferences.xml file, which is a file that is readautomatically during installation and upgrades.

It may be required to have different values for the same preferences fordifferent Groups, Roles or even Users. To accommodate this requirement,Teamcenter Engineering allows for preferences to be set to handle eachof these situations. The following list is shown in order of the precedencehierarchy used to resolve setting conflicts in multiple locations, with 1 beingthe highest.

1. User preference.

2. Role preference.

3. Group preference.

4. Site preference.

Preferences can also be imported or exported using the Options window(Edit→Options).



Important Preferences to ConsiderIMAN_config_rule_users – lists Teamcenter Engineering users that areallowed to create, delete, and modify preset configuration rules. It acceptsone or more strings as value(s); each string must be a valid TeamcenterEngineering user.

Preference(s): IMAN_config_rule_users

Default: unset

PSE_default_view_type – sets the default BOM view used when openingPSE or pasting in an assembly when more than one BOM view is used atthe site. This preference accepts a single string as a value; the string mustbe a valid BOM view type.

Preference(s): PSE_default_view_type

Default: view

AE_dataset_default_keep_limit – sets the number of old dataset versions tostore in database. When this number is exceeded, the oldest dataset versionis deleted if it is not referenced. This preference accepts a single integer asa value.

Preference(s): AE_dataset_default_keep_limit

Default: 3

IMAN_config_rule_name – sets default revision (configuration) rule that isused when opening and printing BOMView or BOMViewRevisions. Thispreference accepts one or more strings as value(s); each string must be a validrevision rule. If not set, Latest Working/Any Release Status is used.

Preference(s): IMAN_config_rule_name

Default: Latest Working

IMAN_auto_login – enables or suppresses auto-login feature for the entiresite. Auto login uses operating system user names and passwords to log intoTeamcenter Engineering.

Preference(s): IMAN_auto_login

PossibleValues:

TRUE (Enable auto login)

Default: FALSE (Disable auto login




Site Preferences

Site preferences are those preferences that are used across an entireTeamcenter Engineering site. Only those users who belong to a dba groupcan create or change Site preferences.

User Preferences

User preferences are those preferences that can be created and set onlyfor the individual user. A user preference takes the highest priority of thepreferences, overriding any Site, Group or Role preferences.

Group and Role Preferences

Group and Role preferences are those preferences that can be assigned to beused only by a particular group or role. Only those users who have beenassigned as the Group Administrator can create or modify group or rolepreferences. If a user is the Group Administrator, they will see the followingadditional (Scope) options when modifying or creating preferences.



Activity: Modify a Site Preference

In this activity, as a member of the dba group, you will modify existingSite preferences according to Product Structure View types created in theprevious lesson.

Step 1: Access the Modify the PSE_default_view_type preference.

Continue using your dba account.

Choose Edit→Options.

The Options window appears.

Choose Index (bottom left).

Notice that the Options window changes to show thePreferences fields.



In the Search on preferences name field, slowly enter PSE_.

Notice that as you type, the system is dynamically searchingfor preferences and displaying them in the Preferences list.

The window should now look like the following, which showsall the existing preferences that begin with PSE_.

Step 2: Modify the PSE_default_view_type preference.

Select the PSE_default_view_type preference from the listand see that the fields are populated with the settings for thePSE_default_view_type preference.



Notice the following key information.

1. The indication whether the preference is Site, User, Roleor Group.

2. The current value of the preference.

3. The Modify and Delete options.

Change the value from view to engineering.

Choose Modify.

Choose Cancel to close the Options window.

The PSE_default_view_type Site preference has nowbeen revised. Now, when creating BOMviews, allusers will default to the engineering view.




Activity: Create a User Preference

In this activity, as a regular user, you will create a User preference for thedefault view type, which will take precedence over the Site preference set inthe previous activity.

Step 1: Change to a user account.

Log out of Teamcenter Engineering and your dba account.

Log back into Teamcenter Engineering/My Navigator using theballtr account (password=balltr).

Notice that for the balltr account, the default group iscorrective_action and the default role is Planner.

Step 2: Validate the Site preference created in the previous activity.

Select the Home folder.

Choose File→New→Item.

In the New Item window, make sure Item is selected, thenchoose Next.

Enter the following:

ItemID = pref-1

Rev = A

Name = test

Choose Finish to create the Item, then Close the New Itemwindow.

Expand the pref-1 Item and select the ItemRevision.

Choose File→New→BOMView Revision.



Notice in the New BOMView Revision window, the default isset to engineering. This is because of the site preference thatwe set in the previous activity.

Choose Cancel to close the New BOMView Revision window.

Step 3: Create the user preference.


Choose Index.

In the Search on preferences name field, enter PSE_default.

Notice that since you entered more information this time, thereis only one preference showing in Preferences list.

Select PSE_default_view_type in the preference list.

Notice the value of engineering that was set by the dba accountand that this is still a Site preference.

With PSE_default_view_type still selected, choose CTRL-Cto copy the preference name.



Select New (bottom middle), click in the Name field and chooseCTRL-V to paste the preference name.

Make sure the Type is set to String and Multiple values is setto False.

Enter shipping in the Values field.

Choose Create, but do not close the Preferences window.

Step 4: View the results.

In the Preferences window, choose Details (next to the Newoption).


Notice that this time there are two preferences with the samename listed. One is the Site preference and one is the newlycreated User preference.

Select each of the preferences and notice the fields update toshow their values and the type of preference (Site or User).

Choose Cancel to close the Options/Preferences window.



Step 5: Validate the new User preference.

Log out and back into Teamcenter Engineering/My Navigatorusing the balltr account.



Notice that this time, the default is set to shipping. This isbecause of the user preference that now takes precedence overthe site preference that is set to engineering.





Activity: Create a Group Preference

In this activity, you will use the tracytr account to create a Group preferencefor the high_performance group.

Step 1: Review the tracytr user account setup.

The following is key information about the tracytr account.

1. The tracytr user is a member of the high_performance groupwith the role of Product Engineer.

2. The tracytr user is also a member of the corrective_actiongroup and also with the roles of Design Engineer and ProductEngineer.

3. The default group for tracytr is the high_performance group.

4. In the Organization lesson, tracytr was made the GroupAdministrator for the high_performance.

Step 2: Change to the tracytr account.

Log out and back into Teamcenter Engineering/My Navigatorusing the tracytr account.

Notice that the default group is high_performance and thedefault role is Product Engineer.

Choose Edit→User Setting.

Change role to Design Engineer.

Choose OK.

Step 3: Create a test Item and check the site settings.






Enter the following:

ItemID = pref-2

Rev = A

Name = test

Choose Finish to create the Item, then Close the New Itemwindow.



Notice in the New BOMView Revision window, the default isset to engineering. This is because of the site preference thatwas set previously.


Step 4: Create the group preference.


Choose Index.


Select PSE_default_view_type in the preference list.



Again, notice the default site preference value of engineering.

With PSE_default_view_type still selected, choose CTRL-Cto copy the preference name.

Select New (bottom middle), click in the Name field and chooseCTRL-V to paste the preference name.

Notice, that since tracytr, using the Design Engineer role, is aGroup Administrator, the Scope options are visible.

The User option is the default with the Site option not availablesince tracytr is not a member of a dba group.

Set the Scope to Group.

Make sure Type is set to String and Multiple values is set toFalse.

Enter shipping in the Values field.

Choose Create, but do not close the Preferences window.



Step 5: View the results.

In the Preferences window, choose Details (next to the Newoption).


Notice that this time there are two preferences with the samename listed. One is the Site preference and one is the newlycreated Group preference.

Select each of the preferences and notice the fields update toshow their values and the type of preference (Site or Group).

Choose Cancel to close the Options/Preferences window.

Step 6: Validate the new Group preference.

Log out and back into Teamcenter Engineering/My Navigatorusing the tracytr account.



Notice that this time, the default is set to shipping. This isbecause of the group preference that now takes precedenceover the site preference that is set to engineering.




Step 7: Validate that the new Group preference does not affect thecorrective_action group.

Choose Edit→User Setting.

Change the Group to corrective_action, then choose OK.

Select the pref-2/A ItemRevision.


Notice that the default is set back to the site preference valueof engineering.


Log out of Teamcenter Engineering.




The preference_manager utilityThe preferences_manager utility can be used to migrate preferences tothe database during new installs. It can also be used during upgrades toconvert legacy preference files to XML format. It can also be used to importand export preferences to and from the database. It checks if any of thegpfiles/rpfiles/upfiles directories exist in the IMAN_DATA directory and if somoves all the preferences in the preference file directories to the database.

The preferences_manager utility is location in TC_ROOT/bin.

preferences_manager -u=user-id -p=password -g=group

[-mode=import-file=file-name-scope=SITE|GROUP|ROLE|USER-action=SKIP|OVERRIDE|MERGE]

[-mode=import-preference=preference-name-scope=SITE|GROUP|ROLE|USER-values=comma-separated-values-action=SKIP|OVERRIDE|MERGE]

[-mode=export-out_file=output-file-name-file=file-containing-preferences]

[-mode=export-out_file=output-file-name-scope=SITE|GROUP|ROLE|USER]

[-mode=generatexml-file=legacy-file-name-scope=SITE|GROUP|ROLE|USER-out_file=output-file-name]

[-mode=remove-scope=SITE|GROUP|ROLE|USER-preferences=comma-separated-preference-names]

[-mode=clear -scope=SITE|GROUP|ROLE|USER]




• Set Preferences for Users, Roles, Groups and Sites


Lesson

8 Queries and Reports

Purpose

The purpose of this lesson is to set up the Teamcenter Engineering databasewith predefined queries and reports.

Objectives


• Create New Queries

• Manage End-User Access to Queries

• Import a Query

• Create Reports


Queries and Reports

Defining Saved QueriesOne of the most important features that any PDM solution can provide isthe ability to search the database for various kinds of product information.Generally, the more powerful and flexible the search capabilities, the easier itis for you to quickly find product information in the database.

Teamcenter Engineering searching functions are found using inthe My Navigator application.

The Teamcenter Engineering search feature is a flexible general-purposequery engine that allows you to search the database for many kinds of data.In order to enhance usability, the search feature allows queries to be saved asquery forms for future use.

In most cases, the Teamcenter Engineering administrator will createquery forms for the entire site.

In order to enhance usability, your site may want to limit the numberof query forms saved in the database and/or restrict the number ofusers allowed to create, modify and delete query forms.


Queries and Reports

Teamcenter Engineering Properties for Workspace Objects

In order to create Saved Queries, you must understand the TeamcenterEngineering database class structure and the attributes defined on each class.Since there are many classes in the database, each with many attributes, wewill begin with understanding the WorkspaceObject class.

The WorkspaceObject class defines the common attributes of all theworkspace objects: folder, form, dataset, Item, Item Revision.

Some other attributes for the WorkspaceObject class are inherited fromparent classes, but where these attributes are actually defined does notconcern us at this time.

Below is a diagram showing all the WorkspaceObject attributes.

The attributes withoutthe + symbol can bedirectly set when searchingfor WorkspaceObjects.

The attributes with the +symbol refer to another classin the class structure, whichmay have direct attributes ,or may have more attributeswith + symbols... this subjectis covered later in the lesson.

The Name and Type attributes are defined directly to the WorkspaceOjectclass. In a search that you will define in an activity, all workspace objectswith Name=Home and Type=Folder will be found.


Queries and Reports

Query Builder Dialog

The Admin/Query Builder application displays the Query Builder dialog. Thisdialog allows you to create, modify and delete queries.


Queries and Reports

Elements of the Query Builder Dialog

Element DescriptionName Name of the saved query that you selected from the

Saved Query.Description Text field where typically information about what

the query does or other pertinent information isrecorded.

Import Imports a query definition from a XML file.Export Exports a query definition to a XML file.Search Class icon You will click this icon to access the Class Selection

dialog. This dialog lists all of the schema classesthat are available. You must select a schema classwhen creating a query.

— —Query Types: This is a list of the various queries that come with

the installation.Local Query LQ — Query will be executed against the local

database.User Query UQ — Indicates a query that is run by calling

#USER_execute_saved_query that returns objectsfor display.

Key Search Query KSQ — Indicates a query that performs keywordsearches using a search engine.

Remote Query RQ — Query will be executed against the publishedobjects in the ODS.

User Exit Query UEQ — Indicates a query that is run by calling#USER_query_execute that returns column-valuetriples for display.

BOM Structure Query BOMSQ — Indicates a query that generates BOMreports.

eIntegrator Query eQ — Indicates a query that is created throughthe eIntegrator application that is run against anexternal database.


Queries and Reports

Element DescriptionAttribute SelectionTree

The attributes of the search class displays in theAttributes Selection tree. Depending on the typeof display setting selected, this tree can display allinherited class attributes or just the class attributes.

— —Display Settings: You will choose this icon to indicate how you want

queries to display in the window. The DisplaySetting dialog displays with two options.

Class Attributes Set Class Attributes to view only the class attributes.All Attributes Set All Attributes to view all of the attributes.

Display Names Set Display Names to display the presentation nameof the attribute.

Real Names Set Real Names to displays the actual attributename as it appears in the database.

— —Search Criteria Table Displays the search criteria that can be modified.Boolean Rules The Boolean Rules (AND/OR) are used to combine

clauses to create a custom query.Attributes The selected database attribute displays in the

Attributes field.User Entry L10N Key Specifies the localization key used to look up user

entry names. The localization keys-value pairs aredefined in the qry_user_entry_names_locale.xml file.The value in this column can be modified.

User Entry Name Displays the query field names as they appear aslabels in the search form. The user name is thevalue of the localization key entered in the UserEntry L10N Key column. If the key-value pair is notdefined in the qry_user_entry_names_locale.xml file,the user entry name is the same as the key enteredin the User Entry L10N Key column. The value inthis column cannot be modified.

Logical Operators Matching values can be: =, !=, <, >, IS_NULL, andIS_NOT_NULL

Default Values Required when you do not specify the User EntryL10N Key when creating a query.

Gain Precedence icon(up arrow)

Move search clauses up a row in the table to gainprecedence.

Lose Precedence icon(down arrow)

Moves search clauses down a row in the table to loseprecedence.


Queries and Reports

Activity: Create a Query that Finds Home Folders

In this activity, you will create a Query to find all the Home folders definedin the database. This is a useful query for Teamcenter EngineeringAdministrators.

The query will use the Folder class with the attributes Name and Type.

Step 1: Log into Teamcenter Engineering with your dba account.

Step 2: Begin creating the query.

Start the Admin/Query Builder application.

Enter Find Home Folders in the Name field.

Enter Find all Home folders in the database in the Descriptionfield.

Step 3: Choose the Query Search Class.

Choose the Search Class selector.

Type in the value Folder, then use Find to locate andselect the Folder class.

Close the Class/Attribute Selection Pop-up window ( ).


Queries and Reports

Step 4: Build the Name clause for the query.

Choose .

Set the Display Settings to All Attributes and Display Names.

Close the Display Settings window ( ).

In Attribute Selection area, double-click Name to add a linein the Search Criteria section.

Enter Home in the Default Value field, then press Enter.


Queries and Reports

Step 5: Build the Type clause and then save the query.

In the Attribute Selection area, double-click on Type to addanother line in the Search Criteria section.

Select Folder from the drop-down list in the Default Value field.

The completed query should look like the following. Noticethe AND conditional was used.

Choose Create to save the query.


Queries and Reports

Step 6: Test the query.


Choose .

From the pull-down menu on the Search panel, chooseRemaining→Find Home Folders.

The Search fields now show the Find Home Folders options.

Choose Execute Query.

The Find Home Folders (1) tab appears with the results.

Step 7: Add the Find Home Folders query to the Favorites List.

At the bottom of the Search panel, choose Options...

In the Favorite Options tab of the Options window, locate andcheck Find Home Folders.

Choose OK.


Queries and Reports

Step 8: Test the Favorites setting.

Choose View→Refresh Window.

Open the Query selector.

The Find Home Folders query should be on the initial list.



Queries and Reports

Query Access to Other UsersWhen a new Query is created, the default Rule tree will provide read accessfor all users to the query object. The Find Home Folders Query is very usefulfor administrators, but you may not want the query to be available to all users.

The Access... menu allows you to define protections on a query form.Selecting a query from the list and choosing the Access... menu displaysthe Protection dialog for the query.

The Access Control List can be used to modify the current access.


Queries and Reports

If you have Change access, the will be active and you can change thedefault access definition.

To revoke read access to the World, but maintain read accessfor the System Administrator accessor, use these two steps.

1. Add an object-based ACL to maintain read access for the SystemAdministrator accessor.

2. Add an object-based ACL to revoke read access for the world.


Queries and Reports

Activity: Modify Access of the Find Homes Query

In this activity, you will change the protections on the new query to makeit useable only by Administrators.

Step 1: Start the Admin/Query Builder application.

Step 2: Show the current ACL Entries on the new Query.

Put the cursor on Find Home Folders and right-click.

Choose Access... from the pop-up menu.

The Access dialog appears.


Queries and Reports

Choose Get access control list.

The Access Control List dialog for the Find Home Foldersquery is displayed.

Step 3: Modify the ACL Entries on the new Query.

Choose twice.

Notice the addition of two rows in the list with Object listed inthe Named ACL column.


Queries and Reports

Double-click in the empty cells in each line to set the Type ofAccessor to World and System Administrator, then set theprivileges for each Accessor as shown below.

The additional World setting revokes read privileges from allusers. The additional System Administrator setting allowsonly Administrators to use the query.

Choose OK on the ACL Control List window.

Choose Close to exit the Access window.

With these additional protections, the Find Home Foldersquery is only usable (and visible) by System Administrators.



Queries and Reports

Activity: Custom Item Type Query

In this activity, you will use the Query Builder application to create aspecialized query for finding Items of Type EndItem.

Step 1: Name and describe the query.

Go to the Admin/Query Builder application.

Choose Clear.

Enter the following parameters:

Name: EndItemDescription: Search for EndItems

Step 2: Choose the Query Search Class.

Choose .

Enter Item, then choose to locate and select the ItemClass.

Close the Class Selection Pop-up window.


Queries and Reports

Step 3: Build the Type clause for the query.

Set the to show All Attributes.

Close the Display Settings dialog.

In the Attribute Selection area, double-click on Type.

This will add a row to the Search Criteria area.

In the Search Criteria area, clear the User Entry L10N Key.

By leaving User Entry L10N Key blank, the Type clausewill be hidden from the end-user.


Queries and Reports

Choose EndItem in the Default Value field.

Your Search Criteria form should appear as shown below.

Step 4: Build the Part Number clause.

In the Attribute Selection area, double-click on ID.

Type Part Number in the User Entry L10N Key field, thenpress Enter.

Leave the Default Value field empty.

The end-user will provide the value for this clauseduring query execution.


Queries and Reports

Step 5: Build the Customer clause.

In the Attribute Selection area, double-click on Item Masters.

In the Class Selection Dialog, select Form inside the WorkspaceBranch.

In the Attribute Selection area, double—click on Attributes.


Queries and Reports

In the Class Selection Dialog, locate and selectTREndItemMaster.

Choose OK.

Back in the Attributes listings, in the expanded Item Masterslisting, expand the attributes node and double-click Customerto add the clause to the query.

Leave the Default Value field empty.


Queries and Reports

Step 6: Build the Shipped clause.

Again, in the Attribute Selection area, in the expanded ItemMasters listing, double-click Shipped to add the clause to thequery.

In the Default Value field, enter TRUE (all caps), then pressEnter.

The query should look like the following.

Step 7: Save the query.

Choose the Create icon to save the query.

Close the Admin/Query Builder application.

Step 8: Test the query.

Enter the Teamcenter/My Navigator application.

If necessary, choose .


Queries and Reports

Select the EndItem query from the Query selector list.

The EndItem query fields will appear.

Clear all Fields.

Execute the query.

The query should find all Items of Type EndItem that existin your database at this time.

Step 9: Put the EndItem query on your Favorites List.

At the bottom of the Search panel, choose Options...

Scroll down the Favorite Options list and check EndItem.

Choose OK.



Queries and Reports

Step 10: Test the Favorites setting.

Open the Query selector.

The EndItem query should be on the initial list.

Close the Search application by choosing the Search icon

Close all Search results tabs.



Queries and Reports

Importing/Exporting QueriesQuery definitions can be exported and shared with other TeamcenterEngineering sites. Conversely, query data from other Teamcenter Engineeringsites can be imported into your site. Exported queries must be saved as XMLfiles, with the .xml extension.

Importing a query definition is the most critical action. The XML files tobe imported are first parsed and verified before the data is allowed to beimported. Even if the query data is correctly formatted in the XML file, it maynot be compatible with the local database schema. An incompatible importfile will result in errors when you attempt to create the query definition.

The following are key icons used in the Import dialog.

Import file – used to locate the queryfile in the OS directory structure.

Verify – used to validate the POMclass matches existing classes in thedatabase before importing.


Queries and Reports

Activity: Import a query

In this activity, you will import a query that will be used in a later lesson. Thequery will be used to evaluate user input on the ItemRevision Master form.

Step 1: Begin the query import process.

Go to the Admin/Query Builder application.

If necessary, choose .

Step 2: Import a query.

Choose the Import button.

In the Import window, choose Import File.

In the Read Query Definition window, navigate to theworkflow_designer folder in the aa_class directory.

Select the user_data_3_equal_MAKE.xml file, then chooseImport.

The query is loaded into the Import window.


Queries and Reports

Choose Verify to validate the classes.

Since the query to be imported has POM classes that match theexisting classes in the database, no errors are reported.

Choose OK to import the query.

Choose Create.

The imported query is now displayed in the query list.



Queries and Reports

Creating ReportsOnce a Query is created, it can be used in the design of a Report. Thisis accomplished by using the Report Designer application in the Adminapplication group.

Report Design objects are templates, used by the Report Wizard in MyNavigator, that allow users to extract information from the TeamcenterEngineering database. Report designs consist of three components:

• Saved query definition object

• Property Format Finder (PFF) object

• Format file (optional)

Saved Query Definitions

Saved queries are used to search for the values of direct or reference attributesassociated with a class in the Teamcenter Engineering Persistent ObjectManager (POM) schema. Saved queries are used to construct report designs.

The query definition window can be accessed from Report Designer, allowingyou to modify or create definitions without leaving Report Designer.

Property Format Finder (PFF) Objects

Property Format Finder (PFF) objects allow you to gather and report datarelated to the objects returned by a query. PFF objects provide the necessarylinks and relationships required to locate data without reformatting the queryinstance. These objects also enable you to acquire additional information thata single query would be incapable of rendering.

Report Formatters

Microsoft Excel (.xlt) and Extensible Stylesheet Language (.xsl) files can beimported into and edited from within Report Designer. When generatingreports in My Navigator, users optionally select one of the files associatedwith the design to format the report data. If a format file is not selected, thedata is output as a comma-separated file.


Queries and Reports

The Report Designer window is divided into two main panes, the reportdesign tree pane and the report design definition pane.

There are four main functions that can be performed in the Report Designerapplication.

Launch query definition window.

Launch Property Format Finder (PFF) editor.

Import defined formatter.

Open formatter.


Queries and Reports

Activity: Create a Report using the EndItem query

In this activity, you will create a report using the EndItem query that wascreated previously.

As a reminder, the EndItem query allows you to find all EndItems with aparticular Part Number, Customer Name, and whether the Item has beenShipped or not.

Step 1: Begin the report creation process.

Start the Admin/Report Designer application.

Select the Report Designs folder.

Enter EndItem Report in the Design Name field.

Enter This report returns needed EndItem information in theDesign Description field.

From the Saved Query pull-down list, select EndItem.

At this point, the fields should look like the following.


Queries and Reports

Choose Query Definition.

This launches the Query Definition window, which is the sameas the Query Builder window. This shows the definitions forthe existing EndItem query.

Choose to close the Query Definition window.


Queries and Reports

Step 2: Access and arrange the Property Format Finder window.

Choose Property Format Finder.

The Property Format Finder window appears.

Dislodge the window by double-clicking on the top (grey) bar.

The window is now dislodged (top bar is blue) and will allowadjustments.


Queries and Reports

Stretch the window until all panels are easy to view.

Step 3: Create the EndItem report PFF.

Select the Admin - Object Ownership listing.

You will use this PFF as the basis for the EndItem PFF.

Enter EndItemPff in the Name field.

Change the Description to: This Pff defines what objectattributes are included for the EndItem report.

Leave Principle Query Object and Add Clauses From set toWorkspaceObject.

In the Search Criteria section, select theWorkspaceObject.object_type listing, and choose

.


Queries and Reports

Again, in the Search Criteria section, select the

WorkspaceObject.last_mod_date listing and choose .

The window should now look like the following, with only fivelistings in the Search Criteria section.

In the Property Selection panel, locate and double-click onObject.


Queries and Reports

A new listing appears at the bottom of the Search Criteriapanel.

In the Property Path column, changeWorkspaceObject.object_string to WorkspaceObject.item_id.

Change the Column Names field to EndItem.

Move this new listing to the top by using the up arrow.

Moving this new listing to the top will make it appearin the left column of the report.

The Search Criteria section should now look like the following.

Choose Create.


Queries and Reports

The new EndItem PFF appears in the list.

Close the Property Format Finder window.

Step 4: Assign the new PFF and Report Formatters.

The new EndItem PFF can now be displayed in the list for theProperty Finder Formatter field.

Choose EndItemPff from the pull-down list.

From the list of Defined Formatters, double-click ondefault_xml_template.xsl.

This sends it to the Selected Formatters panel.


Queries and Reports

The Report Designer window should now look like the following.

Choose Create.

The new EndItem Report appears in the list.

Step 5: Test the report.


Choose Tools→Reports.

The Report Creation Wizard appears.


Queries and Reports

Locate and select the EndItem Report from the list.

Choose Fill in Criteria (from list on the left).

If necessary, choose the More... link to show all the fields.

Clear all the fields.


Queries and Reports

Choose Select Format to list the available report (output)formats.

Choose Finish. (Do not select default_xml_template.xsl.)

The alert window displays the number of objects found.

Choose Yes to create the report.


Queries and Reports

The Report Dialog appears.

If the default_xml_template.xsl format file had been selectedbefore choosing Finish, and if an html viewer was available, thefollowing report would have been generated.

Close the Report Dialog.

Close the Report Designer application.



Queries and Reports


• Created New Saved Queries

• Managed End-User Access to Queries

• Imported Queries

• Created Reports


Lesson

9 Status Types and Revision Rules

Purpose

The purpose of this lesson is to set-up the Teamcenter Engineering databaseRelease Status types and Revision Rules.

Objectives


• Create Status Types

• Create Revision Rules


Status Types and Revision Rules

Status Types for Release Status

Review of Release Status

A Status Type (or Release Status) can be set on almost any TeamcenterEngineering data upon completion of a release. An object’s properties reflectthe status by name and the Release Status date. The dialogs below show datathat has been released to a Status Type named Released.

Release Status set on data

NX LoadOptions

Release Status utilized by Revision Rules

Revision Rules used by PSE



After parts have been released, the Product Structure Editor (PSE) canbe used to display different Bill of Materials (BOMs) in different stagesof development. PSE can also display Work-in-Process parts, which arethose that have not had a final Release Status applied. PSE (and the UGintegration) can load assemblies based on the Release Status list of StatusTypes.

Create the Status Type

Status Types are created from the Admin/Type application. You must be aSystem Administrator user to be able to create or modify Status Types.

Expanding the Status Type icon will display the current list of Status typesfor your site. To create a new Status Type, select the Status Type icon, Fill inthe Status Type name and choose the Create icon.

Status Types are created with a character Name value. The Name value isset to an object’s Release Status attribute when the object is released. Theactual names of the Status Types are arbitrary and in practice would bedefined by your company.



Status Types you will create during the training class

Name PurposeReleased Applied to Item Revisions that represent Part data that

have been approved for Production usage.Pre-Released Applied to Item Revisions that represent Part data that

have not been approved for Production usage but havebeen released to freeze the data. This status is typicallyused when preliminary data has been made available forsupplier usage.

Approved Applied to Item Revisions that represent Document data(i.e. Change Proposals, Product Specifications)

ECPending Applied to Item Revisions that represent Part data thathave progressed through the first step of an Change process.This status is renamed to Released at the end of the Changeprocess.



Activity: Create Status Types

In this activity, you will create four Status Types necessary for use in ReleaseProcess and Revision Rule definitions.


Step 2: Create a Status Type.

Double-click in the Types tree to expand the list.

Enter Released in the Status type name field.

Choose

The new Status Type displays in the Types tree.

Step 3: Repeat Step 2 to create the Pre-Released, Approved, andECPending Status Types.

When finished, the Status list should look like the following.

You now have more Status Types defined in the database.




Revision Rules ReviewA Revision Rule is a set of parameters that determine which revision of anItem is loaded into a particular PSE window or Unigraphics session. A presetRevision Rule is a named Revision Rule with various settings that has beendefined by a privileged user, and made available to certain other users.

Item Revision configuration selects which one of the revisions of an Item is tobe configured (i.e., meets the criteria in the Revision Rule).

Revision Configuration Terms

ImpreciseAssembly

A single-level assembly that has Items asthe components. The particular Revision isdetermined by the Revision Rule settings.

PreciseAssembly

A single-level assembly that has specific ItemRevisions as the components. It is also subjectto the Revision Rule, but the precisely specifiedItem Revision is configured by a Precise entryin a Revision Rule.

Revision Rule The parameters set by the User that determinewhich Revision of an Item is loaded into aparticular PSE window. A Revision Rule canalso be saved as a Workspace object for use inother applications.

Rule Entry A Revision Rule is made up of an orderedlist of Rule entries. Each type of Ruleentry is concerned with a particular type ofconfiguration.

Override List The User places Item Revisions in a Workspacefolder that is referenced from the Revision Ruleand used to override the revision that wouldnormally be loaded by the Revision Rule.

Release Status An attribute assigned to an object aftersuccessfully going through a release. ItemRevisions can be configured according to theirstatus. The status can optionally containeffectivity data for revision configuration.

WorkingRevision

A revision that can be freely changed by a Userwith write privileges. No record of intermediatestates of a working revision is maintained byTeamcenter Engineering.

The Revision Rule must always be set to determine which revision to load intoPSE. The variant and occurrence effectivity configuration rules are optional.



Revision Rules Provided with Teamcenter Engineering

Name DescriptionAny Status,No Working

Selects the latest released revisions, no working revisionsselected.

Any Status;Working

Selects the latest released revisions, if none exist, then selectworking revisions. This is useful when you want to configurea released structure, but want to be aware of items that willbecome used in the structure, but are not released yet.

LatestWorking

Selects Precise references if they exist, and for Impreciseassemblies, selects the latest working revisions, if noneexist, then latest released revisions.

Latest byAlpha RevOrder

Selects the latest revisions according to the revision id,sorted alphanumerical, regardless of whether they areworking or released.

Latest byCreation Date

Selects the latest revisions according to the date they werecreated, regardless of whether they are working or released.

Precise Only Selects the precise references to specific item revisions inPrecise assemblies.

Precise; AnyStatus

Selects the precise references to specific item revisions inPrecise assemblies. If Imprecise assemblies are present, thelatest revisions with any status are selected.

Precise;Working

Selects the precise references to specific item revisions inPrecise assemblies. If Imprecise assemblies are present,only working revisions are selected.

Working (CurrGroup); AnyStatus

Selects only the latest working revisions owned by theGroup the User running the Teamcenter Engineeringsession is currently logged into, if none exist, then select thelatest released revisions. This is a simple and powerful Ruleallowing users to configure only the working data withintheir team.

Working (CurrUser); AnyStatus

Selects only the latest working revisions owned by the Userrunning the Teamcenter Engineering session, if none exist,then select the latest released revisions. This is a simpleand powerful Rule allowing Users to configure only theirown working data.

Working; AnyStatus

Selects the latest working revisions, if none exist, thenselect the latest released revisions.

Revision Rules Added during the training class

Name DescriptionReleased Selects the latest revisions with Release Status of Released,

if none exist, then select the latest revisions with ReleaseStatus ofPre-Released, if non exist, then select the latestworking revision.



Revision Rules SetupRevision Rules are modified or created from the Engineering/PSE application.

Choose Tools→Revision Rules→Create/Edit... to create, modify, delete, andcopy Preset Revision Rules.

For a new database, this dialog is initially populated with the 11 RevisionRules shipped with Teamcenter Engineering.

Revision Rules window

Use Create to display the Create New Revision Rule dialog. Enter a Name,set the criteria required, and then select OK to see this new Revision Ruleadded to the list in the initial dialog. Note that Revision Rule Names must beunique.

Use Modify, which will display the same dialog as Create, but pre-populateit with the Revision Rule Name and the settings that correspond to theRule. These can then be modified as required. This also allows the name ofthe Rule to be changed.

Use Delete to remove a Revision Rule. This will then be removed from allusers who had access to it.



Creating Revision Rules

This Create New Revision Rules window allows users to create RevisionRules. Default Access Manager Rules shipped with Teamcenter Engineeringdefine who can Read and therefore use a Revision Rule after it has beencreated.

• If the Revision Rule is created by a member of the dba group, the RevisionRule will be selectable by all Teamcenter Engineering users (World)

• If the Revision Rule is created by any other user, only that user andSystem Administrators will be able to view/select the Rule.

Shown below is the Create New Revision Rule dialog.

• The upper section allows a name to be entered, which will be the namethe user will see.

• The middle section is the area where entries are ordered and possiblygrouped

• The lower section is where Rule entries are constructed and modified.



Revision Rule Entries

A Revision Rule is made up of a sequential list of entries. Evaluation of theRule involves evaluating each of the entries, in top-to-bottom order, until aconfigured revision of the Item is successfully obtained. Once a revision isfound that satisfies an entry, the evaluation of entries below that entry isstopped. A Revision Rule may be made with any combination of the followingentry types.

Working - A Working entry is used to select working Item Revisions (thosewithout any Release Status).

The latest Working Revision of the Item is selected according to the date itwas created. The revision chosen can be made more specific via the followingsettings:

• Owning User - If an Owning User is specified within a Working entry, thelatest revision owned by the specified User will be configured. The owningUser can be also set to current, meaning that latest revision owned by thecurrent Teamcenter Engineering User is configured.

• Owning Group - If an Owning Group is specified within a Working entry,the latest revision owned by the specified Group will be configured. TheOwning Group can be also set to current, meaning that latest revisionowned by the User’s current Teamcenter Engineering Group is configured.

More than one Working entry may be present within a RevisionRule. For example, a Rule might try to configure the currentUser’s working revision, and if none is found, then configure thecurrent group’s instead. If a User changes their Group, they willneed to re-apply the Revision Rule to configure the appropriaterevisions for the Group they have changed to.



Status - A Status entry is used to select Item Revisions that have beenreleased with a particular status. The following settings are available forStatus entries:

• Any Release Status - The latest Item Revision with status is configured,regardless of which status it is.

• Selected Status - The latest Item Revision with status of the selected typeis configured. Allows you to configure a structure that only contains ItemRevisions that have reached a specified Status. These are selected fromthe list of available statuses in the list menu.

More than one Status entry may be present in a Revision Rule.

• Release Date - The latest Item Revision is selected according to the datethe revision was released (the date that the particular status was added).

• Effective Date - The latest Item Revision is selected according toeffectivity dates defined on the Release Status.

• Effective Unit No. - The latest Item Revision is selected according to unitnumbers defined on the Release Status.

Effective Dates/Units are defined by privileged users usingView→Revision Effectivity... in the PSE application.

Override - An Override entry allows particular Item Revisions to overridethose that would be selected by the other criteria. The Item Revisions to beused are simply copied into a Workspace folder which you then reference fromthe Override entry (paste into the entry). You add an Override entry if youwant to create a Rule referencing an Override folder. Typically you will leavethe folder argument blank, which allows Users to set an Override folder atrun time, using the Tools→Revision Rule→Set Override folder... Command.

Date – A Date entry is used when you want to create a Revision Rule whichconfiures at a specific data or Today. This will prevent Users from setting adata (using Revision Rule→Set Date) to configure by at run-time. If youwant a Revision Rule which allows Users to set the date, then do not use aDate entry.

Unit Number – A Unit No entry is used to specify the Unit No to matchagainst when configuring Item Revision with status using Unit No Effectivity.This will prevent Users setting a unit number (using Revision Rule→Set UnitNo) to configure by at run-time. If you want a Revision Rule which allowsusers to set the unit number, then do not use a Unit No entry.



Precise - A Precise entry is used to select the precisely specified ItemRevisions in a Precise BOMView Revision. The entry has no effect onImprecise Bills. If you apply a Revision Rule without a Precise entry toPrecise structures, they will be dynamically configured - this can be verypowerful, but could also give unexpected results which may not be desired.

Any entry placed above the Precise entry in a Revision Rule will ineffect override the Precise references.

A Revision Rule containing only a Precise entry can be used to dopurely Precise configuration.

If you want to configure a structure that contains both Imprecise andPrecise assemblies, and you want to configure the precise referencesin the Precise assemblies, add a Precise entry at the top of yourRevision Rule. The other entries in the Rule will be used to configurethe Imprecise assemblies.

Latest - A Latest entry is used to select Item Revisions irrespective ofwhether they have been released. There is no differentiation betweenWorking revisions and those with status. The following settings are availablefor Latest entries:

• Creation Date - The latest Item Revision is selected according to the datethe revision was created.

• Alphanumeric Revision ID - The latest Item Revision is selected inalphabetic order of Revision ID. This will order numeric Revision IDsalphanumerical, (i.e., 1, 10, 2, etc.).

• Numeric Revision ID - The latest Item Revision is selected in numericorder of Revision ID. Revisions with non-numeric IDs will not beconfigured.

Ordering Rule Entries

The order of entries within a Revision Rule is very important. Thetop-to-bottom order defines a precedence that will affect the outcome of whatitem revision the Rule will configure. Entries at the top of the Rule takeprecedence over entries below. As soon as an entry is capable of configuringan item revision, the entries below are not evaluated.



Grouping Rule Entries

To give entries equal precedence, they may be grouped together with bracketsin the entry dialog.

For example, consider the Rule entries below:

Grouping these entries gives no precedence to item revisions with either ofthe defined statuses. The latest item revision with either of the statusesis configured.



Activity: Create Revision Rules

In this activity, you will create the Released Revision Rule.

Step 1: Start the Teamcenter/PSE application.

Step 2: Create a Released Revision Rule.

Choose Tools→Revision Rule→Create/Edit...

The Revision Rules dialog is shown with the default RevisionRule selected.

Select the Precise Only rule, then choose Create.

The Create New Revision Rule dialog appears with the settingsfor the Precise Only rule. This rule will be used as a startingpoint to create a new rule.

Change the name to Released.



In the middle panel, select the Precise listing.

Choose the Remove button, which is now activated.

Step 3: Add the Status entry for Released status.

Select Status from the Entry Type selector.

Choose Open by Name.

The Open by Name dialog appears.

Enter * in the Status Type field, then choose .

The Released Status Types that were created in an earlieractivity are displayed.

Double-click the Released status.

To add the entry, choose .

Step 4: Add the Status entry for Pre-Released status.

Choose Open by Name again.

Double-click the Pre-Released status.

Choose .



Step 5: Add the Working entry.

Select Working from the Entry Type selector.

To add the entry, choose .

The window should look like the following.



Step 6: Save the new Revision Rule.

Click the OK to save your Rule.

The Released Rule should now be viewable from the RevisionRules window.

Choose Close to dismiss the Revision Rules window.




Setup Considerations

Teamcenter Engineering is delivered with a base setup which allows theproduct to be used with the Revision Rule, Latest Working.

To use other Revision Rules, you may consider modifying the followingpreferences in the menu selection; Edit→Options→Index.

The preference below establishes the Revision Rule a user will have in effectby default. The default could be changed to a different Revision Rule forthe whole site, groups, roles or users.

IMAN_config_rule_name=Latest Working

The preference below defines the type of BOM (Precise/Imprecise) users willcreate by default from PSE and Unigraphics

IMAN_BOM_Precision_Preference=Imprecise



Activity: Verify Revision Rule Preference Settings

In this activity, you will verify Revision Rule preference settings.

Step 1: Select Edit→Optionsfrom the pull-down menu as shown. PressIndex on the Preferences form.

Step 2: Verify Default Revision Rule setting.

Enter the following preference name in the search field asshown to view the preference setting.

IMAN_config_rule_name=Latest Working

This sets the user Revision Rule to the shown value by default.



Step 3: Verify BOM Precision preference setting.

Enter the following preference name in the search field asshown to view the preference setting.

IMAN_BOM_Precision_Preference=Imprecise

This setting defaults all newly created BOMs to either Preciseor Imprecise (the default).

Press Cancel to close the Preferences form.





• Created Status Types

• Created Revision Rules


Lesson

10 Access Manager

Purpose

The purpose of this lesson is to establish unique data access requirementsusing the Teamcenter Engineering Access Manager application

Objectives


• Identify access permissions established with the default Access Manager

• Create additional Access Manager rules to define Company specific dataaccess Requirements

• Make an exception to the Access Manager rules for an individual object

• Save and restore Access Manager rule definitions


Access Manager

Teamcenter Engineering Data ProtectionsObject protection and ownership are extremely important in a distributedcomputing environment. Because objects represent actual productinformation in the database, they must be protected from unauthorized oraccidental access, modification and deletion.

Data protections are established with the database and not by the OS fileprotections. Teamcenter Engineering implements two different tiers of dataprotections:

• Rules-Based Protections

• Object-Based Protections

Rules-Based Protections

The Teamcenter Engineering system administrator defines various conditionsor rules that control who can or cannot access various objects. These rules areglobal (they affect your entire Teamcenter Engineering site) and are definedusing the Access Manager (AM) application.

As a User interacts with Teamcenter Engineering data, access is determinedby using the User’s Accessor information, the object’s Meta Data (properties),and some System information. This information is tested in the conditionalRule Tree which returns the access results.

This is a great advantage because, in most cases, end-users won’t have tothink about explicitly protecting data - it will be done automatically.


Access Manager

Object-Based Protections

Object based protection Access Control Lists (ACLs) can be set on objects tocreate exceptions to rules-based protection. Object ACLs are most usefulwhen you need to either grant wider access or limit access to a specific object.

With Object-Based protections, settings are added to and controlled by theobject to implement case-by-case exceptions to the access defined by theAccess Manager rule tree. After the object is created, Exception protectionsor Access Control Lists (ACLs) can be added to the object by anyonehaving Change (Key icon) access to the object after the object is created.


Access Manager

Viewing Data PrivilegesTo view access privileges for an object, select the

object, then choose View→Access... or .

The current protections for that object are displayed in the Access window.The initial protections are determined by the Rule Tree.

When necessary, the ACL button can be selected to show the specific AccessControl List (ACL) that has been derived from the Rule Tree.


Access Manager

Teamcenter Engineering Privileges

AccessPrivilege

Description

Read (R) You can open and view (read) an object.Write (W) You can modify (write changes to) an object.Delete (D) You can completely and permanently remove

(delete) an object from the database. Because this ispotentially destructive, delete privilege is usually onlygranted to the owner and Teamcenter Engineeringsystem administrators.

Change (C) You can modify (change) object protections. Anyaccessor with change privilege can grant themselvesany other privilege. Therefore, change privilege shouldbe tightly controlled. For example, you should notallow another group to have change privilege on yourgroup’s data.

Promote (p) You can move a task ahead (promote it) in a workflowjob.

Demote (d) You can move a task back (demote it) in a workflow job.Copy (c) You can print an object, perform a File→Save As on

an object and mark an object for archive.ChangeOwnership

You can change ownership on an object.

Publish You can make the object available to other TeamcenterEngineering sites.

Subscribe You can subscribe to an object.Export (X) You can export objects from your Teamcenter

Engineering database.Import (I) You can import objects into your Teamcenter

Engineering database.Transfer Out(x)

You can transfer ownership of objects exported fromyour database.

Transfer In (i) You can become the new owner of objects importedinto your Teamcenter Engineering database.

Write ICOs You can Write in-Class Instances


Access Manager

Activity: View Default Protections

In this activity you will create a new Item and view the default AccessManager defined privileges.

Step 1: Start the Engineering/My Navigator application.

Step 2: Change your Group/Role.

Choose Edit→User Setting...

Make sure Session is checked.

Change Group to high_performance and role to DBA.

Choose OK.

Step 3: Create an Item.


Choose File→New→Item...The New Item window is displayed.

Choose Item as the Type.

Choose Next, then enter the following:

Item ID 1234

Revision 000

Name Test ItemDescription (leave blank)


Access Manager

Choose Finish.

A reference to the new Item is placed in your Home folder.

Close the New Item window.

Step 4: Review the Protections of the new Item.

Select the 1234-Test Item.

Choose Access from the tool bar.

The Access window displays your access to the object.

Review privileges on the Item.

A greyed out icon means the privilege is denied.


Access Manager

Step 5: View the Access Control List (ACL) for the Item.

Choose in the Access window.

The complete Access Control List displays.

This window displays the complete Access Control List for the1234-Test Item. From this window, you can derive any user’sprivilege setting for this object.

For example, by locating the Write access column ,you can see that the Owning User and the Owning Group(high_performance) have been granted Write access ( ) tothe Item and that all other users (World) are denied Writeaccess ( ).

Choose Cancel on the ACL Control List window.

Close the Access window.



Access Manager

Setting Object Based Exception Privilege DataWhile the Rule Tree can be changed to affect protections for the entire site,object protections can be changed by a user on specific objects. To change anobject’s protections, select the object and choose View→Access...

You can also use from the tool bar.

The current protections (from the Rule Tree) for that object are displayed inthe Protection window for your user account.

The Access Control List opens another window to list full ACL and tomakes unique object based protection entries.

To change a specific object’s protections, select the ACL button at the bottomof the Protection window to display the Access Control List dialog. If youhave Change privilege, the Add/Delete ACL buttons will be active and youwill be able to Add or Delete an object-based ACE.

To set the exception protection, select and a new Access Control Entry(ACE) will be added to the list. By double-clicking in the cells of the ACE youcan define the Accessor Type, Accessor ID and grant/deny privileges.

Once added, the object-based ACEs will be identified by the name OBJECT inthe Named ACL column. If you have Change access, you will be able to Add,Modify, or Delete an object-based ACE.


Access Manager

Activity: Modify Single Object Protections

In this activity, you will define object specific Access Control List data toremove Write access from a single user.

Step 1: Check your ability to add object specific ACL data.


Choose from tool bar.

The Access dialog displays your access to the object.

Notice that you have privilege for the Item.

This privilege allows you to add entries to the default ACLdefined by the Access Manager rule tree. Any additions youmake in this manner will only apply to this object.

Step 2: Add the object specific Access Control List (ACL) data for the Item.



Access Manager


Because you have privilege, the is active.

From this dialog you can also identify what AM rule is givingyou the privilege. In this case the Working NamedACL has granted to the Owning User (you).

Choose on the Access Control List window.

A new line appears at the bottom of the list with Object listedin the Named ACL column.

Double-click the empty ACE cells to choose values for Type ofAccessor, ID of Accessor, and setting for Write privilege asshown in the highlighted line below.

Choose OK on the Access Control List window.



Access Manager

Step 3: Test the Object ACL

Select the 1234-Test Item, then choose .


Select Astaire, Fran(astairetr) from the User drop-down listing.

The Access window updates to display the Access for astairetr.

Notice that Write access is denied for astairetr. If not, re-selectthe Field Service Engineer Role to update the window.

Close on the Access window.



Access Manager

How Rules-Based Protections WorkThis section will explain how rules-based protections work by covering thefollowing topics:

• The AM Rule Tree

• Named ACLs and ACEs

• Pre-Defined Conditions (Rules)

• Accessor Precedence

• Building the Effective ACL

The AM Rule Tree

Choosing the Access Manager icon (shown on the left) from the Adminprogram group displays the AM Rule Tree window (shown on the right). Thiswindow displays all existing AM rules in force at your site in the form of a treein one window pane with named ACL definitions in the other window pane.

When rules-based protections are needed on an object (in choosingProtections, Opening, Copying, Exporting, etc.) the rule tree is evaluated.The rule tree evaluation starts from the top and works downward checkingconditions. When the conditions are met, the ACL(s) are applied. The nextpage shows the full default rule tree likely to be on your system.


Access Manager

The following is a section of the AM Rule Tree


Access Manager

The Named ACLs

The right side of the Access Manager application displays the Condition andValue being evaluated with the Named ACL to be applied.

There are numerous Predefined Named ACLs with the default AccessManager setup. By using the selector to choose a different Named ACL, youcan view/edit the other predefined Named ACLs


Access Manager

Access Rule Tree, Named ACLs, and ACEs

Shown below the Rule Tree and Named ACLs control what protections get seton objects when accessed by a user. The exact access is based on the objectand the user.

The Rule Tree showsthe conditions andthe Named ACLs

Below, the NamedACLs show thespecific ACEs


Access Manager

Pre-Defined Conditions (Rules)

Condition Value DescriptionHasAttribute

class:attribute=valueEg:NoteType:name=UG*

Object has the valuespecified for theattribute of the givenclass.

Has Bypass true or false User has bypass set.Has Class class name Object is of

this TeamcenterEngineering class.

HasDescription

text string acceptswildcards

Object has thisdescription.

Has FormAttributeHas Item ID item ID (accepts

wildcards)Has Name text string accepts

wildcardsObject has this name.

Has ObjectACL

true or false Object has an objectACL.

Has Status status name acceptsnull entry (null=all)

Object has this statustype attached.

Has Type type name Object is ofthis TeamcenterEngineering type.

Has ViewType

BOMView type name Object is associatedwith this BOM Viewtype.

In Job true or false Object is a targetobject in a workflowjob.

In Project project ID Object is a member ofthe defined project.

Is Archived true or false Object is archived.Is GA true or false User is a group

administrator in thecurrent group.


Access Manager

Is Local true or false Object resides inthis database. Usedwith DistributedTeamcenterEngineering.

Is ProjectMember

true or false User is a member ofthe project.

Is SA true or false User is currentlylogged in as amember of a systemadministrationgroup.

OwningGroup

group name Object is owned bythis group.

OwningGroup HasSecurity

security string Owning group of theobject has a givensecurity string.

Owning Site site name Object is owned bythis site. Used withGlobal TcEng.

Owning User user ID Object is owned bythis user.


Access Manager

ACL Buildup - Precedence

Evaluating which privileges are finally granted depends on two criteria:

• Precedence of the Conditional Statements in the Rule Tree

• Accessor Precedence in the Named ACL

The result is an Effective ACL, which controls the access to the object.

This Effective ACL is the cumulative buildup of all the Named ACLsappropriate to that object within the Rule Tree.

Precedence of Conditional Statements in the Rule Tree

Use the following steps to build an Effective ACL for an Object.

1. Remove from the Rule Tree all lines with rules that do not apply to theobject. This will usually leave you will only a few lines (rules) to evaluate.

2. The Effective ACL is now built up from those Named ACLs left in thetrimmed tree.

3. Order of traversal of lines (rules) is determined by:

• Always visit the children of a line before the line itself.

• Always visit sibling children in order from top to bottom.

4. Build up the Effective ACL by putting together the Named ACLs on thelines (in order of traversal).


Access Manager

Rule Tree Precedence Example

Accessor Precedence in the Named ACL

The following chart lists each accessor in order of precedence.

Most Precedence

Least Precedence

Approver (RIG)

Approver (Role)

Approver (Group)

Approver

Owning User

User

Group Administrator

Role in Owning Group

Role in Group

Role

Owning Group

System Administrator

Group

Project Team

Groups with Security

Project Teams

World

Site

Remote Site


Access Manager

Example: Building an Effective ACL for a UGMASTER dataset

1. Remove from the Rule Tree all lines with rules that do not apply to theobject.

Trimmed Rule Tree

2. .The Effective ACL is now built up from those Named ACLs left in thetrimmed tree.

3. Order the traversal of lines (rules).


Access Manager

4. Build up the Effective ACL by putting together the Named ACLs on thelines (in order of traversal).

The Effective ACL will be shown to the user as shown below. The shadedprivilege settings will not be seen. The Owning Group row will not be seensince there are no privileges set in the row.

The shaded privilege settings are not actually shown in the ACL window sincethey are already encompassed by a high preceding accessor. Said another way,the upper World accessor already includes all users, therefore the privilegesdefined in the upper World (W, C, c) have been set and do not have to beshown for the lower accessors of Owning User, Group Administrator, OwningGroup, System Administrator, and the lower World.


Access Manager

Evaluating the Effective ACL for the UGMASTER

Remove all the lines from the Effective ACL that do not apply to you.

Assume you are a Designer in the Owning Group of the UGMASTER dataset.You are not the Owning User, not generically in the Owning Group, and nota Group Administrator or System Administrator.

For each privilege work down through the remaining ACL lines until you hita Y or a N. This will tell you whether you are granted or denied the privilege.

Therefore you will have these privileges:

• Granted: Read, Write, Copy

• Denied: Delete, Change, Promote, Demote


Access Manager

Editing the Rule Tree

Guidelines and Recommendations

• Do not modify named ACLs referenced by rules on or within the "SystemObjects" branch. These rules are used for internal purposes and changescould result in unpredictable behavior or loss of data.

• Do not delete or change the order of the branches in the upper area of theRule tree. This could result in unpredictable behavior or loss of data.

• Add new rules for working data below the "Working" branch. This is theproper location to add new rules for working data types at your site.

• Named ACLs are optional. When adding a new rule, if you do not entera Named ACL you will create an inactive stub that can be furthercustomized by adding additional rules as sub-branches. Until you addadditional sub-branches or modify this rule to apply a Named ACL, it willhave no effect on object protections.

Browsing the AM Rule Tree

Only users with System Administration privileges can modify Access Managerrules. To browse the AM Rule tree, select the Teamcenter Engineering Adminbutton in the Applications Manager, and then select the Access Managerapplication. The AM Rule tree is displayed. To browse the AM Rule tree,select a Rule tree branch. When it is selected, the rule and its relevantinformation is displayed in the Access Manager Rule tree and Rule panel.


Access Manager

Adding an AM Rule to the Tree

1. Select the Parent rule that the new node will be added to.

2. Set the condition, value and named ACL for the new rule.

3. Choose Add.

This creates the new rule and adds it to the selected parent in the Rule tree.When the rule is added, an asterisk appears next to the Access Managername indicating the rule tree has been modified.

4. Choose to save the changes to the AM Rule Tree file.

Modifying an AM Rule

1. Select the desired rule to modify in the Rule tree.

2. Set the appropriate values within the Rule pane.

3. Choose Modify.

An asterisk appears next to the Access Manager nameindicating the rule tree has been modified.


Deleting an AM Rule

1. Select the desired rule to delete in the Rule tree.

2. Once the rule is selected, choose Delete.




Access Manager

Moving an AM Rule

1. Select the rule you want to move in the Rule tree.

2. Once the rule is selected:

Choose Move Up to move the rule up one level in the Rule tree.

Choose Move Down to move the rule down one level in the Rule tree.




Access Manager

Activity: Add Access Manager Rule

In this activity, you will use the Access Manager application to add aCompany specific Access rule.

Current Access

With the out-of-the-box Teamcenter Engineering Rule Tree, all objects of classPOM_application_object are granted Write access by the owning user and theowning group while they are considered working data.

Working data is generally defined as data not in-process or has not beenreleased (has a Release Status value). The following branch establishes thisin the Rule Tree.

(Has Class) POM_application_object—>Working

The class Item is a sub-class of POM_application_object, so we can deducethat Items are only modifiable by the Item’s owning user or owning group.

Desired Access

The process for modifying Items requires us to retain owning group Writeaccess to Items but, in addition, we need to allow the corrective_action groupthe ability to make revisions to Items to resolve manufacturing-relateddesign issues.

For example, the 1234-Test Item shown below was initially created by amember of the high_performance product definition group as part of a newproduct development (1234/000 Item Revision). The part is subsequentlybeing revised by a member of the corrective_action group to correct a designdeficiency in the manufacturing center (1234/001 Item Revision).


Access Manager

What needs to be done to the Rule Tree?

You may think that a change needs to be made to the Working ACL to addan Access Control Entry (ACE) that allows the corrective_action group Writeaccess, as shown below.

However, this would have the affect of allowing the corrective_action groupWrite access to all objects of class POM_application_object. This includes anydataset, folder, form, BOM, etc., created by any group!

This is obviously not desired.

Instead, we want to allow the corrective_action group Write access for Itemobjects only (not all objects defined by the POM_application_object class).

To enable this we must do two things:

• Create a new Named ACL that grants the corrective_action group Writeaccess.

• Modify the Rule Tree to attach this new Named ACL to the existing (HasClass) Item... branch.

Step 1: Change your Group/Role to dba/DBA.


Choose the Session listing.

Change your Group to dba and Role to DBA.

Choose OK.

Step 2: Start the Admin/Access Manager application.

Choose the Admin program group icon in the ApplicationManager.

Choose the icon.

The Access Manager editor screen appears with the rule treeand named ACL editor screen is displayed.


Access Manager

Step 3: Locate the Has Class(Item) rule tree branch.

Choose the symbol to expand the following branch.

The node expands and the Has Class(Item) branch is visible.

Step 4: Modify the Has Class(Item) rule tree branch.

Select the Has Class(Item) branch.

The branch editor screen displays the three parts of this branchdefinition: The Condition, the Value, and the Named ACL. Youwill now create and attach a new named ACL to this branch.


Access Manager

Enter CAMod in the ACL Name field.

Choose Create adjacent to that field.

Next, choose to the right of the ACL contents window toadd the first Access Control Entry (ACE).

Double-click the empty ACE cells to set the values for Type ofAccessor and ID of Accessor, then set the Write privilege (asshown in the following image).


Access Manager

Choose in Named ACL window to save the ACL.

Choose to modify the branch.

The new named ACL has been attached to the (Has Class)Item branch.

Step 5: Save the modification to the rule tree.

Choose on the Access Manager Tool bar.

The complete rule tree/named ACL definition has been writtento the Database and a Backup has been saved to an OS file inthe IMAN_DATA/am directory.

Step 6: Test the Rule Tree change.

Go to the Engineering/My Navigator Application.


Choose the tool bar



Access Manager

Step 7: View the Access Control List (ACL) for the Item.



You should see the complete Access Control List (ACL) forthe 1234-Test Item. Notice that the corrective_action groupaccessor is listed with the Write access privilege granted.

Also, notice that the CAMod ACL is listed above the WorkingACL. This is because the (Has Class) Item branch that appliesthe CAMod ACL takes precedence over the (Has Class)POM_application_object branch that applies the WorkingACL.

Choose Cancel on the Access Control List window.

Choose Close on the Access window.



Access Manager

Exporting and Importing the Rule Tree from a FileThe Access Manager Rule tree can be exported as an ASCII file to a directoryoutside of Teamcenter Engineering and, conversely, be imported back into theTeamcenter Engineering environment.

The export and import feature can be used for the purpose of archiving orsafeguarding a Rule tree prior to making extensive modifications (such as,adding or deleting branches, relocating branches, and so on). If, after manymodifications, it is found that the original Rule tree is desired, it can bereinstated.

This capability is also useful for copying the Access Manager rule definitionsfrom one Teamcenter Engineering site to another.

Rule tree edits from the Access Manager application are automatically savedin the IMAN_DATA/am directory in the exported file format when the userchooses the Save icon from the Access Manager application.

Guidelines and Recommendations

• Never modify rule tree files with a text editor. Although rule tree files aresimple ASCII files that can be read using any text editor, you must nevermodify them with a text editor. These files must conform to a particularformat and can be easily corrupted.

• In order to successfully load (read-in) a new Rule tree from a differentTeamcenter Engineering site, your site must have the same types, roles,and groups as those referenced in the Rule Tree file. If there is anyincompatibility, Teamcenter Engineering will immediately terminate theread operation (at the first discrepancy) and display an error message. Ifyou encounter schema compatibility problems when loading a Rule treefrom a file, open that Rule Tree file with a text editor. Either print the fileor make note of the types, roles, and groups referenced in that file. Then,define these exact types, roles, and groups for your site.


Access Manager

Exporting the Access Manager Rule TreeFrom the Access Manager application...

1. Choose File→Export...

A dialog is displayed.

2. Type in the filename for the rule tree being exported and choose adirectory path.

3. Choose Export.

A confirmation dialog appears indicating the export was successful.


Access Manager

Importing an Access Manager Rule TreeFrom the Access Manager application...

1. Choose File→Import...

A dialog is displayed.

2. Navigate and select the file to be used for the import.

3. Choose Import.

A confirmation dialog appears to indicate that the import was successful.


Access Manager

Activity: Reset the Rule Tree from a File

In this activity, you will reset your Access Manager Rule Tree to the initialdefinition.

Step 1: Locate the Rule Tree definition file.

Using a command window or graphical file navigator, listthe contents of your IMAN_DATA directory and notice theiman_am_rule_tree.default file.

Step 2: Reset the Rule Tree.

Start the Admin/Access Manager application.

Choose File→Import...

A file browser application displays.

Navigate to the IMAN_DATA directory.

Locate the iman_am_rule_tree.default file.

Select the file, then choose Import.

In a few seconds the Import AMRule Tree dialog appears.

Choose OK.

Step 3: Verify the Import.


Choose the symbol to expand the following branch and locatethe Has Class(Item) listing.


Access Manager

Notice the Has Class(Item) branch no longer contains theCAMod Named ACL.

The complete rule tree/named ACL definition has been writtento an OS file in the IMAN_DATA/am directory.

Step 4: Review the ACL for the Test Item in Navigator.

Go to the Engineering/My Navigator application.

Select the 1234-Test Item and choose .


Notice that the entry for the corrective_action group is nolonger present.

However, the object ACL for Fran Astaire is still present.Resetting the AM rule tree does not remove object-based ACLentries.

Choose Cancel on the ACL Control List window.

Choose Close on the Access window.



Access Manager


• Identified Access Permissions Established With the Default AccessManager

• Created Additional Access Manager Rules to Define Company SpecificData Access Requirements.

• Made an Exception to the Access Manager Rules for an Individual Object.

• Saved and Restored your Access Manager Rule Definitions.


Lesson

11 Project Creation, Administrationand Control

Purpose

The purpose of this session is to understand the functionality and use ofProjects as they apply to Teamcenter Engineering.

Objectives

Upon completion of this session, you will be able to:

• Establish Project Administrators

• Create Projects and assign team members

• Define security rules for Project data

• Add objects to an existing Project


Project Creation, Administration and Control

ProjectsProjects allow Teamcenter Engineering sites to control access to objects bymultiple organizations, such as project teams, development teams, suppliersand customers. Access is controlled on a project by project basis.

Project level security can provide an additional level of security while allowingnon-site employees access to objects in the Teamcenter Engineering database.

Projects are defined by Project Administrators in the Admin/Projectapplication. After Projects have been created, privileged team members needto assign Teamcenter Engineering data to the Project using My Navigator inthe Rich Client and the project functionality buttons in the Thin Client.

While Project is an administrative application, the specific group/role ofProject Administration/Project Administrator is required to create andmodify Projects and Project team members. A system administrator mustpopulate this group/role in Organization before users intended as Projectadministrators can log in to the Rich Client with this group/role and createProjects.

Project creation and administration is done in the following order.

1. A Project Administrator is added to the Project Administration group bythe Teamcenter Engineering administrator.

2. A Project is created with specific Groups, Users or Roles assigned asViewers or Privileged Users.

3. As database objects are created, they can be assigned to the Project byPrivileged Users.



The following table lists Project terms and definitions.

Concept DefinitionProject Basis for identifying a group of objects available

to multiple organizations (i.e., project teams,development teams, suppliers, and customers) fora particular piece of work.

Relationpropagationrules

Rules defining how secondary objects are managedbased upon its defined relation to the primaryobject.

Projectadministrator

Teamcenter Engineering user with privileges toadminister Projects using the Project application.Creates, modifies and deletes Project informationand team members.

Project teamadministrator

Project team member with privileges to modifyProject information and team members of Projectsto which he has been assigned.

Can assign privileged team members only toProjects to which he has been assigned as theProject team administrator. There can be only oneProject team administrator per Project.

Privilegedteam members

Project team members with privileges to assign orremove objects from Projects to which they havebeen assigned.

Team members Project team members with read privileges toobjects within Projects to which they have beenassigned.



Creating a Project

A Project is created or modified by performing the following steps:

• Creating or modifying the Project ID, Project name and description.

• Assigning team members.

• Defining security rules.

A Project administrator uses the top portion of the Project Definition panelto define the Project’s identification information and to make the Projectactive or inactive.

Selecting Project team members

A Project administrator uses the Member Selection portion of the ProjectDefinition panel to define the Project’s team members. Team members for aparticular Project can include; Project team administrator, Privileged teammembers, and (regular) Team members

Entire groups, individual users, and roles can be added as team membersof a Project. Users are first assigned as team members, with a projectteam administrator and privileged team members being selected from thelist of users assigned to the Project. A user with the group/role of ProjectAdministration/Project Administrator is automatically added as the teamadministrator.



Copying a Project

You can copy a Project, using the copy to be the basis of a new Project.Typically you will select a Project with settings similar to the Project youwant to create, modify the Project ID and the Project name, then changethe team member assignments and/or the security rules as required.

Setting Security Rules

The Project administrator can define project security rules for aparticular Project in the Project application using the AM Rule tab.

Assigning data to a Project

After a Project is created, the Project administrator, Project teamadministrator and privileged team members need to assign TeamcenterEngineering data to the Project. Objects are assigned to Projects byperforming the following steps:

• Assigning new or existing objects to a Project.

• Defining relation propagation rules.



Activity: Create a Project

In this activity, you will make your account a Project Administratorand then create a Project and assign users to that Project.

Step 1: Add your user to the Project Administration group.

Enter the Admin/Organization application.

In the Organization pane, expand the Project Administrationgroup.

Expand the Project Administrator role.

By default, the infodba user has been added to the ProjectAdministration group with a role of Project Administrator.

Select the Project Administrator role.

Choose Add User.



The Organization User Wizard dialog appears.

Choose Next to accept the default to Add existing user.

Locate your User ID in the list of Existing Users.

Select your User ID, then choose .

(Wayne, Joan is used as an example only.)

The user is added to the Selected Users list.

Choose Finish.

Choose Yes to add selected user.

Choose OK on the User(s) added message.

Close the Organization User Wizard window.

Your User ID now appears in the Project Administrators list.



Step 2: Create a Project

Enter the Admin/Project application (may have to chooseMore... to add it to the Application list).

The Project Definition panel appears.

Enter Project A in the ID field.

Enter Test Project in the Name field.

Step 3: Assign the project team members.

In the Organization Groups section of the Member Selectionpanel, expand the high_performance group.

In the high_performance group, expand the Design Engineerrole.



Select the davistr user, then choose .

The davistr user, in the role of Design Engineer, is added tothe Team.

In the high_performance group, expand the EngineeringManager role.

Select the waynetr user, then choose .

The waynetr user, in the role of Engineering Manager, is addedto the Team.

Select the standards group, then choose .



The standards group, is added to the Team.

Step 4: Assign a team administrator.

Choose Select a project team administrator from the bottom

right of the menu.

The Select a Team Administrator window appears.

Select davistr from the list, then choose OK.

Notice, that the Selected Members panel updates to show aPerson icon ( ) by davistr instead of an X. This indicates thatdavistr is now a Team Administrator.



Step 5: Assign privileged team members.

Choose Select privileged team members from the bottom right

of the menu.

The Select Privileged Team Members window appears.

Notice, that since davistr was added as the Team Administrator,davistr already appears in the Selected Team Members list.By default, your userid should also be listed are a PrivilegedTeam member.

Select waynetr from the list, then choose >.

The list of Selected Team Members now includes waynetr.

Choosing >> will move all team members to theSelected Team Members list.

Choose OK.



Notice, that the Selected Members panel updates to show acheck mark by waynetr instead of an X. This indicates thatwaynetr is now a privileged member.

Step 6: Save the Team settings.

Choose Create.

Project A is now displayed in the Project Tree panel.




Project Security

Setting Security Rules

The project administrator can define project security rules for a particularproject in the Project application using the AM Rule tab. The AM Rules tabdisplays the In Project security rule tree. Additional branches can be definedand added to the rule tree. The sub-tree under the In Project rule is the onlytree that can be modified by a project administrator.

Alternatively, a system administrator can define project security rules, orany other access rules, using the Access Manager application. Using thisapplication, a system administrator has full access to all the AM rules at yoursite. Using Access Manager, the system administrator can move the locationof the In Project rule within the site rule tree to meet the requirements atyour site. The system administrator can also change the order of child ruleswithin the In Project rule tree.

Default Security Rule

By default, the In Project ( )->Projects security rule is applied to all data inall projects. The Projects Named ACL provides project team members readprivilege to all data assigned to the project. Thus, there is no need to modifythe default ACL table for each new project unless the default security rule ofallowing all team member access does not meet your site’s requirements.



Activity: Setting Security Rules

In this activity, you will establish a security rule that grants Read access todata assigned to Project A to only members of Project A.

Step 1: Create the Access Rule.

Select the AM Rules tab.

Verify the Condition field is set to In Project.

Set the Value field to Project A.

Select the blank field from the pull-down list (on the right sideof the ACL Name field). This will set up the form to create anew Named ACL.

Type Project A in the ACL Name field.

Choose , to the right of the ACL Name field.

Choose to add a line, then define the following entry forthe World.



Choose again to add another line, and then define thefollowing entry for the Current Project Team.

The ID of Accessor field is automatically filled in withProject A-Test Project.

Choose to the right of the ACL Name field to save theNamed ACL.

Choose at the bottom of the panel to add the rule tothe AM tree.

The new rule is added to the AM tree.

Step 2: Save the Access Rule.

The asterisk in the application header indicates that the AM ruletree edit needs to be saved.

Choose on the main toolbar.

Once the AM rule tree is saved, the asterisk disappears..




Assigning Objects

Assigning Objects to a Project

New items, item revisions, and engineering change objects can be assigned toprojects during the creation process. All other workspace objects can only beassigned to projects after they are created.

Assigning New Objects to a Project

Privileged team members can assign items to a project during creation usingthe Assign to Project tab in the New Item, Revise Item and Save As Itemdialogs. The Projects for Selection field displays all the projects of whichthe user is a privileged team member. The team member selects one ormore projects to assign the item to and moves these projects to the SelectedProjects field.

Assigning Existing Objects to a Project

Privileged team members can assign existing objects to projects by selectingthe objects in the My Navigator object tree or Properties table and then usingthe Tools→Project→Assign menu function.

Removing Existing Objects from a Project

Privileged team members can remove existing objects from projects byselecting the objects in the My Navigator object tree or Properties table andthen using the Tools→Project→Remove menu function.



Relation Propagation Rules

Relation propagation rules are used to automate the addition of secondaryobjects to a project when related primary objects are assigned to projects.

• When a primary object (for example, an Item or Item Revision) is assignedto a project, the secondary attachment objects (for example, an ItemRevision Master, UGMASTER, DirectModel) may also be assigned ifspecified in the relation propagation rules.

• When a secondary attachment object is cut from the primary object, theattachment object is removed from the projects to which the primaryobject is assigned.

• When a secondary attachment is pasted to a primary object, thisattachment will be assigned to the projects of the primary object.

Relation propagation rules are defined using the Edit→Options→Projectdialog.

Relation propagation rules can only be defined by System Administrators andthey apply to the entire site.



Activity: Add objects to a Project

In this activity, you will create database objects and assign them to a Project.

Step 1: Log into Teamcenter Engineering as a Privileged Project teammember.


Log back into the Teamcenter/My Navigator application usingthe davistr account.

Choose Edit→User Setting... and make the selections shown.

Choose OK to close the form.



Step 2: Create a new Item object and assign it to Project A.

Select the Home folder, then choose File→New→Item...

In the New Item window, make sure Select Type is set to Item.

Choose Next.

Choose Assign.

Enter Project Part for the Item Name.

Select Assign to Projects from the list.

Select Project A-Test Project from the list of Projects forSelection.

Choose > to move Project A-Test Project to the list of SelectedProjects.

Choose Finish.

After the Item is created, Close the New Item window.



Step 3: Use the Properties window to verify that the newly created Item ispart of Project A.

Select the new Item.

Choose View→Properties.

The Properties window appears.

Scroll down until you see the Project IDs field and noticeProject A is listed. You may have to choose All to see all theproperties.

Choose Cancel to close the Properties window.

Step 4: Use Columns to verify the new Item is part of Project A.

In the Properties table, place the cursor in the Type columnheading, then press the right mouse button.

Select Insert column(s) ... from the Table Function Menupop-up.



The Insert Columns dialog appears.

Select Item, then choose Next.

The Insert Columns dialog changes.

Select Item again, then choose Next.

The Insert Columns dialog changes once again.



Locate and select Project IDs, then choose .

The Project IDs property is moved to the Selected listing.

Choose Finish.

Close the Insert Columns window.


Notice the Project IDs column has been added to the Propertiestable and now shows that the new Item is part of Project A.



Step 5: Verify the Security Rule.

Select the Item object you just created.

Select on the main toolbar.

The Access window appears.

Select on the Access window to look at the Access ControlList.

The ACL Control List window appears.

Observe the entries in the list.

Choose Cancel to close the ACL Control List window.


Log out of Teamcenter Engineering and log back in with yourstudent userID.





• Established Project Administrators

• Created Projects and assigned team members

• Defined security rules for Project data

• Added objects to an existing Project


Lesson

12 Workflow Process Modeling

Purpose

The purpose of this lesson is to build Teamcenter Engineering WorkflowProcess Templates.

Objectives


• Create Generic Workflow Process Templates.

• Add Handlers to Workflow Processes.

• Create Workflow Process Templates for Change Management.

• Import Process Templates

• Use Secure Tasks in Processes

• Use Resource Pools in Processes.

• Use Conditional Tasks in Processes

• Use the release_man Utility to add or remove Status


Workflow Process Modeling

Overview of Teamcenter Engineering WorkflowWorkflow stems from the concept that all work flows through one or moreprocesses in order to accomplish an objective. Workflow is the automation ofthose business processes. Using workflow, documents, information, and tasksare passed between participants during the completion of a particular process.

Enterprise Process Modeling (EPM) is used to model workflow processes,allocate resources, and manage data according to business rules. In otherwords, EPM is the software engine that Teamcenter Engineering uses toaccomplish workflow objectives.

The EPM module provides two applications used to accomplish Workflowobjectives:

• Workflow Designer – A graphical Workflow Designer application. SystemAdministrators use Workflow Designer to graphically create processtemplates which end users can then use to initiate Workflow processes.

• Workflow Viewer – Allows end users to view the progress of a Workflowprocess, even if they are not a participating member of that particularprocess.

A Workflow process uses defined tasks to automatically notify selected usersrequesting work signoff. The requests are tracked through an electronic InBox and each request maintains pointers to the data being approved. Theexact task must be defined based on current company procedures for datasignoff.

A Workflow process can have any number of tasks arranged in a serial orparallel progression. At the time of signoff, each Review Task will have a listof users allocated for signoff.



Review of the Teamcenter Engineering Process ModelA Process is made up of tasks. Some tasks may be sub-tasks associated witha main task.

For example, a main task may require a Design Engineer to review the dataassociated with a product change and give their approval. The first sub-taskwould be to select the specific Design Engineer associated with the project.When the work is automatically sent to that Design Engineer, the nextsub-task would be to view the data and perform the signoff (as shown below).

When tasks and sub-tasks are performed, the process advances to the nextset of tasks. After all the tasks have been completed, the release process ends.

Advantages of Using Release Processes

• Electronic distribution of tasks to defined users required for sign-off.

• Reduced engineering change cycle time thus reducing costs and improvingproduct development/change cycle time.

• Permanent record of all activities during an engineering change.

• Predefined processes that have to be followed.



Process Terms and FunctionalityProcess Templates are templates that define a Workflow process. A Processdefines a set of Tasks and a user profile (Group and Role) for each task. Theuser profile is an abstract and doesn’t correspond to a real Person in a process.

A Job is an instance of a Process. A new Job is created each time a Processis run. Jobs define the data required for that Job and assigns real Personsto perform Tasks according to their user profile.

An Approver is a user responsible for approving a task.

An Attachment is a Teamcenter object associated with a Process job.There are two kinds of attachments: target objects and reference objects.Attachments are always attached to the tasks of a Process job.

• A Target Object attachment is any Object (e.g., ItemRevision, Dataset)that will be released via a Process job. Typically, target objects areassigned a release status when the Process job completes.

• A Reference Object attachment is an object attached to a Process job thatallows you to provide information to the sign-off team. Reference Objectsare not released when the Process job completes, but are kept in the Jobobject for historical purposes.

Tasks are used to perform actions within a Job. When all Tasks defined for aJob are completed, the Job is complete.



Result of Releasing Data with a Process

Most common user interaction data like folders, forms, datasets,ItemRevisions, and BOMView revisions can be initiated and released with aProcess. Other data like distribution lists are less likely to be released.

When the data is initiated and released the following typically occurs.

• The Release Status and Date Released attributes will get values.

• The released data will become read only.

• Releasing flat objects (e.g. datasets, forms) will just release the object.

• Releasing a Folder will just release the Folder (not its contents).

• Releasing an ItemRevision will release the ItemRevision, BOMViewRevision, and all of the Specification relation objects.

The last feature is done through the use of a handler in the release proceduretemplate. You can remove or change the handler to get other desiredfunctionality. Other handlers (which will be discussed later) can be written tomeet specific requirements.



Two Usage Modes with Workflow

There are two different approaches to using Workflow:

• As a review and approve mechanism, or

• As a task controller for work in progress.

When Workflow is used as a review and approve tool, the user would createand complete the updates to any data (including parts), then start a reviewprocess on the data.

Alternately, Workflow can be used for data in work. As the process progresses,appropriate data would be updated or added to the process and approved.



Controlling the Workflow with Process Templates

Every Workflow is controlled by its process template. The process templatespecifies the following:

• Number of tasks in the process

• Groups, roles and approvers required to complete each task

• Protections and privileges of groups, roles and approvers

• Release Status set on released data

• Follow-up actions that may accompany or follow the release

Tasks in a process can be for anything an organization needs. The purpose ofa typical task could be for checking or editing a dataset, or simply reviewingmaterial before production. A task is usually named for what it is intended,such as Engineering Approval or Project Review.

Default Procedures for Groups based on Object Type

Groups can have default process templates for various types of data. Thisdefault can be overridden, if necessary, based on your site preferences.

For example, a Text document may use a process template having a two tasksign-off by the engineer and manager. In the same group, an ItemRevisionmay use a process template having three tasks of sign-off by engineers,drafters, manufacturing engineers, and managers. Another group could havedifferent defaults for these data types.



Creating Process TemplatesProcess Templates are created using the Workflow Designer application.



Process Definitions

A Process is the automation of a business procedure, describing the individualtasks and task sequences required to complete a business procedure.

A Process Template is a blueprint of a workflow process.

Tasks

Tasks are the fundamental building block used to construct a process. Eachtask defines a set of actions, rules, and resources used to accomplish that task.

• A Task Template is a blueprint of a workflow task.

• A Do Task is a task template which includes the EPM-hold handler, whichstops this task from automatically completing when the task is started.This template has a customized dialog which allows you to set a check boxto indicate when the task is complete.

• A Review Task is a task template which includes select-signoff-team andperform-signoffs subtasks. Each of these subtasks contain their owndialog for executing the respective processes.

• An Add Status Task is a task template which creates and adds a releasestatus to the target objects of the process. There is no dialog associatedwith this template.

Signoff related tasks

Select Signoff - allocates specific Users to perform the signoffswho meet the Group/Role criteria defined in the task template.

Perform Signoff - Allows a signoff team member to make one of threedecisions: Approve, Reject, No Decision. Comments can also be added tothe task.



Creating new Workflow Processes

Creating a Workflow Process is started from the Workflow DesignerApplication by choosing File→New Root Template.

You are then presented with the New Root Template dialog.

Once you enter a new process name and select the process template it will bebased on, you can begin to add the various tasks needed to define the process.



While creating or modifying a process, it has an Under Construction status,as indicated by the icon to the left of the listed process.

Whether exiting or entering the Workflow Designer application, the processwill remain in this state until it is made available for general use. This isdone when exiting the Workflow Designer application (File→Close), and youare asked to make the template available for all users. If you do not make itavailable for all users, it will stay in an under construction mode.



Modifying existing Workflow Processes

When modifying existing Workflow Processes, it is important how the processis accessed. To modify a process, enter the Workflow Designer and select theworkflow to be modified from the Process Template list. After choosing theEdit Mode icon, you have the option whether or not to take the process offline.

Choosing Yes, will take the template offline for modification. This is indicatedby the Construction icon next to the process in the templates list. In thismode, all modification are saved. If a mistake is made, you can not cancelthe modifications.

Choosing No, will not take the template offline. Instead, a copy is created formodification. This is indicated by an additional listing of the process with theConstruction icon next to it.

Since there is no Save icon in the Workflow Designer application, processtemplates are saved when you make them available when existing. Takingthe process offline is the only way to not save modifications to a templateonce open for edit. To not save the modifications, the template needs to betaken offline and then the Delete icon in Workflow Designer can be used todelete only the construction copy and cancel the modifications. The originalprocess template remains.



Create a Process Template That Does Not Require Signoff

Although the primary purpose of this lesson is to teach you how to createmulti-task process templates, a process template without signoffs may becreated for certain reasons, releasing data without electronic review issometimes necessary for the following reasons:

• When you have data imported into Teamcenter Engineering from existingsystems where it was previously released.

• When you have data that has been reviewed outside of TeamcenterEngineering and is simply released in Teamcenter Engineering.

• When you are gradually phasing into the electronic workflow system.

As shown below, a process template that does not require a signoffis a simple process. It can have as little as two nodes, Start andFinish, which are the minimum requirements for any process. Thisonly other necessity is the assignment of the correct Release Status.



Creating a Single Signoff Release Process

Like the No-signoff release process, a Single signoff release process isrelatively simple. However, it must include a Review Task which allows forthe selecting of a signoff team and the performing of the signoff operation.Like the No-signoff release process, it must be assigned a Release Status.

Creating the Signoff Team

Selecting Task Signoff Panel displays the Signoff Profiles window.

The Signoff Profiles window allows you to select the Group and Role for thecorrect signoff user. The user that matches this profile will be assigned laterduring the execution of the process.



The Number of Reviewers represents how many users with the same type ofGroup and Role are needed to sign off on the task. For example, if you neededthree (3) Design Engineers in the high_performance group to sign off, youwould simply create a listing for Group=high_performance and Role=DesignEngineer and set the Number of Reviewers to three (3).

The Quorum field allows you to define the number of sign-offs that arerequired to complete the task. Leaving the Quorum field blank or enteringALL specifies that approval must be unanimous, meaning all users must signoff. Any other positive integer specifies the quorum.



Activity: Create a Quick Release Process

In this activity, you will learn how to create the Quick Release process.

Step 1: Open the Workflow Designer application window.

Choose Admin.

Choose Workflow Designer.

The Workflow Designer window displays.

Step 2: Create a New Process.

Choose File→New Root Template...

The New Root Template window is displayed.

Enter Quick Release in the New Root Template Name field.

Select Review Process from the Based On Root Template list.



Choose OK.

Step 3: Choose the Status the process will apply.

Select Task Attributes (bottom left).

The Attributes window appears.

Select Released from the Release Status drop-down.

Close the Attributes window.

Choose File→Close.

Select the Quick Release process in the Under ConstructionTemplates list, then choose the right arrow to copy it to theTemplates to be made Available list.



Choose OK.

Step 4: Test the new Quick Release process by first creating a Text dataset.




Set the Type to Text.

Enter QR document in the Name field.

Choose OK.

Step 5: Release the QR document dataset.

Select the QR document dataset. (If asked, choose No onCreate New File window.)

Choose File→New→Process...



The New Process window is displayed.

Notice the Process Name field defaults to the same name asthe target object being released.

Notice the QR document is listed in the Attachments sectionas a Target to be released.

Set the Process Template to Quick Release.

Choose OK.

The Release Flag appears on the QR document dataset.

You now have a Quick Release process defined for releasingcertain data without a signoff. You will use this processagain in a later lesson to release imported data.




Activity: Create a Single Signoff Release Process

In this activity, you will create a single signoff release process to be usedwhen releasing previously imported data.


Enter the Admin/Workflow Designer application.


The New Root Template Dialog is displayed.

Enter Import Release in the New Root Template Name field.

Set the Based on Root Template to Review Process.

Choose OK.

Step 2: Create the Review Task.

Verify that Edit Mode is selected.

Select Review Task Template on the toolbar.

Double-click in the Task Flow section of the Workflow Designerwindow (just to the right of the green Start task).

The New Review Task 1 task is created.



Enter Import Review in the Name field, then press Enter.

Notice that the task name is changed to Import Review.

Step 3: Link tasks from Start to Finish

Place the cursor over the Start task (not on the blue strip) andpress the left mouse button. While keeping the left mousebutton pressed, drag the cursor to the Import Review task andrelease.



An arrow appears between the tasks indicating they are linked.

Place the cursor over the Import Review task and press the leftmouse button. Drag the cursor to the Finish task and release.

The Workflow Designer window should look like this.

To move a process task, hold the left mouse buttondown on the blue strip at the top of the task box andthen move the cursor.

Step 4: Define the signoff team criteria.

Expand the Import Review task and select theselect-signoff-team.



Choose the Task Signoffs Panel icon.

The Signoff Profiles wnidow is displayed.

Set the Group field to dba.

Set the Role field to DBA.

Although, you will use the dba group and DBArole in this course, your site should use the groupthat owns the parts to be released (for example,high_performance) and the role responsible for signoff(for example, Product Engineer).

Leave Number of Reviewers set to 1



Choose .

The Signoff Profiles window should look like the following.

Choose the X in the top right corner of the Signoff Profileswindow to close it.

Step 5: Set the Release Status.

Select the Import Release (top level) task.

Select Task Attributes.



Set Released Status to Released.


Step 6: Save the Process Template.


Select the Import Release process in the left pane, then choosethe right arrow to copy it to the right pane.

Choose OK.

The Import Release process is now defined in the database.

You will use this process to release imported parts.




Quick Release TechniqueAfter data has been imported into Teamcenter Engineering you may choose tostatus the data. The import step only imports the data and usually leaves thedata in a unreleased, writable state.

The imported files may have been in a statused state outside of TeamcenterEngineering and now that the data has been imported to TeamcenterEngineering it must be statused there.

Since the import process merely created a dataset in Teamcenter Engineeringand copied the native file to the Teamcenter Engineering volume, a simpleprocess will be adequate.

Three release techniques could be used, depending on the specific data:

• The Quick Release (no reviewers)

• A Single Level Release (a reviewer in one level)

• Command line release (using the release_man utility).



release_man Utility

The release_man utility is used to status objects in batch mode withoutcreating jobs and audit files.

Important Concepts

• Only a userid with administrative rights can execute this utility.

• Objects to be statused must be placed in a folder that resides in the Homefolder of the user executing the utility.

• If the objects in the folder are Item Revisions, the contents of the ItemRevision with IMAN_specification relation and BOMView Revision objectscan be statused also by using the -spec argument.

• The release_man utility can also be used to "un-status" data.

Synopsis$IMAN_ROOT/bin/release_man -u=<user_id> -p=<password> -g=dba[-spec] [-unrelease] -retain_release_date-status= -folder=<folder_name>

Arguments

-spec Specifications and BOMViewRevisions ofan Item Revision in the release folder arereleased along with the Item Revision.

-unrelease Remove the status type identified by the-status argument.

-retain_release_date If the object to be released has already beenreleased, retain the original release date.

-status Valid Status Type to be applied to allobjects.

-folder Release folder name. Folder must reside inthe Home folder of the user executing theutility.



The following example demonstrates using the release_man utility toapply a status of "Released" to all the objects residing in the folder named"to_release." This folder is referenced in waynetr’s Home folder and waynetris a member of the dba group.

IMAN_ROOT/bin/release_man -u=waynetr -p=waynetr -g=dba-status=Released -folder=to_release

The following example demonstrates using the release_man utility to removethe status "Released" from all the objects residing in the folder named"to_unrelease." This folder is referenced in waynetr’s Home folder andwaynetr is a member of the dba group.

IMAN_ROOT/bin/release_man -u=waynetr -p=waynetr -g=dba-status=Released -folder=to_unrelease -unrelease



Activity: Status data using Quick Release Process

In this activity, you will use the Quick Release process to status datapreviously imported.

Step 1: Release the Plastic Specs Text dataset previously imported.


Expand your Newstuff folder to show the Plastic Specs dataset.

Select the Plastic Specs dataset.

Choose File→New→Process...The New Process window appears.

Notice the Plastic Specs dataset is listed in the Targets area.

Select Quick Release from the process template list.

Choose OK.



Step 2: Check the Release Status.

In My Navigator, select the Plastic Specs dataset.

Choose View→Refresh.

The Status Flag should be visible.

The Plastic Specs dataset is released in the database.




Activity: Using release_man to Status Data

In this activity, you will use the release_man utility to apply status.

Step 1: Populate a release folder

Create a folder in your Home folder named release_man.

Copy Rubber Specs 1 and Rubber Specs 2 from your Newstufffolder to the release_man folder.

Step 2: Execute the release_man utility to status data.

Open a command window with the Teamcenter Engineeringenvironment set.


release_man -u=<your userid> -p=<your password>-g=dba -status=Released -folder=release_man

In My Navigator, choose View→Refresh Window.

The Status Flags should now be visible.

Step 3: Execute the release_man utility to un-status data.

Return to the command window and enter following:

release_man -u=<your userid> -p=<your password>-g=dba -status=Released-folder=release_man -unrelease

In My Navigator, choose View→Refresh Window.

The Status Flags should now be removed from datasets.




Using Task Handlers in a Process TemplateProcess Templates are actually comprised of task handlers, or building blocks,that precisely define the work done during a task. Task handlers are smallITK programs or functions. Task handlers are the lowest level building blocksin EPM. They are used to extend and customize tasks.

There are two kinds of handlers:

• An Action handler which does the executable and returns.

• A Rule handler which executes and returns either a GO orNOGO decision.

Each Task has a number of Task Actions (for example, to Assign a userto perform a Task). These Actions can be constrained by Business Rules.According to the Actions that have been performed, the Task is in some State(unassigned, started or completed, for example).

Selecting the Task Handler icon displays the Handlers Panel associatedwith a particular task.



Some Useful Canned Handlers

Demote

Clears all signoff decisions from the current and previous Review tasks. Anoptional argument allows the user to specify the task name that the processin demoted to.

Demote [-level=levelname>]

-level Specifies to which previous task the process willbe demoted. Must specify a valid task in thecurrent process.

If this argument is not specified, process isdemoted to previous task.

Demote On Reject

The demote-on-reject handler demotes the current task when the approvalquorum cannot be met. Demotes the current task to the previous task, or tothe task specified on the —level argument of the demote handler placed onthe Undo action of the current task.

The recommended placement for this handler is the perform-signoff taskPerform action.

demote-on-reject [-num_rejections=<number of rejection>

num_rejections Number of rejections required to demote the task.

Specifying -1 reads the quorum value and sets thatvalue as the number of rejections required to demote thecurrent task.

This argument is optional.



Disallow Adding Targets and Disallow Removing Targets

The disallow-adding-targets handler prevents targets from being added toa job after the job has been started.

The disallow-removing-targets handler prevents targets from being removedfrom a job after the job has been started.

The recommended placement of these handlers is the root task Performaction.

Generally, it is a good practice to leave these handlers attached to the roottask Perform action in order to ensure that target objects are not added to ajob once it is started.

disallow-adding-targets

disallow-moving-targets

CR Assert Targets Checked-In

The CR-assert-targets-checked-in handler verifies that all target objects inthis job are checked-in.

The recommended placement of this handler is the root task Complete action.CR-assert-targets-checked-in

CR Fill In Reviewers

The CR-fill-in-reviewers handler automatically fills in reviewers that meetspecified user, group, or role criteria for the specified release level.

The recommended placement of this handler is attached to theselect-signoff-team task Start action.

CR-fill-in-reviewers -reviewer={User:<user_id>| \Group:<group>|Role:<role> \|$USER|$GROUP|$ROLE|$REVIEWERS} \[-level=<level_name>]

This handler uses the following argument(s):

-reviewer User_id, group, or role criteria of the reviewers or otherkeywords as shown.

-level Level name

The following examples demonstrate using this handler:

1. The following example designates user daytr and all the members of thestandards group as reviewers for Import_Review.

CR-fill-in-reviewers -reviewer=User:daytr-reviewer=Group:standards-level=Import_Review



Auto Assign

The Auto Assign handler makes the specified user or resource pool theresponsible party for the task to which the handler is added.

Auto-assign [subtasks] {-user=<user_id>| -person=<person_name>| -owner| -resourcepool=<resourcepool>}

subtasks Propagates task assignments to subtasks of the currenttask (non-recursively). Optional.

-user Makes the user whose ID is specified the responsibleparty for the task to which this handler is added.

Accepts a single valid Teamcenter Engineering user ID orone of the following keywords: $USER, $TARGETOWNER

-person Makes the user whose name is specified the responsibleparty for the task to which this handler is added.

Accepts a single valid Teamcenter Engineering personname.

-owner Makes the initiator (owner) of the process the responsibleparty for the task to which this handler is added.

-resourcepool Makes members of the specified resource pool theresponsible party for the task to which this handler isadded. Resource pools can be defined in the form ofgroup::role, role or group::

Accepts a valid Teamcenter Engineering resource poolname or one of the following keywords: $GROUP, $ROLE,$TARGETGROUP and $ROLEINGROUP.

The recommended placement of this handler is the Start action.



Notify

This action handler will inform users of a task’s status via OS e-mail. If the-attachment argument is included in the definition of the notify handler,then the recipients will also receive Teamcenter Engineering mail, and theOS e-mail will include a notification that the user has received TeamcenterEngineering mail. Arguments used with the notify handler must be separatedby a comma.

When $REVIEWERS is used as the key word in conjunction with theDistributionList argument, the recommended placement of this handler isattached to the perform-signoff task’s start or complete action. Otherwise,there is no recommended placement

notify-recipient={OS:<value>|User:<value>|Group:<value>|Role:<value>|DistributionList:{<value>|$USER|$GROUP|$ROLE|$REVIEWERS}}[-subject=<string>][-comments=<string>][-attachment=$TARGET|$PROCESS][log]

This handler uses the following argument(s):

-recipient Task reviewers that will receive notification. Accepts oneof the following values.

OS Where <value> is a single valid user name.User Where <value> is a single valid TcEng user ID.Group Where <value> is a single valid TcEng group.Role Where <value> is a single valid TcEng role.DistributionList Where <value> is a single valid entry that represents a

distribution list. This entry may either be the name of avalid TcEng Address List, or it may be any one of severalkeywords that represent a distribution list.

-subject When the OS e-mail is delivered, it will use the taskname for the subject by default. If the -subject argumentis added, then the task name will be enclosed withinbrackets [ ], and the resulting string will be postfixed tothe string identified by the -subject argument to form thee-mail subject line.

-attachment This argument will cause an attachment to be includedin an TcEng mail. The type of attachment will be oneof the following:

$TARGET The Workflow target attachment(s) will be included inthe TcEng mail.

$PROCESS The Workflow process will be included in the TcEng mail.



The following example demonstrate using this handler:

1. The following handler syntax designates Teamcenter Engineering userdaytr as recipient of an OS e-mail and Teamcenter Engineering mail withtargets attached. This handler will be added to the Import Review processto notify the data migrator when review and release of imported datahas been completed

notify\-attachment=$TARGET,-subject=Imported data reviewed and released,-recipient=User:daytr

There are other options in using notify that are not shown here.



Activity: Add a Reviewers Handler to a Process

In this activity, you will learn how to add a Reviewers related Handler tothe Import Release process.

Step 1: Access the Import Release process.

Enter the Admin/Workflow Designer Application.

Select the Import Release process from the Process Templatefield list.

Step 2: Add the CR-fill-in-reviewers handler to the Import Release releaseprocedure.

Choose Edit Mode.

Choose Yes to take the Process Template offline.

Expand the Import Review task.

Select the select-signoff-team task, then choose .

The Handlers panel is displayed.

Select the Start Task Action.



Set the Action Handler field to CR-fill-in-reviewers.

In the existing row of the Argument table, enter:

Use your userid (which is in the dba group). Example:User:waynetr

Choose (at the bottom of the dialog) to add the handler tothe Start action.

The CR-fill-in-reviewers handler is added to the Start TaskAction.

Close the Handlers window.



Step 3: Save the Release Process.


Select the Import Release process in the left pane, then choosethe right arrow to copy it to the right pane.

Choose OK.

Now the Import Release process willnot require a select-signoff-team task.




Using Handlers to Create JT data

The EPM-tessellation-handler is used for creating DirectModeldatasets from UGMASTER datasets. The placement ofthis handler can vary depending on the processing method(foreground or background) and the associated arguments used.

This handler uses the following arguments.

-continue Continues the review process, even when tessellation isunsuccessful. Use for non-critical tessellation processes.

-signoff Completes the perform-signoff task if the handler wasplaced on the Complete action of the perform-signoff task.Completes the process if the handler was placed on theComplete action of the root task.

-background Executes tessellation in the background.-status Status type to be applied to a rendered child.

The following modes are available for tessellating UGMASTER orUGALTREP datasets when they are released.

Foreground No specific placement required.Background/Synchronous

Use the –background and –signoff arguments and placethe handler in the Complete action of the perform-signofftask of the Review task. The workflow will wait fortessellation to complete before continuing.

Background/Asynchronous

Use the –background argument and place the handler inthe Complete action of the root task.

Sample placement shown below.



System Setup prior to Tessellation

Before Tessellation can be accomplished, there several system setupoperations that need to be in place. NX environment variables,Teamcenter Engineering preferences, and server definitions shouldbe established so that the tessellation can be preformed properly.

Environment Variables

There are two key environment variables that need to set before tessellationcan take place. These relate to the location of the NX installation.

UGII_ROOT_DIR

UGII_BASE_DIR

Preferences

There are two key preferences that need toset before tessellation can take place.

EPM_tessellation_servers=NONE

This preference setting is used to identify the Tessellation Server. If aserver is used, this should be set to <hostname>:<portno>, where hostnamecorresponds to the machine where the Tessellation Server runs and theportno corresponds to the port where it listens to the request. The defaultsetting of NONE represents the stand alone mode of Tessellation Server.

EPM_tessellation_target_type=UGMASTERUGALTREP

This preference setting is used to identify the EPM Tessellation Targets. Thevalid targets are UGMASTER and UGALTREP datasets.



Server Setup

Tessellating datasets can be done from a server or from a standalonesystem. If a server is used, the Tessellation service must be installed. Thisis done via the Database Daemons option in the installation Setup window.

After a few setup questions, the Tessellation Service option is displayed.

Once installed, the service will be listed in the Services window.

For this class, we will not use the Tessellation Service option.



Activity: Review the system setup

In this activity, you will review the necessary system setup for successfullytessellating UGMASTER datasets.

Step 1: Check the NX environment variables.

Use the right-mouse button on the My Computer icon on thedesktop.

Choose Properties.

Choose the Advanced tab.

Choose Environment Variables.

Scroll down in the Environment Variables window to make surethe UGII_ROOT_DIR and UGII_BASE_DIR variables are set.

Close the two windows.

Step 2: Check the tessellation preferences.

Select Edit→Options from the pull-down menu.

Select Index at the bottom of the form as shown.



Type EPM_t in the Search on Preference name field and clickon the EPM_tessellation_servers preference listed in thePreferences List.

Make sure it is set to NONE.

If the Tessellation Service was installed on a server, thehostname and port number would be listed here. Example:dtcld18:2098



Click on EPM_tessellation_target_type in the preference list.

Make sure UGMASTER and UGALTREP are present in theCurrent Values list.

To close the Preferences form, select Cancel.




Activity: Add the tessellation Handler to the Quick Release process

In this activity, you will add the tessellation handler to the Quick Releaseprocess that was created in a previous activity. Then you will test the handler.

Step 1: Access the Quick Release process for modification.


Set the Process Template to Quick Release.

Choose Edit Mode.

Choose Yes to take the Process Template offline.

Step 2: Add the tessellation handler.

Make sure the Quick Release root task is selected.

Choose Task Handlers.

In the Handlers window, select the Complete task.

Set the Action Handler field to EPM-tessellation-handler.

Choose at the bottom of the window.



The Handler window should now look like the following.


Step 3: Save the workflow process.


Select the Quick Release process from the left list and choosethe right arrow.

The process should now be on the right list.

Choose OK to save the process and close the Workflow Designerapplication.

Step 4: Test the handler by first creating a new Item.





Enter the following.

ItemID: tess001

Rev: 001

Name: test

Choose Finish to create the Item.




Step 5: Create a UGMASTER Dataset.

Expand the tess0001 Item.

Select the tess001/001 ItemRevision.

Choose File→New→Dataset.

In the New Dataset window, make sure the Type is set toUGMASTER.

Replace the slash (/) in the Name with a dash (-) so that it istess0001-001The Item structure and naming should look like the following.

Choose OK.

In order for a UGMASTER dataset to be tessellated, theItemID can not contain spaces. Also, the UGMASTERdataset can not contain a slash (/).

Step 6: Add a part to the UGMASTER dataset.

Select the tess0001-001 dataset.

Choose View→Named References.

In the Named References, choose Import...

In the Import File window, navigate to the.../aa_class/workflow_designer folder.

Select the tess.prt file, then choose Import.Notice the tess.prt file now shows in the Named Referenceswindow.

Close the Named References window.

Step 7: Create the jt data by releasing the ItemRevision.

Select the tess0001/001 ItemRevision.

Choose File→New→Process.

In the New Process window, set the Process Template to QuickRelease.



Choose OK.

A window will appear showing that the tessellation process,which is running in Foreground mode, is logging into NXManager.

When the tessellation is complete, check to see if theDirectModel dataset was created.




Creating a Multi Task ProcessMulti task processes are a collection of many tasks. These tasks can bemade up of a variety of process tasks. Some tasks can be for selecting andperforming signoffs. Others for simply checking the work and moving itforward, no signoff required. The arrangement of tasks and complexity ofhandlers will vary depending on the business process the process is tryingto model.

Setting Access privileges as data moves through a process

An important concept of a release process is the ability to alter the privilegeson the data for the different users who need to work within the boundaries ofthe process. To do this, Teamcenter Engineering uses Workflow ACLs whichcan be created and attached to the different tasks within a process.



Using ACLs in a Process Template

Selecting Task Attributes displays the Attributes window associatedwith a particular task.

By selecting the Named ACL field, a user can create a new ACL by selectingthe Type of Accessor, ID of Accessor, and setting the type of access theAccessor will need in order to work within the process. This is done throughthe Named ACL window, shown below.

Modifying a Named ACL will modify it for the Database, so it isrecommended to create new Named ACLs for Workflows.



Activity: Create a Process Template for CM

In this activity, you will create a multi-task process template that models abasic Change Management process. This process template will be used forthe Change object type you will model in a later lesson.




The New Root Template window is displayed.

Enter TR Change Notice in the New Root Template Name field.

Leave the Based on Root Template field set to EmptyTemplate.

Choose OK.



Step 2: Create the Process Tasks.

Select Do Task Template on the toolbar.

Double-click in the Task Flow section, just to the right of thegreen Start task.

The New Do Task 1 task is created.

Enter Prepare Change in the Name field and press Enter.

The task name changes to Prepare Change.

Select Add Status Task Template on the toolbar.



Double-click in the Task Flow section just below the PrepareChange task.

The New Add Status Task 1 task is created.

Enter ECPending Status Obtained in the Name field and pressEnter.

The task name changes to ECPending Status Obtained.




Double-click in the Task Flow section just to the right of thePrepare Change task.


Enter Initial Change Review in the Name field and press Enter.

The task name changes to Initial Change Review.

Select Do Task Template on the toolbar.



Double-click in the Task Flow section of the Workflow Designerwindow just to the right of the Initial Change Review task.

The New Do Task 1 task is created.

Enter Finalize Change in the Name field and press Enter.

The task name changes to Finalize Change.




Double-click in the Task Flow section just to the right of theFinalize Change task.


Enter Final Change Review in the Name field and press Enter.

The task name changes to Final Change Review.

Select Add Status Task template.



Double-click in the Task Flow section just below the FinalChange Review task.

The New Add Status Task 1 task is created.

Enter Released Status Obtained in the Name field and pressEnter.

The task name changes to Released Status Obtained.

Step 3: Link tasks from Start to Finish

Place the cursor over the Start node and press the left mousebutton and while keeping the left mouse button pressed, dragthe cursor to the Prepare Change task and release.

An arrow should now appear between the two tasks indicatingthey are linked.

Place the cursor over the Prepare Change task and press theleft mouse button. Drag the cursor to the ECPending StatusObtained task and release.



Repeat the process until all tasks are linked and your processlooks like the following.

To move process tasks, click in the blue strip at thetop of the task box.

Step 4: Define the Reviewer profiles for the Review tasks.

Expand the Initial Change Review task in the Task HierarchyTree and select the select-signoff-team task.

Select Display the Task Signoffs Panel.



The Signoff Profiles window is displayed.

Set the Group field to high_performance.

Set the Role field to Engineering Manager.

Verify Number of Reviewers =1

Choose to attached the signoff profile.

Close the Signoff Profiles window.



Expand the Final Change Review task in the Task HierarchyTree and click on select-signoff-team task.

Select Display the Task Signoffs Panel.

The Signoff Profiles window is displayed.

Set the Group field to high_performance.

Set the Role field to Engineering Manager.

Verify Number of Reviewers =1

Choose .

Close the Signoff Profiles window.

Step 5: Define the Release status values to be applied/modified.

Select the ECPending Status Obtained task in the TaskHierarchy Tree.




Change the Released Status to ECPending.

Close the Attributes dialog.

Select the Released Status Obtained task.

Choose Display the Task Handlers.




In the Start action, select the create-status handler, then

choose Delete (at the bottom).

In the Complete action, select the add-status handler and then

Delete (at the bottom).

Select the Complete Task Action.

Set the Action Handler field to set-status.

In the Argument table, enter the following.

This handler will change the status on the targets fromECPending to Released, prior to completing to the process.

Choose (at the bottom) to add the handler.



The set-status handler is added to the Complete Task Action.

Close the Handlers panel.

Step 6: Add rules based access for the Final Change Review Task

Select the Final Change Review task.


The Attributes windowis displayed.

Choose the icon (Vault) adjacent to Named ACL.



The Named ACL window is displayed.

Set ACL Name to blank

Enter Change Review in the ACL Name field.

Choose to the right of the ACL Name field.

On the far right side of the window, select the + sign to add anew line.

Double-click in the Type of Accessor box and select World.



Set the protections as shown below by double-clicking in eachbox.

Select the + sign on the far right side to add another line.

Double-click in the Type of Accessor box and selectApprover(RIG). RIG stands for Role In Group.

Double-click in the ID of Accessor box and set it to EngineeringManager in high_performance.

Set the access to allow Promote privilege.

The Named ACL window should look like the following.

Choose .

Choose Assign.

Notice the Assigned ACL Name field (bottom of Named ACLwindow) changes to Change Review.

Close the Named ACL window.

Notice the Named ACL setting in the Attributes windowchanges to show the new Change Review ACL.




Step 7: Save your work.


Select the TC Change Notice process in the left pane, thenchoose the right arrow to copy it to the right pane.

Choose OK.

The TR Change Notice process templateis now defined in the database.




Importing/Exporting Workflow ProcessesAll Workflow processes are stored in the database, but they can be exportedfor use between different Teamcenter Engineering sites. The Export andImport commands are accessed through the Tools menu.

Choosing Tools→Export accesses the Export Workflow Templates window.From here, the destination directory and xml filename are entered. TheContinue On Error option allows the export to continue if one or moretemplates fail to export. Failed templates are bypassed. If this option isignored, the export stops when a template fails, however any templatesexported before the failure are exported.

Choosing Tools→Import accesses the Import Workflow Templates window.From here, an import directory and xml filename can be identified.



Activity: Importing process templates

In this activity, you will use the Import function to import the procedures thatwill be needed in the last topics of this lesson.

Step 1: Locate and edit the template file.

In a directory structure type window (i.e., Explorer forWindows), navigate to the aa_class/workflow_designer folder.

Locate the import_templates.xml file and open it in a texteditor.

Find the two incidents of change_userid and change themto your userid.

For example, if your userid was green, you would locate thetwo incidents of change_userid and replace them with green,as shown in the following figures.

Before:

After:

Save and exit the templates file.

Step 2: Import the workflow processes.


Choose Tools→Import.

The Import Workflow Templates window is displayed.

Choose Import.



In the Select Directory window, navigate to theaa_class/workflow_designer directory.

Select the import_templates.xml file, then choose Select.

The import_templates.xml file is now displayed in the ImportFile field.

Choose OK.

Choose Yes to view the log file.

After reviewing the file, choose Close.

Step 3: Review the appended procedures.

Choose View→Refresh Window to view the newly importedprocesses.



Select the pull-down list from the Process Template field.

Notice there are four new processes listed, all starting with AA( for Application Administration).

AA-Automatic Condition Task

AA-Manual Condition Task

AA-Resource Pool

AA-Secure Tasks

These were imported into the databasefrom the import_templates.xml file.




Secure TasksA secure task is a task which uses the require-authentication handler. Theusage of this handler with task types that have end-user interfaces willrequire the end-user to provide their TcEng password at the time theyexecute their task. Usage of this handler ensures that the task is actuallyperformed by the assigned user.

Below is a perform-signoffs task with the require-authentication handler.Notice the appearance of the Password field.

Below is a perform-signoffs task without the require-authentication handler.There is no Password field shown.

The require-authentication handler can be used to provide the passwordsecured user interface for the following task types:

• Review task (perform-signoffs sub-task)

• Acknowledge task (perform-signoffs sub-task)

• Do task

• Manual Condition task



The require-authentication handler should be added to the Perform actionof the specific task with associated with the end-user interface. These tasksinclude:

• Do tasks

• perform-signoffs tasks (for Review and Acknowledge)

• Condition tasks (manual only)

In the example below, the require-authentication handler has been addedto the Perform action of a Do task:



Activity: Secure Tasks

In this activity, you will browse the design and test a process that uses therequire-authentication handler to enable password-secured tasks.

Step 1: Browse the AA-Secure Tasks Process.

Start the Admin/Workflow Designer application.

Choose AA-Secure Tasks from the Process Templatedrop-down.

In this process, the tasks along the top of the diagram includethe require-authentication handler while the task along thebottom of the diagram do not.



Select the Authenticated-Do task in the process flow diagram.

Choose Display Task Handlers.

Select the require-authentication handler to observe its usagein the Perform action of the task.


Expand the Authenticated-Review andAuthenticated-Acknowledge tasks.

Locate the require-authentication handler that has been addedto the Perform action in the perform-signoffs sub-tasks of theeach of these tasks.



Step 2: Test the AA-Secure Tasks Process.

Select the Home tab in the My Navigator application.

Expand the Item used in the previous activities and select theItemRevision.


Set the Process Template to AA-Secure Tasks.

Choose OK.

Select the Inboxes tab.

Expand the Tasks to Perform folders in your user’s Inbox andthe dba/DBA Inbox.

Select the Authenticated-Do task in your Inbox.



Select the Process View button.

The tasks at the top of the process diagram are the tasks withthe require-authentication handler. They will be automaticallyassigned to your user’s Inbox.

The tasks at the bottom of the process diagram are the taskswithout the require-authentication handler. They will beautomatically assigned to the dba/DBA Inbox

Select the Task View button.

Make sure the Authenticated-Do task in your Inbox is stillselected.



Observe the addition to the user interface of the Passwordentry field.

Complete the Authenticated-Do task in your Inbox, by selectingDone, entering your password, and then choosing Apply.

Select the Do task in the dba/DBA Inbox.

Observe that the password field is not present on this task.

Select Done, then choose Apply.

Select the perform-signoffs task in your Inbox.

From the Viewer tab, choose the No Decision link in theDecision column.

Observe the addition of the Password field in the user interfacefor the perform-signoffs task.



Select Approve, enter your password, then choose OK.

Select the perform-signoffs task in the dba/DBA Inbox.


Observe the omission of the Password field on the user interfacefor the perform-signoffs task.

Select Approve, then choose OK.

Select the perform-signoffs task in your Inbox.



From the Viewer tab, choose the Not Acknowledged link in theDecision column.

Observe the Password field on the user interface for theperform-signoffs task.

Select Acknowledged, enter your password, then choose OK.

Select the perform-signoffs task in the dba/DBA Inbox.



From the Viewer tab, choose the Not Acknowledged link in theDecision column.

Observe the omission of the Password field on the user interfacefor the perform-signoffs task.

Select Acknowledged, then choose OK.




Resource PoolsA Resource Pool is a Group, Role in a Group, or a Role which can be assignedtasks the same way an individual User is assigned tasks

A Resource Pool is a conceptual definition of a set of users. ResourcePools are not directly created by Teamcenter Engineering Administrators.Instead, they are implicitly defined when the Administrator defines theGroup/Role/User organization for the site. Resource Pools are used only inthe context of workflow.

Resource Pools are useful in modeling workflow tasks that cannot bedirectly assigned to a single user, either automatically, or at run-time by theresponsible user. Instead, the task is assigned to a pool of users, one of whomwill in pull the task or assign the task to themselves.

Subscribing to a Resource Pool Inbox

In order to see and perform tasks that have been assigned to Resource Pools,users need to add the display of the Resource Pool Inbox to their Inbox tab.

From the My Navigator application, choose Tools→Resource PoolSubscription... to open the Resource Pool Subscription dialog.

In the following example, the user can set the Role to Engineering Managerand choose the Subscribe a Resource Pool button (+) to set up a resourcepool Inbox for that specific role.

Delegating Tasks

A task in the */Engineering Manager (Resource Pool) Inbox can be viewed andperformed by multiple users who have subscribed to that Inbox. Delegatingthe task to a specific user Inbox will avoid duplication of effort and should bedone when it will take an long time to perform the task.

Users can delegate tasks from a Resource Pool Inbox to their personal Inboxand vice versa.

From Resource Pool Inbox to Personal Inbox

Assigning Resource Pool tasks to a particular user can be performed in thefollowing manner.



1. Select the desired task from the desired Resource Pool Inbox.

2. Select the desired link from the User-Group/Role listing.

The Delegate signoff dialog will appear.

3. Select the desired User from the drop-down list, then choose OK.

4. The task is removed from the */Engineering Manager Inbox and placedin the user’s Tasks to Perform folder. The responsibility of this task hasbeen transferred to the selected user.



Activity: Resource Pools

In this activity, you will perform the following tasks:

• Add a Resource Pool Inbox to your Inbox display

• Browse tasks that require end-users to (manually) assign resource poolsand tasks that automatically assign resource pools

• Execute and test the process template

Step 1: Display the Inboxes tab.


Choose the Open Inbox icon.

The Inboxes tab appears with your user Inbox displayed.

Step 2: Add the Inbox for the dba/DBA resource pool.

Choose Tools→Resource Pool Subscription...

Set toggle to All.

Set the Group to dba.

Set the Role to DBA.



Choose .

The dba/DBA Inbox appears in the Inboxes list.

Choose Cancel.

The Inbox tab now displays two Inboxes. One for your user IDand the other for the dba/DBA group/role resource pool.

Step 3: Browse the AA-Resource Pool process template.

Go to the Admin/Workflow Designer application.

Choose AA-Resource Pool from the Process Template.



Expand all tasks in the Task Tree.

Select each task in the tree and read theDescription/Instructions.

Select the Auto Assigned RP for Do task.



Choose Display Task Handlers to display the HandlersPanel.

Select the auto-assign handler in the Start section.

Observe the usage of the auto-assign handler to automaticallyassign the task to the dba/DBA resource pool.


Under the Auto Assigned RP for Review task, select theselect-signoff-team task.

Choose Display Task Handlers.

In the Start section, select the CR-fill-in-reviewers handler.



Notice that this handler will automatically assign the dba/DBAresource pool as a Reviewer.


Step 4: Test the AA-Resource Pool process template.

In the Teamcenter/My Navigator application, select the Hometab.

Select the Home folder, then choose File→New→Item...

Set the Item Type to Item.

Choose Next.

Choose the Assign button on the New Item dialog.

Enter a Name for the Item, then choose Finish.




Expand the new Item object and select the ItemRevision object.


Choose AA-Resource Pool from the Process Templatedrop-down.

Choose OK on the New Process Dialog.

Select the Inboxes tab in My Navigator.

Under your userid Inbox, expand the Tasks to Perform folder.



Select the Do task labeled Manually Assigned RP for Do.

Choose Actions→Assign...

Set Group to dba.

Manually assign the task to a resource pool by setting User to *.

Choose OK.

Notice the task is removed from your Tasks to Perform folder.



Expand the dba/DBA Inbox and the Tasks to Perform folderunder it.

Observe the task is now assigned to the resource pool.

Select the Manually Assigned RP for Do task, then choose theViewer tab.

Select Done, then choose Apply to complete the task.

Observe that the previous task has been replaced by the nexttask in the process flow and that the task was automaticallyassigned to the resource pool.

Select the Auto Assigned RP for Do task.




Expand your Inbox and then the Tasks to Perform folder.

The next task in the process demonstrates how end-usersmanually select a resource pool for a Review Task.

Select the select-signoff-team task.

From the Viewer tab, select the dba/DBA/1 node in the Profileslist.

In the User drop-down selector, set the User to *.

Choose the + icon.

Notice the new listing of * – dba/DBA.



Choose Apply to complete the task assignment.

Notice the associated perform-signoffs task appears in theresource pool Inbox.

Select the perform-signoffs task.


In the Signoff Decision dialog, set the Decision to Approve,then choose OK.

The next task in the Process is again a perform-signoffs task,only this time the task was automatically assigned to theresource pool by the CR-fill-in-reviewers handler in the processtemplate.



Set the Decision to Approve, then choose OK.

All tasks have now been completed and are removed from thedba/DBA Inbox.




Conditional TasksThe Workflow Designer Condition Task template is used to branch processflow according to some defined criteria. Condition tasks have a resultattribute than can be set to one of the following values: True, False,Unset. The initial setting of the Condition task is Unset, until it is eitherautomatically or manually set to True or False. Successor tasks require theCondition task to be set to either True or False before they can start.

Manual Condition Task

Condition tasks configured to proceed manually require a user action beforethe task can proceed to completion. When the workflow reaches this task’sStart action, the task appears in the selected user’s Inbox. The user completesthe instructions, defines the condition path as either True or False, thenclicks OK to complete the task and allow the workflow to continue. Youshould enter text in the Task Instructions that pose a question or set ofparameters that require a True/False answer. If the User selects Unset, thetask will not complete.

Create a manual Condition task by inserting the Condition Task templateinto the workflow process. Do not define a condition query or any customhandler that will define a result for the task.



Define the T/F branching for successor task by using the Task Propertiesdialog for the successor tasks.

Choose the Conditional Path button on the Task Properties dialog.

The Condition Paths dialog is used to toggle the T/F branching for thesuccessor task.



Automatic Condition Task

Condition tasks configured to proceed automatically act only as visualmilestones in the workflow process. There is no action for a user to perform,and thus no dialog box associated with the automatic Condition Task.

Use an automatic Condition task when a database query can be defined forthe decision branch.

Create an automatic Condition task by inserting the Condition task templateinto the process template, then selecting a condition query for the task usingthe Task Properties dialog.

The Condition Query dialog allows you to build a new query or select anexiting query for the task.



The Condition Query dialog allows you to set the True condition when thequery is executed against the process target list. The True condition can beset for any of the following query results:

• The query must find All of the targets.

• The query must find Any of the targets.

• The query must not find any of the targets (None).



Activity: Conditional Tasks

In this activity, you will browse the designs and then test processes that useboth manual and automatic conditional tasks.

Step 1: Browse the AA-Manual Condition Task Process.


Choose AA-Manual Condition Task from the Process Templatedrop-down.

Select the AA-Manual Condition Task node in the task treeand read the description of the process.



Select Manual Condition Task from the process diagram.

Choose View→Task Properties...

Notice that there is no query associated with this conditionaltask. This conditional task requires end-user action todetermine the downstream conditional branching.



Close the Task Properties Dialog.

Select the IF Condition is TRUE task in the process diagram.


Choose the Display conditional path values button.

This displays the Condition Paths dialog which is used totoggle the condition setting for the branch flowing into the taskas either True or False.

Close the Condition Paths dialog.

Close the Task Properties Dialog.

Step 2: Test the AA-Manual Condition Task Process




Expand the Item that was created in the previous activity, thenselect the ItemRevision.


Set the Process Template to AA-Manual Condition Task.

Choose OK.


Expand your user’s Tasks to Perform folder.



Select the Standard DO Task in the Task to Perform folder.

In the Viewer tab, toggle to Process View.

The current task (circled) precedes the manual condition task.

Toggle back to the Task View.


The next task to appear in the Task to Perform folder is theManual Condition Task.



With the new task selected, verify the Viewer tab is still setto Task View.

Observe the user interface for setting the value of the condition(bottom of window).

Set the Task Result to true, then choose Apply.

A new task appears in the user’s Task to Perform folder.

With the new task selected, toggle Process View in the Viewertab.

Verify that the process flowed through the correct branch to thenext task when the conditional task was manually set to true.





All tasks for the AA-Manual Condition Task process have nowbeen completed.

Step 3: Browse the AA-Automatic Condition Task Process.


Choose AA-Automatic Condition Task from the ProcessTemplate drop-down.

Read the description of the process.



Select the Automatic Condition Task task (circled) from theprocess diagram.




Notice that there is a query associated with this conditionaltask. This conditional task does not require end-user action todetermine the downstream conditional branching.

Choose the user_data_3_equal_MAKE Condition Query.

The Condition Query dialog allows you to build a new queryor select an exiting query for the task. It also allows you to setthe true condition for when the query is executed against theprocess target list. The true condition can be set for any of thefollowing query results: All, Any, or None of the Targets.

Close the Condition Query Dialog.



Close the Task Properties dialog.

Step 4: Test the AA-Automatic Condition Task Process.


Expand the Item and ItemRevision that was created earlier.

Double-click the ItemRevision Master.

The ItemRevision Master form appears.

In the user_data_3 field, enter MAKE.

Choose OK to save and close the form.

Select the ItemRevision object.




Set the Process Template to AA-Automatic Condition Task.

Choose OK on the New Process dialog.


Expand your Tasks to Perform folder.

Select the Standard Do task.

In the Viewer tab, toggle Process View.



The current task precedes the automatic condition task.



The next task to appear in the Tasks to Perform folder is the IFCondition is TRUE task.



With the task selected, toggle to Process View in the Viewertab.

Observe the conditional task has been automaticallyperformed. The condition was set to true because the value ofthe user_data_3 attribute on the ItemRevision Master formwas equal to MAKE.

Toggle back to the Task View




If you wish to test the False condition, clear the user_data_3field, and then send the ItemRevision through theAA-Automatic Condition Task process again.

With the user_data_3 attribute field blank (or with an entrydifferent than MAKE), the process should automatically takethe False branch.




Assigning Default Process TemplatesOnce you create Process Templates, you can assign specific process templatesfor a group. The group can have multiple assigned process templates witheach process template based on the type of object being initiated from theFile→New→Process... window.

The assigned process template will be placed in the Process Template field asa user initiates a certain type of data while working within a certain groupwhen choosing the Assigned process template filter button.

Group and Role Preference Files

Process Templates are assigned by using Preferences for the specified group.

IMAN_ItemRevision_release_procedure=Import Release

The Workflow Designer application provides a graphical interface forcreating the preference. From the Workflow Designer application chooseEdit→Template Filter.

With the example shown above, the following preference would be added tothe high_performance group preferences

IMAN_ItemRevision_release_procedure=TR Change NoticeImport Release



Blocking Users from Choosing from All Process Templates

A preference can be set to disable users from choosing any process templatewhen choosing File→New→Process... This assumes that process templateshave been assigned.

Setting CR_allow_alternate_procedures=any allows the All ProcessTemplate Filter button to be selected.

Setting CR_allow_alternate_procedures=none will remove theAll/Assigned buttons from the File→New→Process... dialog.

Preference(s): CR_allow_alternate_procedures

Default: any



Activity: Assign Default Process Templates

In this activity, you will establish default process templates fordata types initiated by certain groups by setting the following:

Group Data Type Process Template

dba Text Quick Releasedba Item Revision Import Release

Group Data Type Procedurehigh_performance Item Revision TR Change Noticecorrective_action Item Revision TR Change Notice

Step 1: Use Workflow Designer Template Filter tool to assign defaults.


Choose Edit→Template Filter.

It may take a moment for the contents of the dialogto populate.

The Process Template Filter Dialog appears.

Set the Group Name to corrective_action.

Set the Object Type to ItemRevision.

Select TR Change Notice from the Defined Process Templatelist.

Choose the left-pointing arrow to move it to the AssignedProcess Template list.



The form should appear as shown.

Choose Apply.

Set the three other defaults listed in the table, choosing Applyafter each, and choosing Close after the last one.

Step 2: Set a preference to enable the Assigned option in the New ProcessDialog.


The Options window appears.



Choose Index (bottom left).

Notice that the Options window changes to show thePreferences fields.

In the Search on preferences name field, slowly enter CR.

Notice that as you type, the system is dynamically searchingfor preferences and displaying them in the Preferences list.

Select the CR_allow_alternate_procedures preference.

The window should now look like the following, which showsthe all of the existing preferences that begin with CR.



Change the Current values from any to none if necessary.


Choose to close the Options window.

Step 3: Verify that your work has influenced the File→New Process dialogbehavior.

Go the Teamcenter/My Navigator application.

Expand a previously created Item and select the ItemRevision.


Notice the Process Template automatically changes to theImport Release process. This is because the default process foran Item Revision being release by someone from the dba groupis set to Import Release.

Choose Cancel to close the Process window.





• Created Generic Workflow Process Templates.

• Added Handlers to enhance Workflow Processes.

• Created Workflow Process Templates for Change Management.

• Used the release_man Utility to add and remove Status

• Imported Process Templates

• Used Secure Tasks in Processes

• Used Resource Pools in Processes.

• Used Conditional Tasks in Processes


Lesson

13 Change Management

Purpose

The purpose of this lesson is to demonstrate how to model ChangeManagement (CM) Change Types.

Objectives


• Create a Change Type

• Add Handlers to a CM Workflow Process


Change Management

Benefits of the CM Application• Collects all data related to the change

• Used to propose Solutions, manage Problem Items and track AffectedItems

• Easily track the process that the Change Object is going through

• Track BOM changes (Adds and Cancels)

The Change Management application is not limited to engineeringdata. You can implement a change against any object model in thedatabase.


Change Management

Change ObjectsA Change object is used to control all changes to a product’s definition andconfiguration during its life-cycle.

Key Points

• A Change object is a special Item Type (EngChange)

• A Change object is viewed in the CM Viewer application

• A Change object is represented by a blue "delta" icon

• Contains default folders used to collect all the information about thechange


Change Management

Types of ChangesMost companies have different numbering conventions and signatureapproval levels for different types of changes. These are referred to as changeclassifications.

Some changes are simple and may require only one person to signoff. Otherchanges are more complex and may require approval from multiple people,including external government bodies, suppliers, etc.

Each Change Type has its own unique numbering convention.

Three Change Types are provided with the default Teamcenter Engineeringinstallation.

• CR - Modeled using CMII Change Request (CR) process requirements.

• CN - Modeled using CMII Change Notice (CN) process requirements.

• WA - Work Authorization (WA)

The setup of these types can be changed or new types can be created based onthe requirements of your business.


Change Management

Change Object Folder StructureInside the Change object is a built-in folder structure for the change. You usethese folders to manage the different types of objects in your Change process.

Problem Items

• Problem Item data is existing data for which change is being proposedor implemented.

• This data is usually already statused (production) data at the time thechange is started, and therefore is not considered "Target" data in theworkflow process associated with the Change object.

Affected Items

• Affected Item data is new data created to replace data identified asProblem Item data. For example, if 1234 Rev A is identified as ProblemItem data, the new 1234 Rev B would be identified as Affected Item data.

• Can be an assembly or piece part.

• Since Affected Item data is new data, it is usually identified as Targetdata for the workflow process associated with the Change object.

Solution Items

• Solution Item data is new data created to implement change to theProblem Item data, however it is not directly replacing the Problem Itemdata. An example of Solution Item data is a new part created for anassembly identified as Affected Item.

• Since Solution Item data is new data, it is usually identified as Targetdata for the workflow process associated with the Change object.


Change Management

Creating Change Types

Change Types are created from the application within theAdmin application group.

Choosing Change Type from the Type application dialog box displays thedialog necessary to model a Change Type.

The modeling of a Change Type is managed using the following variables.

• Identification - You will define naming rules for the Change object anddefine the behavior of the New Change dialog Assign ID/Rev functions.

• Associated Form Type(s) - You will identify 1 or more number of FormType instances to be automatically created with the Change object whenit is created. Design of Form Types was covered earlier in this course.

• Associated Process Template(s) - You will define 1 or more number ofProcess Templates created using the Process Designer application to beassociated with your Change Type.


Change Management

• Enter the Change Type Name in the Change Type name field.

• Specify whether Effectivity will be shared by toggling Yes or No.

• Specify the criteria for Change Id and Rev Id.

• Specify which Form Types and Process Templates you will use.

Once you have entered the information describing the Change Type, you canchoose Create to define the Change Type.


Change Management

Activity: Create the TRCN Change Type

In this activity, you will configure a Change Type named TRCN (TrainingChange Notice). You will identify for this Change Type two Form Types and aProcess Template you created earlier in the course.

Step 1: Create the TRCN Change Type.

Start the Admin/Type application

Select Change.

Enter the Change Type name: TRCN

Toggle Is Effectivity Shared to Yes.


Change Management

Step 2: Define the settings for Change Id.

You will define the following naming convention for the Changeobject of type TRCN.

Use the up arrow to set the length of the Change Id to 9.

Select the + sign next to Change Id.

Enter Range: 1-4

Enter Value: TRCN

From the Format pull-down menu, choose Static.

Step 3: Define the running value, starting with 00001, for Change Id.

Select the + sign next to Change Id, again.


Change Management

Enter the Range: 5-9

Enter the Value: 00001

Select the Format: Running

Step 4: Define the settings for the Rev Id.

Click the + sign next to the value for Rev Id.

Enter the Range: 1

Enter the Value: 0

Select the Format: RunningThe fields should now look like the following.

Step 5: Select the Form Types to be associated with the Change Type.

In the Form Types section, select Change Costs from the list ofDefined form types, then choose the + sign.

Select Change Description, then choose the + sign.

Change Costs and Change Description are FormTypes you created earlier in the course.


Change Management

Step 6: Select the Process Templates to be associated with the ChangeType.

From the list of Defined process templates, select TR ChangeNotice, then choose the + sign.

Now that you have entered the required data, choose Create.

Step 7: Verify your work by creating a Change object in the My Navigatorapplication.


Select your Home folder in the Home tab.

Choose File→New→Change...


Change Management

The Create/Revise Change window appears.

If necessary, choose More... to set the Change Type to TRCN.

Choose the Assign button for Change Id.

The Change ID TRCN00001 should appear.

Leave the Change Revision ID set to 0.

Enter a Change Name (example: Test).

Use the More Attributes tab and check the Start Process onCreate box.

Checking this box will automatically start the workflow processlisted in the field, which is TR Change Notice.

Select the Description tab and enter a Change Descriptionof Test TRCN Change Type.

Choose OK.

The new Change object appears in your Home folder.


Change Management

Step 8: View the Change object in the CM Viewer application

Select the TRCN00001-Test change object.

Choose Open.

This launches the CM Viewer application.

Select the tab to view the Change Costs andChange Description forms associated with the Change Type.


Change Management

Select the tab to verify the TR Change Noticeprocess has been started.



Change Management

Process Model Design for Change ManagementSpecial workflow handlers are provided with Teamcenter Engineering foruse in process models designed for the Change Management application.

ECM-add-affected-irs-as-target

This handler attaches all ItemRevisions in the "Affected Items"and "Solution Items" folders to the "Target" folder of the workflowprocess. This handler may be used several times in a process.

ECM-att-new-status-for-aff-revs

This handler attaches a separate release status object for eachaffected ItemRevision of the targeted EngChange Revision.

ECM-copy-end-item-effectivity

This handler copies effectivity from one affectedrevision of the target EC Revision to any other affectedrevisions which don’t share the same release status.

ECM-notify-competing-changes

This handler notifies a site-defined list of recipientsabout competing changes for each affected revision.

ECM-start-new-sub-processes

This handler starts a new process for allaffected revisions of the targeted EC Revision.

EPM-attach-related-objects

This handler attaches the specified related objects of the target objects astarget/reference attachments to the process.


Change Management

TR Change Notice ProcessNew product definition (new Item Revisions) can be identified and addedto the Affected/Solution Item folders at three possible locations of the TRChange Notice workflow process.

• At the time the Change Object is being created.

• During the Prepare Change Do task.

• During the Finalize Change Do task.

Since it is possible for new ItemRevisions to be identified after the start ofthe process, it will be necessary to add handlers to the process model. Thesehandlers will notice newly added ItemRevisions and add them and theircontents to the Target list of the process so they will obtain Release Statusproperties.

(Complete Action)

ECM-add-affected-irs-as-target

EPM-attached-related-objects


Change Management

Activity: Add CM Handlers to TR Change Notice

In this activity, you will modify the TR Change Notice process template toadd handlers necessary to attach the Affected/Solution Item folder contentsas targets of the workflow process.

Step 1: Access the TR Change Notice process.


Choose TR Change Notice from the Process Template list.

Select Edit Mode.

Choose Yes to take the process template offline.

Step 2: Add handlers to the Prepare Change task.

Select the Prepare Change task in the Task Hierarchy Tree.

Choose the Display the Task Handlers icon.


Select the Complete Task Action.

Set the Action Handler field to ECM-add-affected-irs-as-target.

Choose at the bottom of the dialog.


Change Management

The ECM-add-affected-irs-as-target handler is added to theComplete Task Action.

Re-select the Complete Task Action.

Set the Action Handler field to EPM-attach-related-objects.

Enter the following arguments:


Select the EPM-attach-related-objects Action Handler thatwas just created.

Change the Argument fields to:


Change Management


Again, select the EPM-attach-related-objects Action Handlerthat was just created.

Change the Argument fields to:


The Handlers panel should now look similar to the following.

Close the Handlers panel.

Step 3: Repeat Step 2 to add handlers to the Finalize Change task.


Change Management

Step 4: Save your work.

Make sure the Handlers window is closed.


Move the TR Change Notice template to the Available list.

Chose OK.

These handlers ensure that newly createdItemRevisions added to the affected/solutionItem folders will be added as process targets.



Change Management


• Created the Change Management (CM) Change Types.

• Added Handlers to a CM Workflow Process


Lesson

14 Command Suppression andBusiness Modeler

Purpose

The purpose of this lesson is to use the Business Modeler application to modelsite specific Rules associated with creating and revising data.

Objectives


• Grant or Deny access to specific functions using Command Suppression

• Create Type Display Rules

• Create Naming Rules

• Create Property Rules

• Create Compound Property Rules

• Create Extension Rules

• Create Deep Copy Rules

• Export and Import Business Rules

• Import Business Rules


Command Suppression and Business Modeler

Command SuppressionCommand suppression allows you to remove (suppress) one or more menuoptions from the default Teamcenter Engineering applications. This can beuseful if you determine that certain functions at your site should only beperformed by a particular Teamcenter Engineering role or group.

Some sites may choose to remove such menu options as Tools→Import fromapplication menus because they do not operate in a global environment.Conversely, large sites often allow all users to perform these actionsbecause they may have multiple Teamcenter Engineering sites. Commandsuppression allows each site to implement these and other TeamcenterEngineering functions according to their needs.

Command suppression is implemented as a tree of shown and hidden menuoptions for a defined Teamcenter Engineering role and/or group.

Users can change their group/role during a Teamcenter Engineering sessionby choosing Edit→User Setting...→Session. If they choose another Role orGroup, the appropriate menu entries will be hidden or shown.

Important Caveat

The following caveat applies to customizing Teamcenter Engineering withCommand Suppression:

• The Command Suppression dialog cannot be used to move options fromone menu to another or to add menu options. Menu entries can only besuppressed.



Command Suppression Dialog

You can use the Command Suppression application from the TeamcenterEngineering Admin application group to define which command entriesshould be suppressed for each defined Teamcenter Engineering role and/orgroup.

Choosing an application from the Application Tree (upper left pane)causes the Command Tree (right pane) to display the available menus andcommands for the selected application. Use the Organization Tree (lower leftpane) , select the group, role or group/role combination. From the CommandTree select a menu or command and choose the Show or Hide icons.

When finished defining the menus suppressed for a specific group and/or role,you must use File→Save. The Command Suppression definitions are savedas entries in the database.



Activity: Modify Command Suppression Definitions

In this activity, you will change the shown menu entries for the StandardsEngineer role.

Step 1: Set up Command Suppression for the Standards Engineer role.

Start the Admin/Command Suppression application (mayhave to use the More... option).

Under Applications, choose My Navigator.

Under Organization, expand the standards group and selectthe Standards Engineer role.

Step 2: Suppress the Import command under the Tools menu.

In the Command Tree on the right, expand the Tools menu.

Select Import.



Choose Hide.

Notice there is now a red line through Import.

Choose Save.

Step 3: Change your group and role to verify the suppressed entries.


Choose Session.

Select the standards group.

Select the Standards Engineer role.

Choose OK.

Choose OK for the message dialogs that result from yourchange in user status.

Step 4: Review the result of Command Suppression.


Select the Tools pull-down menu.



Notice the Import entry is missing.

You may need to close and re-open the My NavigatorApplication to view the effects.

Step 5: Change back to the dba group.

Choose Edit→User Setting... and change yours settings back tohe dba group and the DBA role.

Choose OK the save the settings and choose OK for any warningmessage dialogs that result from your change in user status.

Select Tools.

Notice the Import entry is present.

The Command Suppression for the StandardsEngineer role has been setup in the database.




Business ModelerBusiness Modeler is found in the Admin section of the Application Manager.This application is a menu-driven system that helps the TeamcenterEngineering Administrator perform tasks relating to business Rules creationin the Rich Client. The application allows you to define a set of business Rulesto help administrate the data model behavior in Teamcenter Engineering.You have the ability to change the Rules on the data model in TeamcenterEngineering by using menus instead of writing code.

The following are displayed as tabs in the Business Modeler application

Naming Rules Defines the naming conventions for the string propertyvalues of different type objects.

Deep Copy Rules Defines whether the Item Revision relational objectswill be copied as object, copied as reference, or notcopied when users perform Save-As and Reviseoperations.

CompoundProperty Rules

Allows defining run-time like properties on an objectreferencing and relating to a property on a sourceobject.

GRM Rules GRM (Generic Relationship Management) rulesprovides a way for an Administrator to form a rule (atriplet consists of primary type, secondary type andrelation type) and affiliate the following constraintswith it: Cardinality, Changeability, Attachability andDetachability (Cut/Paste Rules).

Type DisplayRules

Allow you to limit the types of objects that are availablefor creation for particular groups or roles-in-group.

IdContext Rules Determine behavior when creating alternate andalias identifiers by combining valid combinations ofidentifier type, ID context, and identifiable type.

Property Rules Allow you to control access to and the behavior ofobject properties.

Extension Rules Allow you to use custom functions and predefinedmethods to extend Teamcenter Engineering behavior.Defines the actions needed to be done in different timephases (pre-condition, pre-action and post action) fordifferent operations (Create, Save As, Delete).

In this lesson, we will cover some of the Business Modeler interfaces, butnot all.



Type Display RulesType display rules allow you to control the object types that are available forcreation in Teamcenter Engineering. These rules restrict the display of objecttypes in the creation dialog windows and can be applied to an entire site, aparticular group, or a specific role in a group.

Type Display Rules can be applied to the following base object types and theirassociated subtypes.

• Alias

• Dataset

• Folder

• Form

• Identifier

• Item

• MEActivity

• MEOP

• MEProcess

• MEWorkarea

Site, group, and role-in-group display rules are applied using the TypeDisplay Rules tab in the Business Modeler interface.



Activity: Creating Type Display Rules

In this activity, you will establish a Type Display Rule to hide Item andEndItem Item types from the Product Engineer role in the high_performancegroup. This rule will allow Product Engineers to only create Document andFunctionality Item types.

Step 1: Create the Type Display Rule.

Start the Admin/Business Modeler application.

Choose the Type Display Rules tab.

Expand the high_performance group listing in theOrganization table.

Select Product Engineer role.



With the Product Engineer role selected, select Item from thelist of Base Types. Choose Apply and close the Select Typeswindow.

Use the CTRL key to select both the EndItem and Item types inthe Shown Types list.

Choose to remove them from the Shown Types list.

Choose to save the rule.



Step 2: Test the Type Display Rules.


Log back in to the Teamcenter/My Navigator application.

Use the tracytr userid.

Notice, that the default role for tracytr in the high_performancegroup is Design Engineer

Select the Home folder, then choose File→New→Item..

Notice that all the Item types are available when using theDesign Engineer role.



In the User Settings window, change the Role to ProductEngineer.



Choose OK to save the settings and close the window.

Select the Home folder, then choose File→New→Item..

Notice, this time that only the Document and FunctionalityItem types are available using the Product Engineer role.


Log out of Teamcenter Engineering and log back in using yourstudent (privileged) userid.




Naming RulesNaming Rules allow you to specify valid patterns for naming conventions forItems, Item Revisions, Datasets, and Forms. End users will get an errormessage if the value entered does not match the pattern. At the same timeNaming Rules can be used to force conversion of user input to all uppercaseor all lowercase characters and is used to define the result of using the Assignfeature of New Item and Dataset dialogs.

Naming Rules can be attached to the following properties:

• Item ID, Item Revision ID, and Name in Item types

• Dataset Name, ID and Revision Number in Dataset types

• Name in Form types

Naming Rules allow you to define the pattern for generating IDs. For certainproperties like Item ID and Revision IDs, when you click the Assign icon, thesystem generates the ID, based on the pattern defined.

The Naming Rule Operation panel has two tabs. These tabs are:

• Edit Naming Rule - Define a Naming rule, with patterns to be matched.

• Attach Naming Rule - Attach a Naming rule to a property.



Creating a Naming Rule

• Enter a new Naming Rule name.

• Select the Create icon.

• Add Patterns to the Naming Rule.

• Select the “+” icon with the Naming Rule selected from the list.

• Add acceptable patterns to the Naming Rule using the following format

• Select OK.

• Toggle on Generate Counters and fill in initial and maximum values ifappropriate.



Attaching a Naming rule.

• Select the Object (Item ID, Rev ID, Name, or Description for Items)

• Select the Case needed.

• Select the rule from the list.

• Select attach.



Activity: Creating and Attaching Item Naming Rules

In this activity, you will establish the following Naming Rules for the Itemtype Item.

Item ID: @NNNNN

@ = alpha character: P(production), T (test) or L(layout)

NNNNN = five numericcharacters

Example: P12345, T12345,L12345

Initial value: P00001

Max value: P99999

Convert user input to uppercase

Item Revision ID: NNN

NNN = three numeric characters

Example: 000, 001, 002

Initial value: 000

Max value: 999

Item Name: Free form user input

Convert user input to uppercase

Step 1: Create the Naming Rule for Item ID.


Make sure the Edit Naming Rules tab inside the Naming Rulestab is selected (default).

Type Item ID in the Rule Name field, and then choose the

Create icon (far right).



Choose to create the first pattern definition.

The Add Rule Pattern dialog appears.

Enter "P"NNNNN (no spaces) in the top field of the Add RulePattern dialog.

Choose OK.

This adds the first allowed pattern to the display.

Choose to create the second pattern definition.

Type "T"NNNNN (no spaces) in the top field of the Add RulePattern dialog.



Choose OK.

This adds the second allowed pattern definition to the display.

Choose to create the third pattern definition.

Type "L"NNNNN (no spaces) in the top field of the Add RulePattern dialog.

Choose OK.

This adds the third allowed pattern definition to the display.

Toggle Generate Counters to ON and provide the following:

Initial Value: P00001

Maximum Value: P99999




Step 2: Create the Naming Rule for Item Revision ID.

Use the drop-down selector for Rule Name to choose the blankline.

Enter Item Revision ID in the Rule Name field.

Choose Create.

Choose to define the pattern definition.

Type NNN in the top field of the Add Rule Pattern dialog.

Choose OK.

This adds the pattern definition to the display.



Toggle Generate Counters to ON and provide the following:

Initial Value: 000

Maximum Value: 999


Step 3: Create the Naming Rule for Item Name.

Use the drop-down selector for Rule Name to choose the blankline.

Enter Item Name in the Rule Name field.

Choose Create.

This rule does not have a Pattern or a GenerateCounters definition. However it is necessary to createthis rule so that when attached, the user input datacan be forced to be all uppercase.

Step 4: Attach the Naming Rule for Item ID.

Choose the Attach Naming Rules tab.



Expand the Item Class and Item Type nodes.

Select Item ID from the list (in the bottom window).

Set Case to Upper, then select Item ID from the Rule Namedrop-down list.

Choose the Attach icon.



Step 5: Attach the Naming Rule for Item Revision ID.

Select Item Revision ID from the list.

Choose Item Revision ID from the Rule Name drop-down list.


Step 6: Attach the Naming Rule for Item Name.

Select Name from the list.

Set Case to Upper.

Choose Item Name from the Rule Name drop-down list.


Step 7: Close the Business Modeler application.




Activity: Test Item Naming Rules

In this activity, you will test the Item Naming Rules created and attached inthe preceding activity.

Step 1: Test the Item Naming Rules setup.


Select your Home folder, then choose File→New→Item.

Select Item for the Item Type, then choose Next.

Choose the Assign icon.

Notice the automatic format of the ItemID and Rev fields.

Enter test item (lowercase) in the Name field.



Notice the Name has been converted to uppercase.



Try to create an Item by manually inputting the followingparameters:

ID = t12345

Rev = 000

Name = test item

You are able to create the Item because the “t”, along withthe 5 numeric characters, fit the format, therefore the “t” isconverted to upper case.

Try to create an another Item by manually inputting thefollowing parameters:

ID = m12345

Rev = 000

Name = test item

You should NOT be successful because “m” does not satisfy thealpha character requirements.

Choose More.

This message lists the valid Item ID requirements.

Choose OK to dismiss the message.

Choose Back.



To quickly check what format the Item ID should be, place thecursor in the Item ID field and a hint will appear.

This works the same for the Revision field.





Property and Compound Property Rules

Property Rules

Property rules allow you to control access to and the behavior of objectproperties. You can control whether a property is modifiable, visible, enabled,or required. In addition, you can set an initial value for a property and definecomplex properties comprised of a combination of properties and constantstrings that assign a value to the property. Once configured, property rulesapply to properties as displayed in both the Rich Client and Thin Clientinterfaces. Property rules defined on base Property rules defined on basetypes are inherited by subtypes. For example, a property rule defined on theItem type is inherited by the Document type.

The following rules can be applied to object properties:

Modifiable Allows you to place restrictions on the modifiability of an objectproperty. The following restrictions can be applied:

Read Only – Allows users to view the value of the property but doesnot allow them to modify the value.

Write – Allows users to modify the value of the property if they havewrite access to the object to which the property belongs.

Write Only if Null – Allows users to modify the property only if theexisting value is null, or empty.

InitialValue

Allows you to specify the initial value to be assigned to a propertywhen the corresponding object is created. The initial value ruleapplies only to the following object types: Item, ItemRevision, Alias,Identifier, Dataset, and Form.

Visible Allows you to specify whether a specific object property is visiblein the interface. For example, you can add runtime properties forinternal purposes and set the visible rule to False to hide them fromusers. Valid values: True and False.

Enabled Allows you to specify whether a property is enabled in the interface.Valid values: True and False.

Required Allows you to specify whether a value must be entered for a specificobject property. Applies only to: Item, ItemRevision, Alias, Identifier,Dataset, and Form. Valid values: True and False.

Complexproperty

Allows you to specify a combination of properties and constantstrings to assign a value to a selected property. Complex propertiesare derived from one or more properties depending on the pattern ofthe rule, for example $prop1+"string literal"+$prop2. Applies onlyto: Item, ItemRevision, Alias, Identifier, Dataset, and Form.



Compound Property Rules

The Compound Property Rules functionality enables you to add newproperties to Teamcenter Engineering Types without custom coding andwithout having to use the Run-time Properties functionality. However,Compound Property Rules is not a complete alternative to Run-timeProperties. In more complex scenarios, tou may still prefer to use Run-timeProperties to add complex properties to Teamcenter Engineering Types.

What is a Compound Property?

A Compound Property is a property that can be displayed on an object, thoughit is actually defined and resides on another object.

The following terms are used for Compound Properties.

Display Object The object on which the CompoundProperty is displayed.

Source Object The object on which the propertyactually resides.

SourceProperty

The property on the Source Object.

A Compound Property on an object displays the following behavior:

• Has default SET and ASK methods.

• Inherits access rules from the Source Object.

• By default, the read/write permissions of a Compound Property on theDisplay Object is the same as that of the Source Object. You can changethe Compound Property’s protection on the Display Object.

• If the Source Property is modifiable, then the Compound Property willalso be modifiable. However, if a ReadOnly flag is set on the CompoundProperty Rule, the Compound Property will be a non-modifiable propertyeven if the Source Property is modifiable.

• Appears disabled on the Display Object, if the property on the SourceObject is not modifiable.

• A default string (such as "****") will be displayed on the Display Object toindicate that the property is not readable, if the property on the SourceObject is not readable.



• A Compound Property’s name and the UI display name can be differentfrom the property name and property UI display name on the SourceObject.

• The value type of a compound property is the same as that of itssource property. For example, if the value type of the Source Propertyis PROP_string, then value type of Compound Property will also bePROP_string.

• If the Source Property is a VLA (Variable Length Array), then thecompound property will also be a VLA.

• If an LOV is attached to the Source Property, the same LOV will beattached to the Compound Property as well.

• If the user does not have Write privileges on the object on which theCompound Property exists, then the Compound Property will be anon-modifiable property.

• If the user does not have Write privileges on the object on which theSource Property exists, then the user cannot modify the value of theCompound Property.

• To obtain the value(s) of the compound property, the system will traversethe object hierarchy mentioned in the compound property rule. Whiletraversing the object hierarchy, if the system fails to reach the SourceProperty, the value of the Compound Property cannot be retrieved. Anerror message will be displayed and the value will be displayed as ablank field.



Activity: Creating Item Property Rules

In this activity, you will first create a Property Rule that establishes a defaultDescription for the Item type Item. Second, you will modify the Property Ruleto remove the default Description and create a Description automaticallywhen an Item is created.

Step 1: Create the Property Rule for an Item type.


Select the Property Rules tab.

Select the Item class from the list.

Choose on the far right to create an empty row.

Select in the Property Name field to access the LOVs, and thenchoose object_desc from the list.

Select in the Modifiable field to access the LOVs, and thenchoose Write from the list.



Enter Company Part in the Initial Value field.

Make sure the Visible field is checked, with the other fieldsunchanged.


Step 2: Test the Default Description Property Rule.






Notice the Description is already filled in with Company Part,which was defined by the Property Rule just created.

Choose Assign to populate the ItemID and Revision fields.

Enter test rule in the Name field.

Change the Description to Test Company.





In the Home folder, right-click on the newly createdItemRevision and choose Properties... from the list.

Scroll down in the Properties window and notice that theDescription is Test Company.

This validates that the Default Description of Company Part,set by the Properties Rule, is still allowed to be changed, duethe Modifiable field set to Write.


Step 3: Change the Property Rule to set an unchangeable Description.

Go to the Admin/Business Modeler application.





Remove the text from the Initial Value field.

Change the Modifiable field to Read Only.

In the Complex Property field, enter: $item_id+”/CompanyPart/”+$object_name

Make sure the Visible field is checked, with the other fieldsunchanged.

Choose .

Step 4: Test the modified Property Rule.






Notice this time, the Description is blank because the InitialValue field was cleared.

Choose the Assign icon to populate the ItemID and Revisionfields.

Enter test rule in the Name field.

Try to enter Test Company in the Description field, and notethat you cannot edit it. This was not allowed due to theProperty Rule





In the Home folder, right-click on the newly created Item andchoose Properties... from the list.

Scroll down in the Properties window and notice that theDescription is ItemID/Company Part/TEST RULE.

This validates that the Properties Rule is working. It createda description from the ItemID, Company Part (text), and theItem Name, established from the criteria in the ComplexProperty field.




Step 5: Clear the Property Rule on the Item class.

Go to the Admin/Business Modeler application.



Select any of the fields to select the whole rule.

Choose the icon on the far right to remove the fields.

Choose .




Activity: Creating Compound Property Rule between EndItem propertiesand Items

In this activity, you will first create a Compound Property Rule on the ItemMaster form that attaches the Customer and Shipped attributes createdearlier for the EndItem Master form.

Step 1: Create the Property Rule for an Item type.

Choose the Compound Property Rules tab.

Expand the Item class in the Rules tree list and select theEndItem Type.

Notice, the list of available attributes for the EndItem Type aredisplayed in the Rule Operation panel (on the right).



In the Rule Operation panel, expand Item Masters.

Expand the EndItem Master and Attributes nodes, and selectthe Customer property.

Change the Compound Property Name to AA-Customer.

Choose on the left side of the Rule Operation panel tocreate the new Compound Property Rule.



The Compound Property is attached to the EndItem.

Again, under EndItem Master, do the same for the PartTypeand Shipped Attributes Properties.

Now, three of the EndItem Master form properties are attachedto the EndItem.

Step 2: Test the Compound Properties.


In your Home folder, select EndItem EI001.

Choose View→Properties....



Scroll to the bottom of the Properties window and choose

More... (on the left).

Scroll to the top of the Properties window and notice that thenewly attached EndItem properties are displayed.

Set the AA-Customer property to Customer A, the AA-PartType to Machining, and AA-Shipped property to true.

Choose OK.




Extension Rules

Extension Rules

Remove later: BMF_SUPPRESS_ACTION_RULES_DISPLAY (value=ONor OFF) to display Action rule tab

Extension rules allow you to customize system behavior by applyingextensions to extension points that are related to business operations inTeamcenter Engineering. Business operations are actions performed in thesystem, such as creating and saving an item, fetching or setting a propertyvalue, or invoking a user exit.

Extension points are events in the system, such as a postaction on anoperation or a user exit, that allow you to implement custom behavior.Extensions contain information about functions associated with TeamcenterEngineering types and properties.

Business operations can expose one or more extensions points, which in turncan contain zero or more extensions. Extensions within an extension pointdisplay the following characteristics:

• Extensions can be arranged to execute in a specific sequence.

• Each extension can have a set of arguments that is unique within theextension point.

• Extensions can be activated and deactivated within an extension point.

• External extensions can be configured in the same manner as the coreextensions delivered with the Teamcenter Engineering product.

• An extension can be included more than once in a single extension pointand can also be included in multiple extension points.

• User exit operations can only be configured from the base extension point.

Extension Rule Inheritance

Extensions on type operations defined for or assigned to a parent type areinherited by any and all subtypes of that type. For example, if the Documentitem type has two derived subtypes, SpecDocument and QADocument,any extensions defined for the Document item type are inherited by theSpecDocument and QADocument subtypes. Extensions can also be definedspecifically for a particular subtype. These extensions exist in addition to anyextensions inherited from the parent object type. By default, subtypes inheritthe extension rules from a parent type higher in the hierarchy. To overridethis default behavior, a subtype can be selected and have extension rulesconfigured. In this case, all existing extension rules from the super type of theextension point are copied to the type in which the extension is configured. At



that point, modification of the extension rules on that super type for the givenextension point are no longer propagated down to this subtype.

To remove any override that is configured, remove all configured extensionsfrom the subtype and apply the changes. You are prompted to confirm thatyou are removing the override and that rules are again inherited from theparent type

Defining Extensions

External extensions can be defined to customize Teamcenter Engineeringbehavior. Before defining the extension in Business Modeler, you must firstwrite the custom function in C or C++ and store it in a either a common libraryor a specific library. You can define a single library or multiple libraries tostore the functions that you associate with extensions. For more information,see the Integration Toolkit (ITK) Programmer’s Guide. In addition, you mustdetermine the parameters that are passed to the program when it is executed.

Specify the values for these parameters when you assign the extension.Values can be user-defined or derived from a saved query or List of Values(LOV). When defining the extension, you must also specify the typeoperations, property operations, and extension points for which the extensionis valid.

Assigning Extensions

This section describes the process used to configure defined methodextensions, including:

• Displaying, adding, modifying, or removing extensions from an extensionpoint.

• Specifying argument values for defined arguments of an extension inan extension point.

• Ordering the extensions configured for a specific extension point.

• Activating an extension within an extension point.

• Overriding extension assignments inherited from a parent type.



Some extension points for primary types have configured internalextension rules. Although these extensions are visible in theextension assignment table, they must not be removed. If youoverride this operation for a subtype, the internal rule is inherited bythe subtype and you must take care that it is not deleted by default.

For example, the ImanRelation::assert_unique internal extensionis configured for the ImanRelation – Create – Pre-Conditionextension point. This cannot be removed. If a relation type,for example, Iman_Specification, has this overridden, theImanRelation::assert_unique extension is configured for theIman_Specification relation by default. You must not remove thisextension from the extension point.

List of existing values for the BMF_CLASS_AND_TYPE_DISPLAY_LISTpreference.

• Appearance, BOMLine, ERP, File, FileServer, ImanQuery, ImanRelation,PLMXML, PublicationRecord, PSOccurrence, Report, Session,SingleFileRecovery, Site, StorageMedia, User, ValidationResult, View

Internal Extensions

There are two varieties of extensions: internal extensions and externalextensions. Internal extensions are predefined methods delivered as part ofthe Teamcenter Engineering product. These extensions cannot be modified.External extensions are custom extensions that you add to the database.

The following internal extensions are delivered as part of your TeamcenterEngineering installation:

• autoAssignToProject

• checkLatestReleased

• copyVariantExpr

• createCAEObjects

• createObjects

• setIdentifierProperties



Activity: Default Item Create and Display Behavior

In this activity, you will observe default Item create and display behavior andmodify preferences that control the Item display behavior.

Step 1: Create Document Item.


Select Document for the Item Type, then choose Next.


Enter Test Document in the Name field.

Choose Finish to create the Document, then close the NewItem dialog.

Expand the Document and Document Revision objects.

Observe that the default objects created when an DocumentItem is created, are Document Master and Document RevisionMaster forms.

Step 2: Modify Document display preferences.

Choose Edit→Options...

Select Item in the General list.



On the General tab of the dialog, set Select item type toDocument.

Select Item Masters in the Shown Relations window, then

choose .

Choose Apply on the Options dialog.

Observe the difference in the Document display.

Before:

Document Master form isdisplayed.

After:

Document Master form isnow hidden.

Select Item Revision in the General list of the Options dialog.

On the General tab of the dialog, set Select item revision typeto DocumentRevision.



Using the Ctrl key, select ItemRevision Master, engineering,and Release Status in the Shown Relations window.

Choose to remove them from the Shown Relations list.

Choose Apply on the Options dialog.

Observe the difference in the Document display.

Before:

DocumentRevision Masterform and view are displayed.

After:

DocumentRevision Masterform and view are nowhidden.

Choose Cancel on the Options dialog.

In this activity, you observed that the default Itemcreate function creates four objects (Item, Item Master,ItemRevision, and ItemRevision Master). You alsoused the Options dialog to hide the two Master formsand the engineering psuedo folder in the display.

In the next activity, you will use the BusinessModeler application to extend the create actionfunctions for Items of Type = Document.




Activity: Assign an Extension Rule

Since writing programs and defining the extension rules for those programsis beyond the scope of this course, in this activity, you will use the BusinessModeler application to assign an existing extension rule (shipped withTeamcenter Engineering) to modify the Create and Revise characteristics fora Document ItemRevision. The modification will :

• Automatically create a Text dataset for the Document Revision whenit is created.

• Only allow a single Working (no Release Status) Document Revision.

Step 1: Review an existing predefined Extension Rule.


Select the Extension Rules tab.

Select the Define Extensions tab.

Select createObjects from the list of Defined Extensions.

Notice the different Extension Details fields, such as, the typeof programming language the extension was written in andwhether it is an internal or external extension.



Also, notice the different actions available to the createObjectextension.

Step 2: Assign an Extension Rule to cause automatic creation of Textdatasets when Document Revisions are created.

Select the Assign Extensions tab next to the Define Extensionstab.

In the Extension Point Selection tree, expandthe WorkspaceObject→ItemRevision and selectDocumentRevision.

Make sure the Type or Property option is set to Type.



Set the Operation option to Create Revision and the ExtensionPoint option to Post-Action.

Choose to add a new line in the select types panel.

Double-click in the Extension Name field and selectcreateObjects from the list.

In the new fields that appeared, set the objectType Text andthe relationType to Specifications.

Choose to add the settings in the Arguments field.



Notice that the settings are also added in the select types panel.

Choose Apply.

Choose Yes on the Override warning.

Step 3: Assign and Extension Rule to prevent more than a single WorkingDocument Revision.

With the DocumentRevision still selected, leave the Operationset to Create Revision, but change the Extension Point toPre-Condition.

Choose to add a new line in the select types panel.

Double-click in the Extension Name field and selectcheckLatestReleased from the list.

In the new fields that appeared, in the maxAllowedWorkRevsfield, enter 1.

Choose to add the settings in the Arguments field.



Notice that the settings are also added in the select types panel.

Choose Apply.

Step 4: Repeat the previous set-up for checkLatestReleased using theRevise and Pre-Condition options.

Use the following settings.

When finished, close the Business Modeler application.




Activity: Test Extension Rule Assignment

In this activity, you will test the assigned Extension Rule for the Create andRevise characteristics for the Document Item, which will:

• Automatically create a Text dataset for a new Document Revision.

• Only allow a single Working (no Release Status) Document Revision.

Step 1: Test automatic Text dataset creation.


Select your Home folder, then choose File→New→Item...



Enter Test Extension Rule in the Name field.

Choose Finish to create the Document Item, then close theNew Item dialog.


With the Extension Rule assigned, the Text dataset wascreated automatically when the Document Item was created.

Step 2: Test prevention of multiple Working Document Revisions.

Select the Document Revision object

Choose File→Revise...

Notice that by default, the Revision field is automaticallypopulated with B.

Choose Finish.



The following error dialog appears because you are attemptingto create the next revision (B) of the Document before thecurrent revision (A) has a status.

Choose OK to dismiss the error dialog, then Close the NewItem dialog.

Select the Document Revision object.


Set the Process Template to Quick Release, then choose OK.

You may need to choose View→Refresh to observe theapplication of Status.

Select the Document Revision object again.


Notice again that the Revision field is automatically populatedwith B.

Choose Finish.


This time the Revise action was successful.




Deep Copy RulesDeep Copy Rules are used in conjunction with the creation of Item Revisionsusing the Save As and Revise menu commands. The setup of Deep CopyRules defines what happens to the contents of the Item Revisions (Datasets,Folders, and Forms, for example).

The Deep Copy Rules tab is used for the Deep Copy System Administration.It provides a method to set Relation/Type objects that the user can copy fromone revision to another and in what manner will the data be copied. DeepCopy Rules are only applied to different Item Revision types.

There are three kinds of "Copy" behaviors possible:

• Copy as Object - A brand new object of the same type and relation asthe original object is created. An object created by this method will betotally independent of the original object. This essentially means that anychanges in the copied object will not be reflected in the original object.

• Copy as Reference - When the Deep Copy Rule specifies Copy asReference a new object is not created for the new Item Revision. A newreference of the same object is added to the new Item Revision.

• Don’t Copy - If any of the attachments are specified as Don’t Copy, thenthese attachments will not be copied forward to the newly created ItemRevision either as a new object or an added reference.



Activity: Observe Default Item Revise and Save As

In this activity, you will observe the default Rules for the Item Revise andSave As commands.

Step 1: Observe default Rule for the Revise command.

In the last activity, you used the Revise command to createRevision B of your Test Extension Rule Document.

Expand Revision B of your Document.

Notice that the Revise command did not create a new Textdataset. The same dataset that is referenced in Revision A, isalso referenced in Revision B. The default for the Item Revisecommand is to Copy Reference for all objects contained in theItem Revision.

Step 2: Observe the default Rule for the Save As command.

The Save As command is used when a user wishes to create a newItem (ID vs. Rev) from the definition of an existing Item Revision.

Highlight Revision B of your Test Extension Rule Document.

Choose File→Save As...

Choose Assign to generate a new unique ID and initial Rev ID.

Change the Name to Default Save As.

Choose Finish, then close the New Item dialog when the Itemhas been created.



Because you had a Document Revision selected when you createdthe new document, a reference of the new Document is not addedto the selected object. Instead, the reference is added to yourNewstuff folder.

Fully expand the Document and Document Revision object inyour Newstuff folder.

Like the Revise command, the Save As command did not create anew Text dataset. The same dataset that is referenced in RevisionB of the first Item is also referenced in Revision A of the new Item.The default for the Item Save As command is to Copy Referencefor all objects contained in the baseline Item Revision.

In the next activity, you will use the Deep Copy componentof the Business Modeler application to changethe default Copy Reference behavior to Copy Object.




Activity: Create Deep Copy Rules for Items

In this activity, you will create Deep Copy Rules for the DocumentRevision toCopy as Object objects with relation of IMAN_specification.

Step 1: Define Deep Copy Rules for DocumentRevision Save As.


Choose the Deep Copy Rules tab.

Expand the ItemRevision node in the Deep Copy Rules tree,and select DocumentRevision.

Select Save As.

In the dialog, set Relation Types to Specifications.

Check the Required check box.

Choose to the right of the Copy As Object window.

Your window should look like this.

Choose Apply.

Choose Yes to save the change.

Establish the same Rule as above for the Revise command forDocumentRevision.

Step 2: Close the Business Modeler application.




Activity: Test Deep Copy Rules for Items

In this activity, you will test the Deep Copy Rules for the DocumentRevisionto Copy as Object objects with relation of IMAN_specification.

Step 1: Start the Engineering/My Navigator application.

Step 2: Test the Deep Copy Rule for Revise.

Select your Home folder, then choose File→New→Item...



Enter Test Revise in the Name field.

Choose Finish, then Close the New Item dialog.


Highlight the Document Revision object.



Observe the application of status.

Select the Document Revision object (only).


Choose Finish, then close the New Item dialog.



This time, the Revise command has created a new Text dataset.

The Revise command did create a new dataset,however, the name of the new dataset is the same asthe original. You can tell it is a new dataset because itdoes not have a Status flag, like the original dataset.The name of the new dataset could be changed to adifferent value using the Properties dialog

In the last activity, the Revise command did not create a newText dataset.

Last activity:

Step 3: Test the Deep Copy Rule for Save As.

Select Revision A of your Test Revise Document.

Choose File→Save As...

Choose Assign to generate a new unique ID and initial Rev ID.

Change the Name to Test Save As.

Choose Finish, then close the New Item dialog.



Because you have a Document Revision selected while you arecreating a new Document, a reference of the new Document isnot added to the selected object. Instead, the reference is addedto your Newstuff folder.

Fully expand the Test Save As Document and DocumentRevision object in your Newstuff folder.

This time, the Save As command has created a new Textdataset.

Like the Revise command, the Save As command didcreate a new dataset, however, the name of the newdataset is the same as the original. Again, you can tellit is a new dataset because it does not have a Statusflag, like the original dataset. The name of the newdataset could be changed to a different value using theProperties dialog

In the last activity, the Save As command did not create a newText dataset.

Last activity:




Business Modeler Import/Export RulesThe Business Modeler Application gives you the capability to import andexport Business Rules. This allows Business Rules configured and appliedat one company site to be exported to an XML file and imported into theBusiness Rules Application of a different company site.

Importing Business Rules may overwrite the existing Business Rulesconfiguration at a site. To avoid overwriting the Business Rules configurationat the current site, it is strongly recommended that the current configurationbe exported to another XML file, which can then be compared or mergedwith the new XML file intended to be imported. The merged XML file can beimported into your Business Modeler to apply the new configuration.



Activity: Use the UI to Export Business Rules

In this activity, you will interactively export the current Business Rulesdefined in the Business Modeler application.

Step 1: Export All Business Rules

Open the Admin/Business Modeler application.

Choose Export (bottom right).

In the Export window, make sure All Business Rules ischecked.

Navigate OS directories to the ...aa_class/business_rulesdirectory.

Enter all_business_rules.xml in the File Name field.

Choose Export.

Locate and open the all_business_rules.xml file in a text editor.

After reviewing the file, close the text editor.



Step 2: Export Naming Rules only.

In the Business Modeler application, again choose Export.

Make sure only the Naming Rules button is toggled on.

Verify you are still in the ...aa_class/business_rules directory.

Enter naming_rules.xml in the File Name field.

Choose Export.

Locate and open the naming_rules.xml file in a text editor.

After reviewing the file, exit the editor without saving.




Activity: Use the UI to Import Business Rules

In this activity, you will interactively import a Naming Rules file that willdetach the Item ID, Item Revision ID and Item Name naming rules from theirrespective data objects. This must be done in order to return to the defaultnaming rules for the remainder of the course.

Step 1: Access the Import window.

In the Business Modeler application, make sure the NamingRules tab is selected.

Choose .

The Import window appears.

Step 2: Access the naming rules import file.

In the Import window, navigate to the...aa_class/business_rules directory.

Select the undo_naming_rules.xml file.

Choose Compare and Import.

Choose Import.



The Business Rules Import Comparison Dialog appears.

This window allows you to analyze the differences between theexisting Naming Rules and the ones to be imported. You candisplay both Old and New together or just the differences inthe rules. You can also display just the New rules or just theOriginal rules.

Step 3: Analyze the differences in rules and then import the rules.

Make sure Display as Old/New is set.



Scroll down to view the differences in the existing rules on theleft and the rules to be imported on the right.

Choose OK to import the Naming rules.

Step 4: Verify that the Naming Rules are detached.

Select Item in the Naming Rules tree.



Expand the Item Class and Item Type nodes.

Select Item ID from the list.

There should be no rule listed.

Select Item Revision ID and Item Name from the list to makesure there are no rules attached.

Close the Business Modeler application.




The import_export_business_rules utility

Another method provided by Teamcenter Engineering for bothimporting and exporting business rules to and from the database is theimport_export_business_rules utility. This utility allows for the importingand exporting of business rules without having to log into the BusinessModeler application in the Rich Client interface.

As with the interactive import function, the import_export_business_rulesutility may overwrite existing Business Rules. To avoid the possibilityof losing existing rules, one recommended method is that the currentconfiguration be exported first (as a backup) and then merged with the (newrules) XML file to be imported before using the import_export_business_rulesutility. The exception may be if using the –merge_add option. Still, as aprecaution, it is good practice to export (to save) all rules before making anymodifications to the existing Business Rules using the import functions.

The syntax is as follows.

import_export_business_rules-u=userID-p=password-g=group-file=xml_file_name-action=import

[-merge_add] | -merge_replace | -replace]-action=export

[-type=type_name][-rule=(valid_rule_class_name)]

-h




• Managed access to specific functions using Command Suppression

• Created Type Display Rules

• Created Naming Rules

• Created Property Rules

• Created Compound Property Rules

• Create Extension Rules

• Created Deep Copy Rules

• Interactively Exported Rules Definitions

• Interactively Imported Rules Definitions

• Reviewed the import_export_business_rules utility


Lesson

15 Setup for NX Integration

Purpose

The purpose of this lesson is to configure your system for NX specificrequirements.

Objectives


• Make Decisions Regarding the NX Data Model at Your Site

• Setup Seed Part Files for NX

• Define NX -to- Teamcenter Engineering Attribute Mappings

• Set NX Integration Preferences and Options

• Use Unique Process Template Features for NX Data


Setup for NX Integration

TerminologyThe table below lists several NX terms along with the correspondingTeamcenter Engineering term.

Unigraphics Teamcenter EngineeringPart ItemPart Revision Item RevisionPart File DatasetPart Number Item IDMaster Part File UGMASTER DatasetNon-master PartFile (specification ormanifestation)

UGPART Dataset

Non-master Part File(altrep)

UGALTREP Dataset

Component OccurrenceLock (part file geometry) Check-Out (Dataset)Unlock (part file geometry) Check-In (Dataset)Lock (part file structure) Check-Out (BOMView

Revision)Unlock (part file structure) Check-In (BOMView

Revision)

When you work in NX, you manipulate Parts, Part Revisions and Part Files.These correspond to Items, Item Revisions and Datasets in the TeamcenterEngineering.



Item Structure and Named ReferencesThe figure below shows the typical structure of an Item that contains NXdata. This is the 2111 Frame part, currently with a 000 ItemRevision.

Inside the ItemRevision is the 2111/000 UGMASTER for the master part file.Additionally the ItemRevision contains the 2111_DWG and 2111_MFG forthe non-master drawing and NC programming part files.

Each dataset contains files, or named references.



The named references for the 2111 datasets are shown below.

NamedReferencesfor2111_DWG

NameReferencesfor2111_MFG

NameReferencesfor 2111–000



BOM Views and BOM View Revisions

BOM Views are used to manage product structure information for an Item.Similarly, BOM View Revisions are used to manage product structure forItem Revisions.

When you add a component to an assembly, you are creating an occurrenceof that Item or Item Revision in the assembly. This occurrence is displayedas a line in the BOM.

Each assembly revision has its own BOMView Revision (BVR). If you expandan Item Revision in Teamcenter Engineering, you will see the BOMViewRevision, which is the object in which the occurrence information is stored.

The BOMView Revision for the 2105/000 Frame Assembly is shown below.



Create Part FilesThis section describes what happens in the Teamcenter Engineering databasewhen you create a new part file in NX when running in NX Integration mode.

Note that the database is only affected when you save a new part file. If youcreate a new part in your NX session, and then terminate the session withoutsaving it, no new Items, revisions or datasets are created in the database.

Brand New Part

When you create a brand new part (that is, a new master part file, with a newpart number and a new part revision) in NX and save it, an Item, its firstItem Revision and a UGMASTER Dataset are created in the TeamcenterEngineering database. The dataset is referenced as a specification of thenew Item Revision.

The following information concerning Item and dataset creation applieswhenever a new Item Revision is created from NX; such as in the File→Newand File→SaveAs operations.

The table below shows the values which NX sets in the TeamcenterEngineering fields that you would usually fill when you create an Item and adataset from Teamcenter Engineering.

Field Value set by NXItem ID Part Number specified by user in the

NX Integration Part Selection dialog.Item Name Part Name specified in the Edit

Database Attributes dialog.Revision ID Revision specified in the Part Selection

dialog.Itemdescription

Part Description specified in the EditDatabase Attributes dialog.



New Part Revision

When you create a new revision of an existing part in NX and save it, a newItem Revision and a new UGMASTER Dataset are created in the TeamcenterEngineering database.

The values which NX Integration sets in the Teamcenter Engineering fieldsthat you would usually fill when you create an Item and a dataset fromTeamcenter Engineering are shown in the table on the previous page. Notethat the dataset is referenced as a specification of the new Item Revision.

The values which the system sets used for necessary fields are the same asgiven above for new parts.

New Non-master Part File

When you create a new non-master part file for an existing part revision inNX, a new UGPART Dataset or UGALTREP Dataset is created in TeamcenterEngineering. The name given to the new UGPART dataset is the name whichyou specify in the NX Integration Part Selection dialog.

You choose a part file type with Part File Type in the Part Selection dialog. Ifthe file type is specification, the new dataset is referenced as a specification inthe Item Revision. Similarly, if you specify a part file type of manifestation,the dataset is referenced as a manifestation in the Item Revision.

The following table shows which dataset and relationship types correspondto each of the part file types.

Part File Type Dataset Type RelationshipType

master UGMASTER specificationspecification UGPART specificationmanifestation UGPART manifestationaltrep UGALTREP altrep



Storage of Associated FilesAssociated (dependent) files are files which are related to a part file, butare separate from it. For example, you may have produced a shaded imageof your part in NX. The shaded image is stored as a file with the extension.tif. This file is separate from the part file, but is related to it (because it is animage of your part).

Associated files are stored in a dataset with the NX part file in TeamcenterEngineering. They are stored as named references in the dataset. The namedreferences specify the different types of file you can store with the part file.

When you open a part file from NX with file export enabled, NX Integrationcreates a directory for the part and exports the associated files governed bythe current NX Integration role to that directory. The NX part files with the.prt suffix are not exported.

When you save or close the part file, any new or changed files in the directoryare saved in the Teamcenter Engineering dataset corresponding to the NXpart file.



Access ControlNX Integration locks the geometry for a NX part file as soon as you start tomodify it. If the part is a master part file (and an assembly), the structurealso becomes locked. The locking ensures that no other user can modify thepart file at the same time.

When you create a new non-master part file in NX, you must have writeaccess to the Item Revision, otherwise the reference to the newly createddataset cannot be added. Similarly, when you create a new part and place itinto a folder, you must have write access to the target folder, otherwise thereference from the folder to the new part cannot be created.

Access and Locking Geometry

When checking your access rights for a NX part file, NX Integration looks atthe protections on the corresponding dataset in Teamcenter Engineering. Ifyou have write access to the dataset, then you are granted write access to thepart file in NX.

When NX Integration locks the geometry for a part file in your NX session,what is actually happening in the database is that the dataset correspondingto the part file is being checked out. When NX Integration unlocks the partfile’s geometry, the Teamcenter Engineering dataset is checked back in.

Locking Structure

When NX Integration locks the structure for a part file, the correspondingBOM View Revision is locked in the database. The structure locking is carriedout in the same way that Teamcenter Engineering PSE locks structure, sothat PSE inter-session locking on product structure can be maintained.



UGMASTER / UGPART BehaviorWe recommend that you always use UGMASTER datasets with NXIntegration for master part files; especially for parts that are used ascomponents in an assembly. If you need to use UGPART datasets instead of(or in addition to) UGMASTER datasets, you need to be aware of the followingimportant differences in the way the datasets are used in TeamcenterEngineering.

Master File

• A UGMASTER dataset should be created only in the context of an ItemRevision.

• One and only one UGMASTER dataset should be referenced as aspecification of a particular Item Revision.

Non-Master File(s)

• More than one UGPART dataset may be referenced as a specificationof an Item Revision.

Loading from NX Integration

• When NX Integration loads a specific Item Revision as a component ofan assembly, it looks first for a UGMASTER dataset referenced by therevision as a specification. If it cannot find one, it loads the first UGPARTdataset that it finds in the list of objects referenced as specifications.

• NX Integration does not provide a means of loading a specific version of adataset as a component, nor does it provide a means of opening it fromNX. The latest configured version of a dataset is always used



Seed Part SetupWhen a user creates a new part in NX Integration, they must select a seedpart to be used as the basis for their part. A seed part may be either:

• Generic (available for use as the basis for a part file of any type), or

• Specific to a particular type of part file. For example, a seed part that maybe used as the basis for part files of type specification only.

As a Site Administrator, you can set up any number of seed parts to beavailable for users.

Initial seed part setup is generally established duringthe initial database installation by execution of theIMAN_ROOT/bin/ugmgr_add_note_types utility.

How Seed Parts are Stored in Teamcenter Engineering

In Teamcenter Engineering, a folder named NX seed parts is used to containall seed part information. The dialog below shows the default structure of theNX seed parts folder.

After installation, the NX seed parts folder contains the following:

• Two Items (parts), named Metric and Inch.

• A folder called manifestation.

• A folder called specification, containing two Items named Metric_dwgand Inch_dwg.

• A folder called master.



The two Items named Inch and Metric are generic seed parts. A generic seedpart is a part that can be used as the basis for any type of part file. If youcreate more generic seed parts (in addition to the two mentioned), they shouldbe placed directly in the NX seed parts folder.

NX Integration displays the seed part Name, not the Part ID.

The manifestation folder contains seed parts that can be used as thebasis for non-master part files of type manifestation only. Initially, themanifestation folder is empty. You should place any seed parts used to createnew manifestation part files (only) in this folder.

The specification folder contains seed parts that can be used to create newpart files of type specification only. The specification folder initially storestwo parts, Inch_dwg and Metric_dwg. These two seed parts can be used tocreate new drawings with imperial or metric units respectively. You shouldplace any seed parts used to create new part files of type specification (only)in this folder.

The master folder contains seed parts that can be used as the basis for partfiles of type master only. Initially, the master folder is empty. You shouldplace any seed parts used to create new master part files (only) in this folder.

NX Integration expects seed parts to be contained in the foldersnamed NX seed parts, master, specification, and manifestation only.If seed parts are created in other folders within the NX seed partsfolder, they are ignored.

Seed Part Example

The NX Integration seed part selection display can show multiple parts withone heading. This would be useful when two groups need different drawingseed parts, but would both like to select the name Drawing. This setup iseasily done with two parts with different Part IDs and with the same PartName. Each part would only be read by the appropriate group due to thepart’s protections.



Seed Part Preferences

Display Seed Part Dialog

This preference specifies whether the NX Integration ‘Select Seed Part’ dialogis displayed when a part which has been created in Teamcenter Engineeringis opened in NX for the first time. If set to ‘yes’, or ‘always’, the dialog isalways displayed. When the value is ‘no’, or ‘never’, the dialog is neverdisplayed, and the default seed specified by UGMGR_SeedPartName is usedas the basis for new part files. If set to ‘top’, the dialog is displayed only forthe top part in an assembly; for component parts, the dialog is not displayed,and the default seed specified by UGMGR_SeedPartName is used instead.

Preference(s): UGMGR_DisplaySeedDialog

File(s): ug_english.def, ug_metric.def

Possible values: yes, always, no, never, top

Default: yes

Default Seed Part

This preference specifies the default seed part which will be used as thebasis for new part files created in NX. The part name (not the part number)of the seed part should be specified. Note that you must have read accessto the seed part.

Preference(s): UGMGR_SeedPartName

File(s): ug_english.def, ug_metric.def

Possible values: Metric, Inch, Metric_dwg, Inch_dwg, orany seed part which has been definedand you have access to

Default: Inch



Activity: Organize the NX Seed Parts folder

In this activity, you will organize the NX seed parts folder.

Step 1: Put a reference to the NX seed parts folder in your Home Folder.

Start the Engineering/My Navigator application.

Choose the Search icon.

This brings up the Search window.

Choose General... from the query pull-down list.

Choose Clear this query form.

Enter Unigraphics seed parts in the Name field.

Choose Execute this query.

The Unigraphics seed parts folder appears in the General Tab.

Copy the Unigraphics seed parts folder to your Home folder.

Choose again, to close the Search window.



Step 2: Create a folder to keep unused seed parts organized within theUnigraphics seed parts folder.

Select the Unigraphics seed parts folder.

Choose File→New→Folder...

Enter the Name: not used

Choose OK.

The folder is created.

You have write privileges to the Unigraphics seed partsfolder since you are in the dba group.

Step 3: Organize the Unigraphics seed parts folder.

Expand the Unigraphics seed parts folder.

Cut and Paste the Metric Item into the not used folder.

Expand the specification folder.

Cut and Paste the Metric_dwg Item into the not used folder.

The Unigraphics seed parts folder should now be organizedlike the following.




Mapping TcEng Attributes to NX Part AttributesUsing mapping definition files, NX Part attributes can be stored in theTeamcenter Engineering database and displayed and modified both in NXand in Teamcenter Engineering.

Database attributes are not limited to properties of the datasets correspondingto NX Part file, instead they can be any of the following, as specified in themapping definition file:

• Properties of other Teamcenter Engineering objects. The mappingdefinition specifies how to find the object beginning with the originaldataset or related Item or Item Revision and traversing a path from oneTeamcenter Engineering object to another. The final step in the pathproduces a value, which can be an integer, a double, a string, a date,or an object. Each step may be a property, named reference, genericrelationship, job, or signoff. You cannot define the attribute to be aproperty of an arbitrary Teamcenter Engineering object. The object mustbe accessible from the original dataset, Item, or Item Revision by a seriesof steps.

• Teamcenter Engineering Preference Values. The mapping definitionindicates the scope and name of the preference.

• Constants. The mapping definition indicates the constant value. Acopyright notice is an example of a constant.

The set of mappings that apply to a particular dataset can be dependent onthe type of dataset and/or the type of the related Item. (The NX Integrationapplication assumes that the dataset is attached to an Item Revision forwhich there is always a related Item.)

The mappings are stored permanently in the Teamcenter Engineeringdatabase and are available when NX is running in NX Integration mode.These mappings are not available in native NX sessions.

Mappings can be either real or test. Real mappings are those that the usercan view within the application. Test mappings are used to verify theaccuracy of the mapping file before implementation.

Each mapping definition has a title and description that are used whendisplaying the attribute value in NX. There are also optional qualifiers thataffect the behavior of the mapping, such as which application has writecontrol and whether a default value is created for a NX Part file attribute ifnone exists in Teamcenter Engineering.



Default MappingsThe default mappings between Teamcenter Engineering and NX Partattributes are described in the following table:

UG Part Attribute Description TcEng AttributeDB_PART_NO Part Number Item IDDB_PART_REV Part Revision Item Revision IDDB_PART_TYPE Part Type Item TypeDB_PART_NAME Part Name Item NameDB_PART_DESC Part Description Item DescriptionDB_UNITS Part Unit of Measure Item Unit of Measure

You cannot delete the default attribute mappings.



Extending Attribute MappingsMappings of NX Part attributes to Teamcenter Engineering attributesare stored in the Teamcenter Engineering database and are extended byimporting a modified mapping definition file into the database. The existingfile is overwritten each time a new file is imported.

NOTE: It is recommended that this task be performed when all users arelogged out of NX Integration. If this is not possible, any users who were loggedinto NX Integration at the time the new mapping file was imported mustreload the database attributes using the NX Integration Reload command.

Use the following steps to extend the attribute mapping:

• Export the existing mapping to a text file, using the export_attr_mappingsutility.

• Edit the file to add, remove, or modify mappings.

• Import the modified mapping file as test mappings, using theimport_attr_mappings utility. This allows you to verify the attributemappings without affecting the existing real mapping definitions.

• Verify the test mappings by setting theIMAN_USE_TEST_ATTR_MAPPINGS preference to any non-zerovalue (either as an environment variable or in the preferences dialog).This will cause Teamcenter Engineering to pick up the test mappingsrather than the real mappings.

• When finished testing the mappings, import the modified mapping file asreal mappings using the import_attr_mappings utility.



Attribute Mapping SyntaxThere are four syntax forms for the specification of Teamcenter Engineeringattribute mappings:

<Part_Attr_Name> : <Path_Step>(s).<IMAN_Property>/<Qualifier>(s)

<Part_Attr_Name> : <Abbreviated_Path>.<IMAN_Property>/<Qualifier>(s)

<Part_Attr_Name> : CONST (value)/<Qualifier>(s)

<Part_Attr_Name> : PREF ( [<scope> : ] <value> )/<Qualifier>(s)

<Part_Attr_Name> is the name of a NX part attribute. Format must be alluppercase without spaces.

<Path_Step>(s) is one or more of the following separated with a (.) character(i.e., Item.GRM):

• NR ( <named_reference_type> [, <form_type> ]) - A named reference ofthe current object. The particular reference is identified by the type of thereferenced object (not the name of the reference).

• ItemRevision - The Item Revision object which owns the current object;that is, the Item Revision to which the current object is associated viaa GRM link.

• Item - The Item object corresponding to the current owning Item Revisionobject.

• GRM( <relation_type> [, <object_type> ]) - A GRM relation whose typeis <relation_type> and whose primary object is the current object andwhose secondary object gives the next object. In the case that more thanone relation of the given type is associated with the current object, theoptional second argument <object_type> is used to identify the type ofthe referenced object.

• Job - The job in which the current object is included; or, if there is nocurrent job, then the most recent job that the object was in (assuming thejob has not been deleted).

• SIGNOFF( [<level> , ] <role> ) - A completed signoff whose group membersroles have the name <role>. If the same role has been specified forassignees in more than one level of the process definition, the optionalargument <level> further identifies a specific level.



<IMAN_Property> - The name of the Teamcenter Engineering property to besynchronized with the NX part attribute.

<Qualifier> - Specifies various controls or conditions for the particularattribute synchronization and can be any one of the following:

• /description=<note> - NX will display the content of <note>, which is acharacter string enclosed in single or double quotes, to show the userwhat significance the attribute has.

• /write_once - NX Integration can write a value for the attribute toTeamcenter Engineering if the attribute does not already have a value.

• /master=cad - Only the CAD application, i.e. NX, is allowed to modify theattribute value. This should not be used with Item Master Forms.

• /master=iman - Only Teamcenter Engineering is allowed to modify thevalue for the attribute.

• /master=both - Both NX Integration and Teamcenter Engineering canmodify the attribute value.

• /master=none - Neither can modify the attribute value.

• /freezable - This directs NX to ignore the Teamcenter Engineeringattribute value, as stored in the Teamcenter Engineering database, but touse the value stored in the part file if the related Teamcenter Engineeringobject is frozen.

<Abbreviated_Path> is one of the following:

• IM - abbreviation for Item.GRM(IMAN_master_form, Item Master)

• IRM - abbreviation for ItemRevision.GRM(IMAN_master_form,ItemRevision Master)

CONST - Represents a constant value specification which the NX partattribute will assume. Its specification is: CONST ( <value> ) where <value>is a character string enclosed in single or double quotes.

PREF ( [ <scope> : ] <value> ) produces the <value> preference value,optionally within the given preference scope. The scope can be one of thefollowing: ENV, USER, ROLE, GROUP, or SITE.



Comments and Contexts SymbolsComments are introduced by the (#) symbol. Anything on the line after thissymbol is not part of the mapping definition and is ignored.

Contexts begin with the left bracket ({) symbol followed by a context specifierwhich states the context for the following mappings, either Dataset type orItem type context, as follows:

• Dataset type = <dataset-type>

• Item type = <item-type>

Contexts end with the right bracket (}) symbol.

Contexts can be nested. For example, you can define an Item-type-basedcontext within a dataset-type-based context. The mappings defined withinthis nested context are then only applied to datasets of the specified type thatare associated with Items of the specified type.

Example:

Top of File...

Mappings located here apply to any Dataset type in context of any Item type

{Dataset type=UGMASTER

Mappings located here apply only to UGMASTER Dataset types in contextof any Item type.

{Item Type=Item

Mappings located here apply to only UGMASTER Dataset types only incontext of Item Item types (For example, not Document Item types)

}

}

... Bottom of file



Activity: Teamcenter Engineering/NX Attribute Mapping

In this activity, you will modify the Teamcenter Engineering / NX attributemapping definitions.


Step 2: Verify bi-directional synchronization mode is set.

Ask your instructor for the location of UGII_ROOT_DIR.

Open the ugii_env.dat (.ugii_env on Unix) file inUGII_ROOT_DIR in a text editor.

Search the file for the UGII_UGMGR_ATTR_SYNC setting.

Make sure this variable is set to NEW.


Step 3: Export current mappings to a text file.

Open a command window with the Teamcenter Engineeringenvironment set.

Use the cd command to navigate to aa_class.

Type: cd ug_attr_sync


export_attr_mappings -u=infodba -p=infodba -g=dba-file=current_mappings.txt

Open the new current_mappings.txt file in a text editor.

Review the UGMASTER and UGPART dataset sections.

Step 4: Review a modified mappings definition file.

To save time, a modified version of the current_mappings.txtfile has been prepared for you. In this step, you will open thenew_mappings.txt file and review the additional mappings definedin this file.

Open the new_mappings.txt file (in the.../aa_class/ug_attr_sync directory) in a texteditor.

Compare the file to the current_mappings.txt file and observeadditions in the UGMASTER and UGPART sections.



Close the text editor application for both files.

Step 5: Import new mappings as a test mappings.

Return to the command window with Teamcenter Engineeringenvironment set.

Verify you are still in the ug_attr_sync directory.


import_attr_mappings -u=infodba -p=infodba -g=dba-file=new_mappings.txt.v9 -test

Step 6: Set environment for test mapping usage.

Log in to the Teamcenter/My Navigator application and makesure nothing is selected (use CTRL and mouse to unselect).

It may be necessary to use the Teamcenter Engineering2 Tier Rich Client to perform this part of the activity.Ask your instructor.

Select Edit→Options from the pull-down menu

Select Index at the bottom left of the form.

Select New

Enter the preference name:IMAN_USE_TEST_ATTR_MAPPINGS asshown.

Select String for the Type and enter Y for the Value.



Select to create the preference.

Select to close the form.

Step 7: Start NX and test the UGMASTER mappings.

Choose the Open in NX icon to start NX.

In NX, choose the New icon to create a new file.

Use the following parameters:

Part Type: ItemPart Number: 13690Part Revision: 000Part File Type: masterPart FileName:

<unset>

Seed Part: Inch

Choose OK.



The Edit Database Attributes dialog appears. Notice the 7 newentries in the Write Enabled section. These are 7 of the 9 newmappings defined by importing the new_mappings.txt file (Theother 2 mappings apply only for UGPART type datasets).

Press Enter to accept the default values for Part Name andPart Description.

Set the value of each of the remaining attributes to from NX.

When finished, choose OK.

Save (File→Save), then Close (File→Close→All Parts) the partfile (Do not exit NX).

Step 8: Observe UGMASTER partfile attribute data stored in TcEng.

In My Navigator, expand the 13690 Item and ItemRevision(may have to Refresh the Home folder).

View the ItemRevision Master form by double-clicking it or byselecting it with the Viewer tab raised.



You should see data provided for each attribute as providedfrom the NX interface.

Change all attribute values on the form to from TC.

Choose OK to save the edits.

Step 9: Verify UGMASTER update from TcEng edit.

From NX, open the 13690/000 UGMASTER part file.

Choose Format→Database Attributes....

Choose the Assign button on the Database Attributes dialog.



Observe the values for the attributes in the Write Enabledsection of the dialog. The values should appear as the valuesyou applied to the ItemRevision Master form in the TeamcenterEngineering interface.

Using the Edit Database Attributes dialog, change the valuefor each attribute value to from NX Again.

Choose OK on the Edit Database Attributes dialog.

Choose OK on the Database Attributes dialog.

Save, then Close the part file (Do not exit NX).

Step 10: Verify Teamcenter Engineering update from UGMASTER edit.

In Teamcenter Engineering, select the ItemRevision Masterform and choose View→Refresh.

Open the ItemRevision Master form again to review theattributes that were changed.

If the ItemRevision Master form is selected or the formdialog is still open from a previous step, you will have toreopen the dialog or select another object and re-select theItemRevision Master form to see the current values forthe form fields.



Step 11: Test the UGPART mappings.

From NX, choose to create a new file.

Use the following parameters:

Part Type: ItemPart Number: 13690Part Revision: 000Part File Type: specificationPart FileName:

DWG13690

Seed Part: Inch

Choose OK.

Choose OK on the Add Master to: dialog.

Choose Format→Database Attributes...

Choose Assign.

The following message appears.

The attributes mapped to the UGPART dataset type weredefined using the /master=iman qualifier, and therefore cannotobtain values from the NX interface.

Choose OK on the No Write Enabled Attributes dialog.

Save, then Close the part file (Do not exit NX).



From My Navigator, highlight the 13690/000 ItemRevision.



The ItemRevision, UGMASTER and UGPART dataset shouldall have Status flags.

From NX, open the DWG13690 UGPART partfile.

Choose Format→Database Attributes...

Choose the List button on the Database Attributes dialog.

Observe the values for the attributes in the Read Only sectionof the dialog. The DATE_RELEASED and RELEASE_STATUSattributes should have values.

Close the Information window and exit NX.

Step 12: Import new mappings as real mappings.

Open a command window with Teamcenter EngineeringEnvironment set.

Verify you are in the .../aa_class/ug_attr_sync directory.


import_attr_mappings -u=infodba -p=infodba -g=dba-file=new_mappings.txt

This is the same command you executed earlier in thelesson, only this time the -test option is not being used.



Step 13: Unset environment for test mapping usage.

Open the Preferences dialog and enter IMAN_US in the Searchon preference name field.

Select the IMAN_USE_TEST_ATTR_MAPPINGS preferencein the preference list.

Select Delete on the form and OK from the Delete Preferencequestion pop-up.

Select to close the Preferences dialog.




Process Templates for NX Related DataSpecial workflow handlers are provided with Teamcenter Engineering for usein process models designed for UG data.

EPM-attach-item-revision-targets

When releasing Item Revisions that contain a UGMASTER as a Specificationrelation, the UGMASTER should be released at the same time.

To accommodate this requirement, Teamcenter Engineering provides thecanned handler EPM-attach-item-revision-targets in the process templates.This handler attaches all objects with specification relation to the ItemRevision as target objects.

EPM-attach-related-objects

This handler attaches the specified related objects of the target objects astarget/reference attachments to the process. This handler goes through allthe target objects, finds the secondary objects with the specified relation andtype (if specified) and adds them as target/reference attachments.

This handler is more generic than EPM-attach-item-revision-targetsand can be used to attach objects with customized relations, also.

EPM-generate-image

Another useful handler is EPM-generate-image. The EPM-generate-imagehandler generates NX part images for display by Teamcenter EngineeringWeb. This handler calls an external NX User Function program (no licenserequired) to accomplish this. The images are stored as named referencesto the UGMASTER dataset.



EPM-tessellation-handler

This handler generates .jt files for viewing with Teamcenter Vis products.The handler is intended to be added to the Item Revision and/or UGMASTERreview process(es).

When an Item Revision or UGMASTER undergoes a review process, thishandler retrieves the UG Part files belonging to the UGMASTER datasetand creates Vis files (.jt files).

EPM-generate-ugcgm-drawing

This handler generates Drawing sheet datasets (CGM images) of UGdrawings.

This handler must be added to a process template as an action handler.The process template containing this action handler should be initiated byselecting the UGPART/UGMASTER dataset.

This handler calls an external NX User Function program to generate theCGM images of the drawing sheets in the part. The generated images arestored as named references to the UGMASTER dataset.



Preference Settings for NX Integration

Locating the NX Integration Preferences

For review, the following preference hierarchy is followed:

1. A preference set via shell commands.

2. User:

3. Role:

4. Group:

5. Site:

Summary of the Preference Hierarchy for NX Integration

Setting1 User In Shell2 User Determined by Login

and session settings.3 Role Determined by Login

and session settings.4 Group Determined by Login

and session settings.5 UGMan n/a6 Site n/a



Preference Settings to Consider for NX IntegrationWhile there are many preferences available to customize NX Integration,the following were reviewed and considered for the discussion during thistraining course.

NX Integration Default View Type

The IMAN_UG_View_Type preference sets the BOM view type that NXIntegration will use to read and write product structure information. Thispreference accepts a single string as a value; the string must be a validTeamcenter Engineering BOM view type.

Preference(s): IMAN_UG_View_Type

Default: view (Set to engineering in anearlier lesson.)

NX Integration will error with File-Save operations if theIMAN_UG_View_Type is not a valid Teamcenter EngineeringBOMView Type.

Default UGMASTER Dataset Separator Character

The IMAN_ugmaster_name_separator preference allows you to controlUGMASTER dataset name created by NX Integration. The dataset nameshould follow the same format to enable better searches.

To make the UGMASTER dataset name format be consistent, setIMAN_ugmaster_name_separator preference to be the same asFLColumnCatIVFSeparatorPref which is "/" by default.

If you change FLColumnCatIVFSeparatorPref, also update theIMAN_ugmaster_name_separator preference.

Preference(s): IMAN_ugmaster_name_separator

Default: not set



Environment Variable Settings for NX Integration

Locating the NX Defaults File

The default NX Integration environment variables are read from the fileugii_env.dat. The default ugii_env.dat file is located in the directory set byUGII_ROOT_DIR. A ugii_env.dat file could also be used as a user’s preferencefile, commonly in the user’s home directory.

The following variables must be set in the user’s environment or witha startup script. These are set in the class with the env-sitea script.

• UGII_BASE_DIR

• UGII_ROOT_DIR

• UGII_LICENSE_FILE

Interpreting the File Specifications

The configuration variable UGII_OPTION in the ugii_env.dat file sets howto interpret and convert file specifications. This preference accepts one ofthe following values:

NONE – File specifications are interpreted without converting case (i.e., as-is).

LOWER – Converts entire file specification (directory and file name) to alllower case.

Default = LOWER.

Other settings available: UPPER, HINAME, LONAME

We recommend lower case (UGII_OPTION=LOWER) for NX Integrationpart files and volume names when the volume is going to be used forNX Integration part files. Additionally we recommend that TeamcenterEngineering volumes and group names be lower case.

This preference can affect TCFS if these recommendations are notfollowed.



NX Customer Default Files for NX IntegrationNX Integration enables you to use NX and Teamcenter Engineering together.For this reason, some NX Integration customer defaults are located in the NXcustomer defaults file or can be edited in NX Customer Defaults.

NX Customer Defaults

NX customer defaults may be set by an administrator (site) or edited locally(user) if desired. Local edits may be disabled if desired.

Possible Settings

The seed part settings UGMGR_DisplaySeedDialog andUGMGR_SeedPartName were discussed earlier.

By Pass Request to Position Components

The Autoposition New Product Structure Components preference allowsyou to bypass NX prompting you to position each component which you haveadded in PSE.

Autoposition New Product Structure Components has two possible values:on and off.

By default, this customer default is set to off, which forces a request toposition every new component which you have added in PSE. When it isset to on, each component which has been added to the assembly in PSE isautomatically placed at the origin in NX.

This preference may be edited in NX by choosing File→Utilities→CustomerDefaults and selecting Autoposition New Product Structure Components.



Activity: Modify NX Integration Preferences

In this activity, you will set the NX Integration preferences.

Step 1: Verify the following site preferences in the Preferences dialog.

Open the Preferences dialog using EDIT→Options from thepull-down menu.

Select INDEX

Enter IMAN_UG_View_Type in the Search on preferencename field.

Notice the current setting of engineering, which was set earlierin the course.

Leave the dialog open for the next step.



Step 2: Add the following site preference.

Add the following in the Preferences dialog.

IMAN_ugmaster_name_separator=/

The preference must be spelled correctly, otherwiseTeamcenter Engineering will not use the preference.

• Select New

• Enter the preference name:IMAN_ugmaster_name_separator asshown.

• Select the Site button as shown for the preference Scope.

• Select String for the Type and enter / for the Value.

• Select to create the preference.

• Select to close the form.





• Setup Seed Part Files for NX

• Defined NX-to-TcEng; Attribute Mappings

• Set NX Integration Preferences and Options


Lesson

16 NX Integration Import andData Release

Purpose

The purpose of this lesson is to import native NX files and other related datainto Teamcenter Engineering.

Objectives


• Import NX Data into the Database

• Release Imported NX Data


NX Integration Import and Data Release

Introduction to NX Data ImportIn standard NX, your parts are stored in operating system directories. NXIntegration, however, does not search for your parts in operating systemdirectories. Instead, it retrieves part files from the Teamcenter Engineeringdatabase. Therefore, in order for NX Integration to locate your parts, theyneed to exist in the Teamcenter Engineering database. The ug_importutility is used to make copies of your standard NX assemblies in TeamcenterEngineering.

The ug_import utility is commonly used to import NX part files andassemblies. The result is the creation of Items and the included UGMASTERand/or UGPART datasets which have the file Named References for the partfile data.

You should use the ug_import utility whenever you are importing NX data.

The ug_import utility does the following:

• Imports an entire part tree when the top level assembly Item is specified.

• Creates an Item structure for data plus a dataset.

• Imports NX assembly and master model data.

• A mapping file is typically used to provide settings for the many options.

• Can use a mapping file suited for NX parts.

• Can use a search path file to locate NX parts.



Parts and Assemblies to be ImportedFor your reference these parts and assemblies will be discussed and importedin this lesson.

Other files (e.g. seed files) will also be imported and will be explainedappropriately during the lesson discussion.

Wheel Assembly

The wheel assembly below contains the components as listed in the AssemblyNavigator.



Frame Assembly

The frame assembly below contains the components as listed in the AssemblyNavigator.



Prepare to Import NX DataPreparations are usually required before using the ug_import utility to havea successful import. The next few pages will use various native NX files toshow the necessary preparation.

The first and most important step is to understand what files there are to beimported. Various types are listed:

• Components

• Assemblies

• Master associated files (e.g. TIF, HTML files)

• Non-master part files (Drawing and NC ".prt" files)

• Non-master associated files (e.g. NC, CLSF, PTP files)

• Non-NX files (e.g. DOD requirements, part testing results)

• Product (part) attributes

Because ug_import works slightly different for these file types, you mustask these questions:

• What setup requirements are there?

• What mapping files must be written?

• How to use ug_import?

Consider the example directory below of native NX files that must beimported.

1250_axle_000.tif1250_axle_000.prt1250_axle_000_dwg.prt1250_000_dwg.cgm1300_bearing_000.prt

1400_wheel_000.prt

1600_wheel_assy_000.prt1700_spacer_000.prtborder_b_seed.prtborder_c_seed.prtm243_heat_treat.txt

The 1400_wheel_000.prt is in a directory at a different location.

How is the import set up, and then how is the import accomplished?



Recognize the NX Files and Attribute Data

The directory below must be divided into the categories shown in order toproperly use ug_import and its arguments.

Components and Assemblies

1250_axle_000.prt

1300_bearing_000.prt

1400_wheel_000.prt

1600_wheel_assy_000.prt1700_spacer_000.prtborder_b_seed.prtborder_c_seed.prt

The ug_import utility essentially works the same for component and assemblyparts, but the utility performs a database login each time it is executed. Thelogin can take a fair amount of time. Therefore, preferably you would like toknow the assembly parts and execute ug_import on the top level assemblies.

The NX utility ugpc can be run on the part (.prt) files inthe directory to get a output listing of the assembliesand their components, as shown in the following example.

1600_wheel_assy_000.prt./1250_axle_000.prt./1700_spacer_000.prt./1300_bearing_000.prt./1400_wheel_000.prt

For example, you could simply use:

ug_import -part=border_b_seed.prt

ug_import -part=border_c_seed.prt

ug_import -part=1600_wheel_assy_000.prt

As you will see the components and assembly master files can be importedwith one command line ug_import execution and a mapping file to convert allfiles to the proper database Part ID and Revision.



Master Associated Files (e.g. files like TIF, HTML)

1250_axle_000.tif

Next begin to recognize the files associated to the components and assemblies.These files would be like TIF or HTML files.

These files can be placed in an individual directory and imported with oneextra argument on the command line or one extra keyword in a mapping file.


ug_import -part=1250_axle_000.prt -id=1250 -rev=000-assoc_files=yes

where the 1250_axle_000.tif file would be in a sub-directory named 1250 tocorrespond to the part id (-id=1250).

Non-Master Part Files (drawing and nc ".prt" files)

1250_axle_000_dwg.prt

Next recognize the non-master part files that work with the component andassemblies. These files would be drawings and manufacturing part (.prt) files.

Non-master part files can reside in the same directory as their master partfiles, but must be imported with their own ug_import execution.

For these part files you must specify the relation to the master part (e.g.specification, manifestation, etc.) and the name of the UGPART datasetcreated with the import.


ug_import -part=1250_axle_000_dwg.prt -id=1250 -rev=000-name=1250_DWG -type=manifestation



Non-Master Associated Files1250_axle_000_dwg.cgm

Next begin to recognize the files associated to the non-master part files (e.g.,CLSF, PTP files). These files would be like CGM files that are associated to adrawing or the common CAM related files for manufacturing operations.

Like before, these files can be placed in an individual directory and importedwith one extra argument on the command line or one extra keyword in amapping file.


ug_import -part=1250_axle_000_dwg.cgm -id=1250 -rev=000-name=1250_DWG -type=manifestation -assoc_files=yes

where the 1250_000_dwg.cgm file would be in a sub-directory named1250_m_1250_dwg to correspond to the part id (-id=1250) + m(-type=manifestation) + 1250_dwg (-name=1250_DWG). Each of theseportions are separated with an underscore ( _ ), giving the full sub-directory1250_m_1250_dwg.

Non-NX Files

Examples of Non-Unigraphics Files are DOD requirements and part testingresults.

m243_heat_treat.txt

Finally importing the non-NX files can easily be done by importing the filesinto the Item or Item Revision with the import_file utility. This utility wasused earlier in the course.

Product and Part Attributes

Product or part attributes may exist in the part file or inside anotherapplication (e.g. MRP). Importing NX part attributes is done automaticallywith the ug_import utility, after a preference is setup with the list of attributenames. Importing attributes from other applications usually requiresexporting the attributes to a neutral file and then using a custom TeamcenterEngineering program to import the attributes into the database.



Example Import Directories and Files

Original directory and files.

1250_axle_000.tif1250_axle_000.prt1250_axle_000_dwg.prt1250_000_dwg.cgm1300_bearing_000.prt

1400_wheel_000.prt

1600_wheel_assy_000.prt1700_spacer_000.prtborder_b_seed.prtborder_c_seed.prtm243_heat_treat.txt

Rearranged directories and files.

1250/1250_axle_000.prt1250_axle_000_dwg.prt1250_m_1250_dwg/1300_bearing_000.prt1600_search.txt

1400_wheel_000.prt

1600_wheel_assy_000.prt1700_spacer_000.prtborder_b_seed.prtborder_c_seed.prtm243_heat_treat.txt1600_wheel_assy.map

As you can see the master part files for the 1600_wheel_assy_000.prt and theseed parts still remain in their original directories. The non-master part file(1250_axle_000_dwg.prt) and the non-NX file (m243_heat_treat.txt) alsoremain in the original directory.

To convert the files names to database Part IDs and Revisions, the1600_wheel_assy.map file has been added and will be used during the import.Also the 1600_search.txt file has been added to locate the 1400_wheel_000.prt.

Two sub-directories have been created for the associated files. Thesub-directory contents are shown below.

1250/1250_axle_000.tif

1250_axle_000_dwg/1250_000_dwg.cgm



Overview of the ug_import Capabilities

Basic Usage of ug_import

The ug_import utility takes your standard NX assembly and recreates boththe parts and the structure in Teamcenter Engineering. For each NX part,ug_import creates items, item revisions and datasets as necessary.

The simplest import is carried out by specifying the command:

ug_import -part=1600_wheel_assy_000.prt

This imports an assembly named 1600_wheel_assy_000.prt and all ofits component parts from the current directory into the TeamcenterEngineering database. If the assembly is located outside the currentdirectory, you need to specify the full pathname of the assembly, for example:

ug_import -part=/users/daytr/1600_wheel_assy_000.prt

The default behavior of ug_import is to create all the parts in the NXassembly as master parts of type "Item" in the Teamcenter Engineeringdatabase. The parts are named as follows:

• ug_import removes the directory prefix and the .prt extension from thestandard NX filename to form the Item ID.

• the item revision is set to "A".

The native filename /users/daytr/parts/1600_wheel_assy_000.prt becomes1600_wheel_assy_000/A in Teamcenter Engineering.

The ug_import utility allows you to fine-tune the creation of the assemblyand each of its components by specifying extra command line keywords andthrough the use of mapping files.



Introduction to Using Mapping Files

A mapping file can set the individual components without affecting othercomponents in the assembly.

Mapping file syntax[Defaults]import_folder = "Import Project"db_part_no=$STRIPPED_LEAFNAMEexisting_data=$USE_EXISTING

[CA_36245.prt]db_part_no="CA_36245_000"db_part_rev="000"assoc_files=yesassoc_files_dir="CA_36245_files"

[ENG_83475.prt]existing_data=$OVERWRITE_EXISTINGdb_part_no="ENG_83475_000"db_part_rev="000"assoc_files=no



Introduction to Using Command Line Keywords

Depending on the command line keyword the entire assembly or just thetop part of the assembly are affected.

Command line keyword syntaxug_import -part=<part name>

[-u=<username>][-p=<password>][-g=<group>][-search=<search file name>][-mapping=<mapping file name>][-import_folder=<folder name>][-id=<Item ID>][-rev=<Item Revision>][-part_type=<Item Type>][-type=<relationship type>][-name=<dataset name>][-assoc_files=<yes/no>][-assoc_root_dir=<associated files root dir>][-dryrun]

The details of these will be explained on later pages by using real worldexamples.

Using (Directory) Search Files

Your site may not keep all the components of all assemblies in the samedirectory. If you specify the name of a search list file on the command line,NX Integration searches the directories listed in the search list file for thecomponent parts of the assembly.

Importing Non-Master and Associated NX Files

You may have other files that are used with your part files (e.g. machiningoperation files).

In addition to importing part files, you can import other types of NX filesassociated with a part file from operating system directories.



Understanding Various NX Integration Import ScenariosThe following import scenarios will be discussed to import native part filedata.

• Import Component Parts or Assembly Parts without a Map File

• Import an Assembly using a Map File and Search File

• Import a Non-Master Drawing and NC Part File

• Import Files Associated to a Component (Master) Part File

• Import Files Associated to the DWG (Non-Master) Part File

• Import Files Using a Full Map File

To run ug_import, use the following command syntax:

ug_import -part=<part name>

[-dryrun]

[-id=<Item ID>][-rev=<Item Revision>]

[-search=<search file name>][-mapping=<mapping file name>]

[-import_folder=<folder name>]

[-type=<relationship type>][-name=<dataset name>]

[-assoc_files=<yes/no>][-assoc_root_dir=<associated files root dir>]

The following tables give a brief description of the value corresponding toeach command line keyword, and the title of the subheading under whichfurther information can be found.



Import Component or Assembly Parts without a Map File

KEYWORD VALUE-part= The operating system pathname of

the top level part in the NX assemblywhich is to be imported.

-dryrun Indicates whether the import willproceed as expected, without actuallydoing the import.

-id= The Item ID which is given to thestandard NX part specified on thecommand line.

-rev= The Teamcenter Engineering revisionwhich is given to the standard NX partspecified on the command line.

-import_folder= The name of the TeamcenterEngineering folder which stores theimported assembly and all of itscomponents.

Import an Assembly using a Map File and Search File

KEYWORD VALUE-mapping= The operating system pathname of the

file containing details of the way inwhich individual components in yourassembly should be imported.

-search= The operating system pathnameof the file which lists operatingsystem directories to search for thecomponents of your assembly.



Import a Non-Master Drawing and NC Part

KEYWORD VALUE-type= The type of non-master part file created

in Teamcenter Engineering.-name= The name of the non-master part file

created in Teamcenter Engineering.

Import Files Associated to a Part and to the NC (Non-Master) Part

KEYWORD VALUE-assoc_files= Used to instruct ug_import whether

to import files associated with thespecified assembly and all of itscomponents.

-assoc_root_dir= The operating system directory underwhich sub-directories containingassociated files belonging to theassembly and all of its components arelocated.



Command Line Keywords With ug_import

Use of Quotation Marks

If you have any characters other than letters, digits, underscores, andhyphens in the value that you specify for a particular keyword, it isrecommended that you enclose the value in quotation marks "" to avoidimport errors. For example, if you wish to import the part "chassis.prt" into afolder in Teamcenter Engineering called "Concept Car" (note the space in thefolder name), it is advisable to specify the command:

ug_import -part=chassis.prt -import_folder="Concept Car"

Note that the Teamcenter Engineering folder name is surrounded by quotes.

Maximum Length Limit

There is a maximum length limit for the values corresponding to some of thekeywords used by ug_import.

Field Keyword LimitPart Number -id= 26 charactersRevision -rev= 32 charactersDataset Name -name= 32 characters

In addition, the combined (Part Name+Revision+Dataset Name) length mustnot exceed 50 characters.

Login Keywords

If you have autologin enabled, -part= is the only keyword that must bespecified on the command line. All the other keywords listed in the table areoptional. However, if autologin is disabled the -u= and -p= keywords arealso required. For example,

ug_import -part=1400_wheel_000.prt -u=<user> -p=<password>

where <user> and <password> are the Teamcenter Engineering databaseuser and password.



Import Component/Assembly Parts without a Map File

Scenario

In this scenario, seed part files will be imported.ug_import -part=border_b_seed.prt -id=B-size -rev=000

-import_folder="Seed Parts" [-dryrun]

ug_import -part=border_c_seed.prt -id=C-size -rev=000-import_folder="Seed Parts" [-dryrun]

Import a New Master Part File

By default, ug_import imports your assembly (that is, the part file specifiedon the command line) as follows:

• All parts are imported as a master part file into the Newstuff folder.

• The top part in the assembly is overwritten, but any component partswhich already exist in the database are not overwritten.

• In order to change the default import behavior for the component parts,you must specify a mapping file. Therefore assemblies will most likelybe imported with a mapping file.

The -part= keyword specifies the operating system pathname of the top partin the NX assembly which is to be imported into Teamcenter Engineering.Both master and non-master part files can be imported.

You must always specify the full pathname of the operating system partfile corresponding to the top level part in your assembly on the ug_importcommand line unless the part is located in your current directory. Forexample,

ug_import -part=/users/daytr/parts/1600_wheel_assy_000.prt

ug_import searches for the part files corresponding to the components ofyour assembly in the same directory as the top part. If the component partfiles are not located in the same operating system directory as the top part,you must specify a search-list file so that ug_import can successfully locatethe components.

The following command line keywords can be used to change the defaultimport behavior for the top part in the assembly (only):

• –id=

• –rev=

The -id= and -rev= keywords can be used to import the part specified on thecommand line (only) with a different part number and revision respectively.



Import Part Files into a Folder

The default behavior of ug_import is to import your standard NX assemblyinto the folder named Newstuff in your Home folder in TeamcenterEngineering. You can change the behavior of ug_import so that it importsyour assembly into a different folder. You do this by specifying the-import_folder= keyword on the command line. For example:

ug_import -part=1600_wheel_assy_000.prt-import_folder="1600 Wheel Assembly"

Note that the -import_folder= keyword causes the assembly and all of itscomponents to be imported into the specified folder. If you wish individualcomponents in the assembly to be imported into different folders, you mustspecify the -import_folder directive in a mapping file instead.

Checking the Import

The -dryrun keyword allows you to see whether your import will progressas you expect. It runs through the import procedure without actuallyimporting any parts into the Teamcenter Engineering database. The normalug_import messages are displayed, allowing you to check whether there willbe any errors when you do import the assembly, and to correct them beforeproceeding.

The -dryrun keyword is particularly useful if you intend to import a largeassembly because the import checks are performed much faster than a fullimport.



Import an Assembly using a Map File and Search File

Scenario

In this scenario, a Wheel Assembly will be imported. A map file will be usedto convert all the part file names to their database part ID. Additionally asearch file will be used, since the parts are in various directories.

ug_import -part=1600_wheel_assy_000.prt -search=1600_search.txt-mapping=1600_wheel_assy.map [-dryrun]

Search-List File

A search-list file is a text file which lists the operating system directorieswhich ug_import should search in order to locate the part files correspondingto component parts in an assembly. The filename of a search-list file isspecified on the ug_import command line using the -search= keyword. Forexample,

ug_import -part=1600_wheel_assy_000.prt-search=1600_search.txt

You need to provide a search-list file if any part files corresponding to thecomponents of your assembly are located in different directories from the partfile which stores the top part in the assembly.

A search-list file simply lists the operating system directories which should besearched to locate the component files of the assembly. Each directory shouldbe specified on a new line. If a directory name ends in "/...", all directoriesbeneath the specified directory also are searched.

For example, a search-list file with the contents:

./iman/daytr/v5_sitea/ug_import_files/.../iman/class-default/v5_sitea_parts

would cause ug_import to search in the following order.

1. The current directory.

2. The directory named /iman/daytr/v5_sitea/ug_import_files and all of thedirectories beneath it.

3. The /iman/class-default/v5_sitea_parts directory.



Mapping Files

A mapping file is an optional file that may be specified for the import utility.The purpose of a mapping file is to allow you to specify exactly how individualcomponents in an assembly are imported into Teamcenter Engineering.

Mapping File Format

A mapping file is a simple text file which instructs ug_import how toimport the components in your assembly. The text in a mapping file maycomprise expressions, file names, directory names, and the names of partsand revisions in the database.

A mapping file is divided into sections of the format:

[SECTION_NAME]KEYWORD=VALUEKEYWORD=VALUE

An example mapping file is shown below:

! Mapping file for importing chassis assembly

[Defaults]import_folder = "Import Folder"db_part_no=$STRIPPED_LEAFNAMEexisting_data=$USE_EXISTING

[CA_36245.prt]db_part_no="CA_36245_000"db_part_rev="000"

[ENG_83475.prt]existing_data=$OVERWRITE_EXISTINGdb_part_no="ENG_83475_000"db_part_rev="000"



Key Points

There are a few general points to note when using mapping files:

• An exclamation mark (!) at the beginning of a line specifies the line asa comment line.

• Mapping files can contain blank lines.

• ug_import ignores leading spaces at the beginning of a line.

• The maximum length of a line in a mapping file is restricted to 132characters, including spaces.

• If you wish to include spaces in a field, then you must enclose the fieldin double quotes.

• Each [SECTION_NAME] and KEYWORD=VALUE directive must bespecified on a separate line.

Using the SECTION_NAME

The SECTION_NAME field can be specified as either [Defaults] or the nameof a NX part file.

If you specify a SECTION_NAME of [Defaults], any KEYWORD=VALUEmapping file directives specified in this section affect all of the components inyour assembly, unless they are deliberately overridden by specifying a sectioncorresponding to a NX part name.

For example, in the mapping file above, the directives in the [Defaults] sectionaffect all the parts to be imported. However, the directives in the sectionsentitled [CA_36245.prt] and [ENG_83475.prt] are applied to those parts only,and override the directives in the [Defaults] section.

A NX part number may be specified in a section by either the full operatingsystem pathname or just the part number.

You cannot use environment variables in filenames in a mapping file.



Using the KEYWORD AND VALUE

The KEYWORD field in a mapping file is one of a number of reservedkeywords. These keywords are tabulated below:

Keyword: db_part_noDescription: TcEng part (Item) IDValid Expression: $STRIPPED_LEAFNAME

$EXPORTED_PART_NODefault: If the part has been previously exported

from NX Integration, defaults to the value ithad when exported. Otherwise, defaults to$STRIPPED_LEAFNAME

Keyword: db_part_revDescription: TcEng part revisionValid Expression: $EXPORTED_PART_REVDefault: Defaults to A

Keyword: db_part_nameDescription: TcEng part nameValid Expression: $STRIPPED_LEAFNAME

$IMPORTED_PART_NODefault: If the part has been previously exported from NX

Integration, defaults to the value it had whenexported. Otherwise, defaults to the same value asdb_part_no.

Keyword: db_part_descDescription: TcEng part descriptionValid Expression:Default: Defaults to the same value as db_part_no, if

specified in a mapping file. Otherwise, defaultsto $STRIPPED_LEAFNAME (the file name of theUG part without the leading directory and the .prtextension).



Keyword: import_folderDescription: TcEng folder where imported parts are placed.Valid Expression: $DEFAULT_IMPORT_FOLDERDefault: Your Newstuff folder. Note that -import_folder

specified on the command line takes precedence overimport_folder specified in a mapping file.

Keyword: existing_dataDescription: What to do if parts already exist in TcEngValid Expression: $FAIL_IF_PART_EXISTS

$FAIL_IF_REV_EXISTS

$OVERWRITE_EXISTING

$USE_EXISTINGDefault: Overwrite the existing top part (only) in the

assembly, $OVERWRITE_EXISTING.

For all the component parts in the assembly, usethe existing data $USE_EXISTING.



The VALUE consists of part file names and optional reservedEXPRESSION(s).

The reserved expressions are described below:

EXPRESSION EXPANDS TO:

$STRIPPED_LEAFNAME OS filename of the component (notassembly) stripped of any prefix endingin ‘/’ (UNIX) or ‘:’ (VMS) and the .prtsuffix. For example:

"/tmp/top_level_a.prt" → "top_level_a"

$STRIPPED___LEAFNAME

(Note that there are threeunderscores)

OS filename of the component strippedof any prefix ending in ‘/’ (UNIX) or ‘:’(VMS) and the suffix (delimited by ‘_’), ifpresent. For example:

"/tmp/top_level_a.prt" →"top_level"

$IMPORTED_PART_NO The part number, if the part is beingimported as it will be in TcEng (i.e.,after any renaming specified by themapping file has occurred).

$DEFAULT_IMPORT_FOLDER Global default TcEng target folder.

$FAIL_IF_PART_EXISTS If the Part (Item) exists, do not save theassembly.

$FAIL_IF_REV_EXISTS If Part Revision (Item Revision) exists,do not save the assembly.

$OVERWRITE_EXISTING If the part data exists, overwrite it.

$USE_EXISTING If a component already exists in TcEng,use the database copy in the currentassembly.



The Import Log FileBelow is an example log file (always named import.log) that iscreated during the use of ug_import. Also a syslogfile is createdwith more system information and placed in the /tmp directory.

**************** UG Import Utility ****************Using UG V1.0.0.21Using assembly load options - Load from directory.Using supplied mapping file: [wf.map]Loaded assembly [1600_wheel_assy_000.prt]Connecting to the database...Import parts to database using NX Manager V9.0Connected to the database.

The UG assembly [1600_wheel_assy_000.prt] comprises [5] part(s)Part # 1, [/users/legacy/ug_import_files/1600_wheel_assy_000.prt]

NX Manager part number is [1600/000] in folder [Newstuff]Part will be created with type [Item].

Part # 2, [/users/legacy/ug_import_files/1250_axle_000.prt]NX Manager part number [1250/000] already exists.Using the existing copy.Existing part type [Item] will be retained.

Part # 3, [/users/legacy/ug_import_files/1300_bearing_000.prt]NX Manager part number is [1300/000] in folder [Newstuff]Part will be created with type [Item].

Part # 4, [/users/legacy/ug_import_files/1400_wheel_000.prt]NX Manager part number is [1400/000] in folder [Newstuff]Part will be created with type [Item].

Part # 5, [/users/legacy/ug_import_files/1700_spacer_000.prt]NX Managerpart number is [1700/000] in folder [Newstuff]Part will be created with type [Item].

Creating 1600/000Creating 1300/000Creating 1400/000Creating 1700/000

Starting Save.............

Saved part [1300/000] successfully.Saved part [1400/000] successfully.Saved part [1700/000] successfully.Saved part [1600/000] successfully.

All parts were successfully saved.

************ UG_IMPORT finished without error ************



Activity: Using ug_import to Import the Seed Parts

In this activity, you will use the ug_import utility to import a partfile into a dataset. Specifically, you will import additional seed partsfor drawings. Once the parts are inside Teamcenter Engineering,they will also be placed inside the Unigraphics seed parts folder.

Step 1: Import the seed part files.

In a text editor, view the ug_import.scr.bat script(ug_import.scr on Unix) in the aa_class/ug_import_filesdirectory.

Notice, that the DBAUSER variable is already defined usingthe legacy userid that was created with the make_user scriptin the Organization lesson. All parts will be imported usingthis account.

After reviewing the script, exit the text editor without saving.

Open a terminal window with the Teamcenter Engineering/NXenvironment set.


Type: cd ug_import_files

Type: ug_import.scr.bat seeds (ug_import.scr seeds on Unix)

The following commands are used in the script to import thedrawing seed part files.

ug_import -part=border_b_seed.prt-id=B-Size -rev=000 -import_folder="Seed Parts"

ug_import -part=border_c_seed.prt-id=C-Size -rev=000 -import_folder="Seed Parts"

Step 2: View the import results.

Login to the My Navigator application using the legacy account(User ID: legacy, Password: legacy, leave Group blank).

Expand the Seed Parts folder in the Home folder.



Step 3: Add the Unigraphics seed parts folder to the Home folder.

Choose the Search icon.

This brings up the Search window.

Choose General... from the query pull-down list.

Choose Clear this query form.

Enter Unigraphics seed parts in the Name field.

Choose Execute this query.

The Unigraphics seed parts folder appears in the General Tab.

Copy the Unigraphics seed parts folder to your Home folder.

Choose the Search icon again to close the Search window.



Step 4: Put the import results in the Unigraphics seed parts folder.

Expand the Seed Parts folder to show the B-Size and C-SizeItems.

Expand the Unigraphics seed parts folder and then themanifestation folder.

Use Edit→Cut and Edit→Paste to put the B-Size and C-SizeItems in the manifestation folder.

Step 5: Delete the Seed Parts folder.

Select the Seed Parts folder.

Choose Edit→Delete.

Choose Yes to confirm.




Activity: Import the 1600 Wheel Assembly

In this activity, you will use ug_import to import an assembly part file and itscomponents into the database. You will use a mapping file to convert the partfile names to appropriate part numbers.

Step 1: Import the 1600 Wheel Assembly.

Continue to work from the Teamcenter Engineeringenvironment command window and the ug_import_filesdirectory.

Type: ug_import.scr.bat 1600 (ug_import.scr 1600 on Unix)

The following command is used to import files for the 1600Wheel Assembly.

ug_import -part=1600_wheel_assy_000.prt-search=1600_search.txt-mapping=1600_wheel_assy.map

Step 2: Verify import in My Navigator.

Select your Home folder and choose View→Refresh.

Expand theWheel Assembly Parts folder to show the assemblyparts.

Step 3: Review the 1600 Wheel assembly in NX Integration.

Expand the 1600-Wheel Assembly Item.

Expand the 1600/000-Wheel Assembly ItemRevision.

Double-click on the 1600/000 UGMASTER.

NX Integration starts and loads the 1600-Wheel Assembly.




Import a Non-Master Drawing File

Scenario

In this scenario, a Drawing file will be imported. To import this non-masterpart file the following ug_import arguments will be used.

ug_import -part=1250_axle_000_dwg.prt -id=1250 -rev=000-name=1250_DWG -type=manifestation [-dryrun]

Explanation

The ug_import utility cannot automatically detect whether a standard NXpart file is a master part file or a non-master part file, unless the masterpart file has previously been exported from Teamcenter Engineering usingug_export.

Using Command Line Keywords

A number of command-line keywords are provided that can be used to notifyug_import of the type of part file to be imported:

KEYWORD VALUE-id= The item ID of the master part

file which the non-master partfile is to belong to.

-rev= The item revision which is givento your im ported non-masterpart file.

-type= The type of non-master part file.This may be: specification (orspec for short) ,or manifestation(man for short).

-name= The name of the specification ormanifestation.

The keywords -id and -type must both be present for new non-master parts.The -rev and -name keywords are optional, but are commonly used to providespecific part revision and non-master dataset name.

Note that if -rev is omitted, and the revision is not specified in a mapping file,the configured revision (according to the default configuration rule) is used. Ifthere is no configured revision, then revision "A" is used.

If the -name keyword is absent from the command line, the name of thedataset defaults to the "stripped leafname" of the top part of the assembly.



Activity: Import the 1250 Axle Drawing

In this activity, you will import the 1250_axle_000_dwg.prt drawing file as anon-master UGPART to the 1250 Axle Part.

Step 1: Import the 1250 Axle Drawing.

Continue working from the TcEng environment commandwindow and the ug_import_files directory.

Type: ug_import.scr.bat 1250axledwg (ug_import.scr1250axledwg on Unix)

The following command is used to import the1250_axle_000_dwg.prt file.

ug_import -part=1250_axle_000_dwg.prt-id=1250 -rev=000 -name=1250_DWG-type=manifestation

Step 2: Review the 1250 Axle Drawing in My Navigator.

If necessary, expand the Wheel Assembly Parts folder to showthe 1250 Axle Item.

If necessary, expand the 1250 Item to show the 1250/000ItemRevision.

Select the 1250/000 ItemRevision and choose View→Refresh todisplay the new 1250_DWG UGPART dataset

Select the 1250_DWG UGPART dataset and then chooseView→Named References...

The Named References dialog displays showing the drawingpart file.

Choose Close to close the Named References window.



Step 3: Review the 1250 Axle Drawing using NX Integration

To make this more clear, in NX Integration close all parts.Choose File→Close→All Parts.

Choose Yes to confirm the closing of all parts.

Next Open the 1250 Axle Drawing.

Choose File→Open...

Expand the Wheel Assembly Parts folder and 1250 Itemstructure.

Select the 1250_DWG dataset.

Choose OK.

The axle drawing is loaded into the graphics window.




Import Files Associated to a (Master) Part File

Scenario

In this scenario, some files that are associated to parts will be imported. Toimport these files associated to a part file the following ug_import argumentswill be used.

ug_import -part=1250_axle_a.prt -id=1250 -rev=000-mapping=1600_wheel_assy.map -assoc_files=yes [-dryrun]

Explanation

The ug_import utility allows you to import dependent files that are associatedwith both master and non-master part files. In this case dependent fileswill be imported as named references into the 1250/000 UGMASTER. The-mapping is used to map the Axle name of the 1250 part.

Using Command Line Keywords

Two further command-line arguments provide this capability:

KEYWORD VALUE-assoc_files Used to instruct ug_import whether

to import associated files belonging tothe specified part and associated filesbelonging to all of its components. Thevalue must be "yes" or "no".

-assoc_root_dir Specifies the root directory underwhich sub-directories containing theassociated files belonging to all partsin the spe cified assembly are located.The directory must already exist.

Both -assoc_files and -assoc_root_dir are optional arguments to ug_import.

If you do not specify -assoc_root_dir on the command line, but you still wantassociated files to be imported, you must specify -assoc_files=yes on thecommand line. The ug_import utility then searches the following locations(in the order shown) for the sub-directories containing associated files forindividual parts:

• the directory specified by the assoc_files_dir keyword in a mapping file(if present).

• your current directory.

When the -assoc_root_dir argument is specified on the command line,ug_import assumes that you wish to import associated files belonging to the



part specified on the command line, and the associated files belonging to eachof its components. The associated files are imported from sub-directoriesbeneath the directory specified by -assoc_root_dir.

If the specified associated files directory cannot be located, the import isaborted.

Sub-directory Example

When using -assoc_files=yes without -assoc_root_dir= the dependent fileswill be imported from the directory 1250. The 1250 is determined from thePart ID (1250). The dependent files must be in this directory for ug_importto find them.



Activity: Import the 1250 Axle Associated Files

In this activity, you will use the ug_import utility to import the 1250.tif fileassociated to the 1250 Axle. This part was imported in the previous activitywith the 1600 Wheel Assembly.

Step 1: Import the 1250 Axle Associated files.

Continue working from Teamcenter Engineering environmentcommand window and the ug_import_files directory.

Type: ug_import.scr.bat 1250axleassoc (ug_import.scr1250axleassoc on Unix)

The following command is used to import the 1250.tif file from1250 sub-directory.

ug_import -part=1250_axle_000.prt -id=1250-rev=000 -mapping=1600_wheel_assy.map-assoc_files=yes

Step 2: Review the 1250 Axle Named References in My Navigator.

Locate and select the 1250/000 UGMASTER.

Choose View→Refresh to update the new file(s) in the1250/000 UGMASTER.

Using View→Refresh is necessary since the 1250/000UGMASTER was previous loaded in TeamcenterEngineering.


The Named References window displays showing the part files,including the new 1250_axle_000.tif file.





Import Files Associated to the DWG (Non-Master) Part File

Scenario

In this scenario, some files that are associated to drawings will be imported.To import the files associated to a non-master part file the following ug_importarguments will be used. What does this usage do?

ug_import -part=1250_axle_a.prt -id=1250 -rev=000-name=1250_DWG -type=manifestation -assoc_files=yes

Explanation

The ug_import utility allows you to import dependent files that are associatedwith non-master part files. In this case dependent files will be imported asnamed references into the 1250_DWG UGPART.

Sub-directory Example

When using -assoc_files=yes without -assoc_root_dir= the dependent files willbe imported from the directory /1250_m_1250_dwg. The 1250_m_1250_dwgis determined from part id (1250) + type (m for manifestation) + drawingname (1250_dwg) with an underscore between each section. This gives thesub-directory 1250_m_1250_dwg.

The dependent files must be in this directory for ug_import to find them.



Activity: Import the Axle Drawing Associated Files

In this activity, you will use the ug_import utility to import the1250_000_dwg.cgm file associated to the 1250 Axle Drawing.

Step 1: Import the 1250 Axle Drawing Associated files.

Continue working in command window.

Type: ug_import.scr.bat 1250axledwgassoc (ug_import.scr1250axledwgassoc on Unix)

The following command imports the 1250_000_dwg.cgm filefrom the 1250_m_1250_dwg sub-directory.

ug_import -part=1250_axle_000_dwg.prt-id=1250 -rev=000 -assoc_files=yes

Step 2: Review the 1250 Axle Drawing Named References.

In My Navigator, expand the Wheel Assembly Parts folderstructure to show the 1250 Axle Item.

Expand the 1250 Item.

Expand the 1250/000 ItemRevision.

Select the 1250_DWG UGPART dataset and then chooseView→Refresh to update the new file(s).


The Named References dialog displays showing the files,including the new 1250_000_dwg.cgm file.





Import Files Using a Full Map File

Scenario 6

In this scenario, all the part files (master, non-master, and associated) willbe imported. To import all these files the following ug_import commandswill be used.

ug_import -part=2105_000.prt -mapping=2105_000.map

ug_import -part=2111_000_dwg.prt -mapping=2105_000.map

ug_import -part=2111_000_nc.prt -mapping=2105_000.map

The one map file will control the parameters for all these part files:

• components

• assemblies

• master part files

• non-master part files

• associated files to masters

• associated files to non-masters



KEYWORDs for the Master Parts

These KEYWORDs are used in the mapping file to control the Part ID,Revision, Part Name, and Part Description for the Item, Item Revision, andUGMASTER created during the import.

KEYWORD DESCRIPTION DEFAULTdb_part_no TcEng part

(Item) IDIf the part has been previouslyexported from NX Integration,defaults to the value it had whenexported. Otherwise, defaults to$STRIPPED_LEAFNAME

db_part_rev TcEng partrevision

Defaults to A

db_part_name TcEng part name If the part has been previouslyexported from NX Integration,defaults to the value it had whenexported. Otherwise, defaults to thesame value as db_part_no.

db_part_desc TcEng partdescription

Defaults to the same value asdb_part_no, if specified in amapping file. Otherwise, defaultsto $STRIPPED_LEAFNAME (thefile name of the UG part withoutthe leading directory and the .prtextension).

KEYWORDs for the Non-Master Parts

These KEYWORDs are used in the mapping file to control the name of theUGPART (non-master) and determine the placement of the UGPART insidethe Item Revision (e.g. Specification, Manifestation relation).

db_model_name TcEng datasetname

No default value (not required formaster model type)

db_model_type TcEng modeltype

The model can be: specification(or spec for short) or manifestation(man for short). If not specified themodel type defaults to master.



KEYWORDs for Associated Files for Master/Non-Master Parts

These KEYWORDs are used in the mapping file to control the import ofassociated files (e.g. TIF, CGM, HTML, and other NX files). Specifyingassoc_files=yes will cause ug_import to import files into the UGMASTER orUGPART as additional named references.

KEYWORD DESCRIPTION DEFAULTassoc_files Used to instruct

ug_importwhether toimport filesassociated withthe specifiedassemblyand all of itscomponents.

No default value. If assoc_files_diris not specified, defaults to a nameresembling the part filename. Forexample, the associated files for apart named 2111.prt are located in asub-directory named 2111.

assoc_files_dir Thesub-directoryunder thecurrent directorywhere associatedfiles for thespecified partcan be found.

The full path directory containing theassociated files or the sub-directoryname from the current directorycontaining the associated files.

General purpose KEYWORDs

These general purposed KEYWORDs are used in the mapping file to controlwhat folder imported parts are put into and whether components areoverridden.

import_folder TcEng folderwhere importedparts are placed.

Your Newstuff folder. Note that-import_folder specified on thecommand line takes precedence overimport_folder specified in a mappingfile.

existing_data What to do ifparts alreadyexists in TcEng

Overwrite the existing toppart (only) in the assembly,$OVERWRITE_EXISTING. For all thecomponent parts in the assembly, usethe existing data $USE_EXISTING.



Below is an example map file. This mapping file will specify the ID andRevision for the components but will also state the Model Type, Model Name,and whether the part has Associated Files.

[Defaults]existing_data=$USE_EXISTINGimport_folder="2105 Assembly"assoc_files=no

[2105_000.prt]db_part_id=2105db_part_name="Skate Assembly"db_part_rev=000

[1101_000.prt]db_part_id=1101db_part_name="Wheel Assembly"db_part_rev=000assoc_files=yes

[1150_000.prt]db_part_id=1150db_part_name="Axle"db_part_rev=000

[1113_000.prt]db_part_id=1113db_part_name="Hub"db_part_rev=000

[1110_000.prt]db_part_id=1110db_part_name="Wheel"db_part_rev=000

[2111_000.prt]db_part_id=2111db_part_name="Frame"db_part_rev=000assoc_files=yes

[2111_000_dwg.prt]db_part_id=2111db_part_rev=000db_model_type=manifestationdb_model_name=2111_DWGassoc_files=yes

[2111_000_nc.prt]db_part_id=2111db_part_rev=000db_model_type=manifestationdb_model_name=2111_CAMassoc_files=yes



Activity: Import 2105 Frame Assy with Mapping File

In this activity, you will use the ug_import to import the 2105 FrameAssembly by using a mapping file for all the master parts, non-master parts,and associated files.

Step 1: Import the 2105 Frame Assembly and all of its other files.

In the command window, change to the ug_import_2105directory, located in the aa_class directory.

Open the ug_import_2105.scr.bat script (ug_import_2105.scron Unix) in a text editor.

After reviewing the script, exit the text editor without saving.

Type: ug_import_2105.scr.bat (ug_import_2105.scr on Unix)

The following commands are used to import the assembly files.

ug_import -part=2105_000.prt-mapping=2105_assy.map -assoc_files=yes

ug_import -part=2111_000_dwg.prt-mapping=2105_assy.map -assoc_files=yes

ug_import -part=2111_000_nc.prt-mapping=2105_assy.map -assoc_files=yes

Step 2: Review the 2105 Frame Assembly in My Navigator.

When the script is finished, select the Home folder and chooseView→Refresh.

The 2105 Assembly folder show now be visible.

Expand the 2105 Assembly folder to show the assembly parts.

Step 3: As desired, review the 2105 Frame Assembly using NX Integration.

To make this more clear, in NX Integration, chooseFile→Close→All Parts.

Next Open the 2105 Frame Assembly.

Choose File→Open...

Expand the 2105 Assembly folder and 2105 Item structure.

Select the 2105/000 UGMASTER dataset.

Choose OK.

The 2105 Frame Assembly loads into the graphics window.



Step 4: Review the non-master 2111 Frame Drawing.

From NX, choose File→Open...

Expand the 2105 Assembly folder and 2111 Item structure.

Select the 2111_DWG dataset.

Choose OK.

The frame drawing loads into the graphics window.

Step 5: Close NX Manager.

From NX, choose File→Exit

Choose Yes to confirm the exit.




Importing Non-CAD Files into an ItemThe M243_Heat_Treat text file should be imported into the database to be areference of the 1250 axle part.

The import_file utility allows you to import files into the TeamcenterEngineering database according to a set of user-specified arguments. Thesearguments will supply:

• user identification information

• dataset information

• Item information to be associated with the imported file

The latter is new in this class for the use of import_file. In supplying theItem information, a Dataset and Item will be created and the dataset will beplaced inside the Item.

In practice this utility is used:

1. To import files into Teamcenter Engineering just as datasets (as seemin a previous lesson).

2. To import files into Teamcenter Engineering as datasets and automaticallyplace the dataset inside an Item or Item Revision. The Item can becreated or already exist.

3. To import other CAD files into Teamcenter Engineering as datasets andplace the file inside an Item Revision.

The import_file options for importing a dataset:

IMAN_ROOT/bin/import_file -f=<filename>-type=<datasettype> -d=<dataset_name>-ref=<named_reference> [-item=<item_id>][-revision=<item_rev>] [-ie={n | y}] [-log=<file>]



Activity: Import the Heat Treat Text File

In this activity, you will use the import_file utility to import a text file into thedatabase to be a reference of the 1250 Axle part.

Step 1: Import the m243_heat_treat.txt text file.

In the command window, change back to the ug_import_filesdirectory located in the aa_class directory.

Type: ug_import.scr.bat heattreat ( ug_import.scr heattreaton Unix)

The following command is used to import m243_heat_treat.txtinto the 1250/000 Axle ItemRevision as a Reference.

IMAN_ROOT/bin/import_file -f=m243_heat_treat.txt-d=M243_Heat_Treat -type=Text -ref=Text -de=a-item=1250 -revision=000 -ie=y -log=-

Step 2: Review the imported file inside the 1250 Axle.

Expand the Wheel Assembly Parts folder.

Expand the 1250 Item and 1250/000 ItemRevision.

Select the 1250/000 ItemRevision and choose View→Refresh todisplay the new M243_Heat_Treat dataset.

Double-click on the M243_Heat_Treat dataset.

The M243_Heat_Treat dataset is opened into the default editor.

Review the file, then exit the text editor.




Releasing Previously Imported NX DataAfter the NX data has been imported into Teamcenter Engineering you maychoose to release the data. The import step only imports the data and usuallyleaves the data in an unreleased, writable state.

Normally the release process would require review and signoff by one or moreemployees. In this case the data may have already been in a release stateoutside of Teamcenter Engineering and the data has just been imported.

Especially for CAD/CAM data, in this case the NX data, there may be astronger need for a Single Level Release. Before providing the signoff, theresponsible user may want to open the UGMASTER being released withthe Item Revision.

Considerations in Releasing Item Revisions

When releasing ItemRevisions, the Specification relation objects are releasedtogether with the handler EPM-attach-target-objects.

Considerations in Releasing Non-specification Data

When non-specification data is released the reviewers defined in theprocedure may be different than the reviewer defined in the procedure formaster and specification data.

When releasing non-specification data immediately after the data has beenimported, the data could be released in the same procedure as the master andspecification data. This could be accomplished by initiating the Item Revisionand pasting the non-specification data into the Job (before the Job is started).



Activity: Release the 2111 Item Revision

In this activity, you will use the Import Release process template to releasesome of your previously imported data.

Step 1: Initiate the 2111 Frame ItemRevision.

If necessary, expand the 2105 Assembly folder.

Expand the 2111-Frame Item to show the 2111/000-FrameItemRevision.

Select the 2111/000 Frame ItemRevision.


The New Process dialog appears. The Process Name defaultsto the object name.

Optionally enter a Description: releasing imported data

Set the Process Template Filter to Assigned.

Notice the Process Template defaults to Import Releasebecause of preferences you set in an earlier lesson.

Choose OK.

Step 2: Review the data from your Inbox and perform the signoff.

Choose the Open Inbox icon.

Expand your Tasks to Perform Folder

The perform-signoffs task was automatically assigned to youbecause of the CR-fill-in-reviewers handler you added to theImport Release process template in an earlier lesson.




View the Attachments.

Choose the No Decision link.

Choose Approve, then Apply.

In the Home folder, select the 2111/000-Frame ItemRevisionand choose View→Refresh.

If necessary, select the 2111/000 UGMASTER and chooseView→Refresh.

Notice that the status flags have now been set.





• Imported NX Data into the Database

• Released Imported NX Data


Index

AAccess control . . . . . . . . . . . . . . . . 15-9Access Control . . . . . . . . . . . . . . . . 15-9Adding a New Volume to FMS . . . . 2-32AM Rule Tree . . . . . . . . . . . . . . . 10-13Assigning Default ProcessTemplates . . . . . . . . . . . 12-113, 12-115

Associated filesimport

ug_import . . . . . . . . 16-33, 16-36attribute . . . . . . . . . . . . . . . . . . . . 3-15Auto Assign . . . . . . . . . . . . . . . . . 12-35

BBenefits of the CM Application

Benefits of the ECMApplication . . . . . . . . . . . . . . 13-2

BOMView Types . . . . . . . . . . . . . . . 6-9BOMViews and BOMViewRevisions . . . . . . . . . . . . . . . . . . . 15-5

Business Modeler . . . . . . . . . . . . . . 14-7Business Modeler Deep CopyRules . . . . . . . . . . . . . . . . . . . . . 14-54

Business Modeler ExtensionRules . . . . . . . . . . . . . . . . . . . . . 14-41

Business Modeler Import/ExportRules . . . . . . . . . . . . . . . . . . . . . 14-61

CChange Object Folder Structure

EC Folder Structure . . . . . . . . . . 13-5class . . . . . . . . . . . . . . . . . . . . . . . 3-15Class Attribute Tree . . . . . . . . . . . . 4-6Classes, Types and Properties . . . . 3-14Command Line Keywords withug_import . . . . . . . . . . . . . . . . . 16-16

Command Suppression . . . . . . . . . 14-2

Command Suppression Dialog . . . . 14-3Compound Property Rules . . . . . . 14-27

establishing . . . . . . . . . . . . . . . 14-37Controlling the Workflow with ProcessTemplates . . . . . . . . . . . . . . . . . . 12-7

Course DescriptionIntroduction

class overview . . . . . . . . . . . . 11Create a Query that Finds HomeFolders . . . . . . . . . . . . . . . . . . . . . . 8-7

Create New Dataset and ImportFile . . . . . . . . . . . . . . . . . . . . . . . 5-21

Create Part Files . . . . . . . . . . . . . . 15-6Create Status Types . . . . . . . . . . . . . 9-5Creating a Group . . . . . . . . . . . . . . . 2-9Creating a Multi-Task Process . . . 12-51Creating a Person . . . . . . . . . . . . . 2-12Creating a Process Template that DoesNot Require SignoffCreating a Process Template that Does

Not Require Signof . . . . . . . 12-13Creating a Single Signoff ReleaseProcess . . . . . . . . . . . . . . . . . . . 12-14

Creating a Sub-Group . . . . . . . . . . 2-10Creating a User . . . . . . . . . . . . . . . 2-13Creating a Volume . . . . . . . . . . . . . 2-31Creating Accounts with the make_userUtility . . . . . . . . . . . . . . . . . . . . . 2-39

Creating an Account Interactively . . 2-7Creating Change Types . . . . . . . . . 13-6Creating Process Templates . . . . . . 12-8Creating Saved Queries . . . . . . . . . . 8-2

DDataset Objects . . . . . . . . . . . . . . . . 5-2Dataset Type using the StandardMethod . . . . . . . . . . . . . . . . . . . . 5-12

Dataset Type using the Wizard . . . . 5-6

©UGS, All Rights Reserved Teamcenter Engineering Application Administration Index-1

Index

Defaultsstandard NX defaults . . . . . . . . 15-36

E

EC Folder StructureAffected Items . . . . . . . . . . . . . . 13-5Problem Items . . . . . . . . . . . . . . 13-5Solution Items . . . . . . . . . . . . . . 13-5

Editing the Rule Tree . . . . . . . . . . 10-24Environment Variable Settings for NXIntegration . . . . . . . . . . . . . . . . . 15-35

Exporting and Importing the Rule Treefrom a File . . . . . . . . . . . . . . . . . 10-33

Exporting the Access Manager RuleTree . . . . . . . . . . . . . . . . . . . . . . 10-34

F

Fail-safe Volumes . . . . . . . . . . . . . . 2-33File Management System

FMS . . . . . . . . . . . . . . . . . . . . . . 2-28File Management System (FMS) . . 2-29Files

ug_importmapping files . . . . . . . . . . . 16-20

Form Types . . . . . . . . . . . . . . . . . . . 3-2Forms

using schema editor to add POMclasses . . . . . . . . . . . . . . . . . . . 4-6

H

Handlers, EPMCR-assert-targets-checked-in . . 12-34demote on reject . . . . . . . . . . . . 12-33disallow-adding-targets . . . . . . 12-34

How Rules-Based ProtectionsWork . . . . . . . . . . . . . . . . . . . . . 10-13

How to Use this Manual . . . . . . . . . . 13

I

IMAN_DATA Directory . . . . . . . 1-3, 1-6IMAN_ROOT Directory . . . . . . . 1-3–1-5IMAN_ugmaster_name_separator . . 15-34Import

part filesinto folder other than

Newstuff . . . . . . . . . . . . 16-18Import a Non-Master DrawingFile . . . . . . . . . . . . . . . . . . . . . . 16-30

Import Assembly with Map File andSearch File . . . . . . . . . . . . . . . . . 16-19

Import Component/Assembly Partswithout a Map File . . . . . . . . . . . 16-17

Import Files Associated to a Master PartFile . . . . . . . . . . . . . . . . . . . . . . 16-33

Import Files Associated to the DWG(Non-Master) Part File . . . . . . . . 16-36

Import Files Using a Full MapFile . . . . . . . . . . . . . . . . . . . . . . 16-38

Import Log File . . . . . . . . . . . . . . 16-25import_export_business_rulesutility . . . . . . . . . . . . . . . . . . . . 14-68

Importing an Access Manager RuleTree . . . . . . . . . . . . . . . . . . . . . . 10-35

Importing Files Interactively . . . . . 5-20Importing Files Using the import_fileUtility . . . . . . . . . . . . . . . . . . . . . 5-26

Importing Non-CAD Files into anItem . . . . . . . . . . . . . . . . . . . . . . 16-44

Introduction to Using Command LineKeywords . . . . . . . . . . . . . . . . . . 16-12

Introduction to Using MappingFiles . . . . . . . . . . . . . . . . . . . . . 16-11

Item Structure and NamedReferences . . . . . . . . . . . . . . . . . . 15-3

Item Type Wizard . . . . . . . . . . . . . 4-21Item Types . . . . . . . . . . . . . . . . . . . 4-2

L

List of Values for Form Data . . . . . 3-18Lock part files . . . . . . . . . . . . . . . . 15-9LOV . . . . . . . . . . . . . . . . . . . . . . . 3-18

M

Mapping filesug_import . . . . . . . . . . . . . . . . . 16-20

Methodskey definitions . . . . . . . . . . . . . . 3-15

Index-2 Teamcenter Engineering Application Administration ©UGS, All Rights Reserved MT14350-SG-100

Index

Modify Access to a Query . . . . . . . . 8-14Modify Command SuppressionDefinitions . . . . . . . . . . . . . . . . . . 14-4

Modify Single Object Protections . . 10-10Modify the Blazing BladesPreferences . . . . . . . . . . . 7-5, 7-8, 7-12

NNamed ACLs . . . . . . . . . . . . . . . . 10-15Naming Rules . . . . . . . . . . . . . . . 14-13

establishing . . . . . . . . . . . . . . . 14-16NX / TcEng Terms . . . . . . . . . . . . . 15-2NX Customer Default Files for NXIntegration . . . . . . . . . . . . . . . . . 15-36

NX Data Importintroduction to . . . . . . . . . . . . . . 16-2

NX Integration ImportScenarios . . . . . . . . . . . . . . . . . . 16-13

OObject-based Protections . . . . . . . . 10-3Objects

Workspacemanifestations . . . . . . . . . . 15-12specifications . . . . . . . . . . . 15-12

Occurrence Note Types . . . . . . . . . . 6-4Organization

tips in creating . . . . . . . . . . . . . . 2-16Organize the NX Seed PartsFolder . . . . . . . . . . . . . . . . . . . . 15-14

Overview of Importing Files . . . . . . 5-19Overview of TcEng Workflow . . . . . 12-2Overview of ug_importCapabilities . . . . . . . . . . . . . . . . 16-10

PPart files

importinto folder other than

Newstuff . . . . . . . . . . . . 16-18lock . . . . . . . . . . . . . . . . . . . . . . 15-9

Partscreate from UG

what happens in TcEng . . . . 15-6revisions

what happens in TcEng . . . . 15-7seed

Seed parts . . . . . . . . . . . . . 15-11Parts and Assemblies to beImported . . . . . . . . . . . . . . . . . . . 16-3

Person, User, Role and Group . . . . . . 2-2Preference Setting Hierarchy . . . . . . 7-2Preference Settings for NXIntegration . . . . . . . . . . . . . . . . . 15-33

Preference Settings to Consider . . . . 7-3Preference Settings to Consider for NXIntegration . . . . . . . . . . . . . . . . . 15-34

PreferencesIMAN

IMAN_ugmaster_name_separator . . 15-34Prepare to Import UnigraphicsData . . . . . . . . . . . . . . . . . . . . . . 16-5

primary type . . . . . . . . . . . . . . . . . 3-15Process Model Design for ChangeManagementEC Folder Structure . . . . . . . . . 13-15

Process Templates for NX RelatedData . . . . . . . . . . . . . . . . . . . . . 15-31

Process Terms and Functionality . . 12-4Product Structure Editor (PSE)

revision rule criteria . . . . . . 9-12–9-13Properties

key definitions . . . . . . . . . . . . . . 3-15property . . . . . . . . . . . . . . . . . . . . 3-15Property Rules . . . . . . . . . . . . . . . 14-26

establishing . . . . . . . . . . . . . . . 14-29Protection of objects . . . . . . . . . . . . 15-9

Q

QuerySearching the database . . . . . . . . . 8-2

Quick Release Technique . . 12-26–12-27

R

Releasing Previously ImportedData . . . . . . . . . . . . . . . . . . . . . 16-46

Result of Releasing Data with aProcess . . . . . . . . . . . . . . . . . . . . 12-5

Review of the TcEng ProcessModel . . . . . . . . . . . . . . . . . . . . . . 12-3

©UGS, All Rights Reserved Teamcenter Engineering Application Administration Index-3

Index

Revision rulesPSE criteria . . . . . . . . . . . . 9-12–9-13

Revision Rules Review . . . . . . . . . . . 9-6Revision Rules Setup . . . . . . . . . . . . 9-8Rules-based Protections . . . . . . . . . 10-2

SSchema Editor

Schema Editor UtilityCreate a Class . . . . . . . . . . . . 4-7Delete a Class . . . . . . . . . . . . 4-8

Schema Tree . . . . . . . . . . . . . . . . . . 4-6Search

Searching the database . . . . . . . . . 8-2Searching the database . . . . . . . . . . 8-2Seed Part Preferences . . . . . . . . . 15-13Seed Part Setup . . . . . . . . . . . . . . 15-11Seed parts . . . . . . . . . . . . . . . . . . 15-11

TcEng storage . . . . . . . . . . . . . 15-11Setting Object-based Exception PrivilegeData . . . . . . . . . . . . . . . . . . . . . . 10-9

Setting the TcEng ClassroomEnvironment . . . . . . . . . . . . . . . . . 1-9

Some Useful Canned Handlers . . . 12-33Status Types for Release Status . . . . 9-2Storage of Associated Files . . . . . . . 15-8Structure

lock . . . . . . . . . . . . . . . . . . . . . . 15-9Student Responsibilities . . . . . . . . . 12Sub-type . . . . . . . . . . . . . . . . . . . . 3-15

TTcEng Data Protections

TcEngi-Man Data Protections . . . 10-2TcEng Environment Variables . . . . . 1-7TcEng Install Directory Structures . . 1-3

IMAN_ROOT . . . . . . . . . . . . . 1-3–1-5TcEng Volumes

i-Man Volumes . . . . . . . . . . . . . . 2-28Tips in Creating yourOrganization . . . . . . . . . . . . . . . . 2-16

TR Change Notice Process . . . . . . 13-16Two Usage Modes with Workflow . . 12-6

type . . . . . . . . . . . . . . . . . . . . . . . . 3-15Type Display Rules . . . . . . . . . . . . 14-8

establishing . . . . . . . . . . . . . . . . 14-9Types

key definitions . . . . . . . . . . . . . . 3-15Types of Engineering Changes

Change Types . . . . . . . . . . . . . . . 13-4

Uug_import

associated files . . . . . . . . 16-33, 16-36check import . . . . . . . . . . . . . . . 16-18command syntax . . . . . . . . . . . . 16-13keywords . . . . . . . . . . . . . . . . . 16-13login keywords . . . . . . . . . . . . . 16-16specify part files . . . . . . . . . . . . 16-17

UGMASTER / UGPARTBehavior . . . . . . . . . . . . . . . . . . 15-10

Units of Measure . . . . . . . . . . . . . . . 6-2Units of Measure (UOM)

definition of . . . . . . . . . . . . . . . . . 6-2Use ug_import to Import the SeedParts . . . . . . . . . . . . . . . . . . . . . 16-26

Using (Directory) Search Files . . . 16-12Using ACLs in a ProcessTemplate . . . . . . . . . . . . . . . . . . 12-52

Using Task Handlers in a ProcessTemplate . . . . . . . . . . . . . . . . . . 12-32

Utilitiesmake_user . . . . . . . . . . . . . . . . . 2-39setting the TcEng environment

AA . . . . . . . . . . . . . . . . . . . . . 1-8

VVerify Revision Rule PreferenceSettings . . . . . . . . . . . . . . . . . . . . 9-19

Viewing Data Privileges . . . . . . . . . 10-4Volume management

viewing detailed volumeinformation . . . . . . . . . . . . . . 2-35

WWhat is a Change Object? . . . . . . . 13-3

Index-4 Teamcenter Engineering Application Administration ©UGS, All Rights Reserved MT14350-SG-100

Reference Chart Tear Outs

These tear out reference charts are provided for your convenience.

Teamcenter Engineering Application Administration Student Profile

Name ________________________________________________ Date _____________________

Employer _______________________________________________________________________

U.S. Citizen? Yes / No

When is your planned departure time? ________ am/pm

In order to give the instructor and idea of your backgroundand experience, please answer the following questions.

1. Job title: _______________________________________________________________________

2. Current responsibilities: _________________________________________________________

________________________________________________________________________________

3. How long have you held these responsibilities? Years ______

4. How long have you been working with CAD/CAM & PDM systems? Years ______

5. What other PDM systems are you familiar with? __________________________________

________________________________________________________________________________

6. What other CAD/CAM systems are you familiar with? _____________________________

________________________________________________________________________________

7. Are you currently using TcEng _______ Version _______ Hours per week? ______

8. Are you currently using NX? _______ Version _______ Hours per week? ______

9. What are the primary uses of TcEng at your site? __________________________________

________________________________________________________________________________

10. What do you model in your NX part files (castings, assemblies, etc.)?

________________________________________________________________________________

________________________________________________________________________________

11. Please list other completed CAD/CAM or PDM courses and the provider.

Course Provider

12. Please check the box that best describes your current skill level in the variousTcEng/NX disciplines listed below.

none novice intermediate advancedNX UserNX Manager UserTcEng UserTcEng SystemAdminTcEng ApplicationAdminTcEngDevelopment (ITK)

Additional Comments:____________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

________________________________________________________________________________

V10 Teamcenter Engineering Application Administration Course Agenda

Day 1______

IntroLesson 1Lesson 2Lesson 3Lesson 4Lesson 5

Course OverviewTeamcenter Engineering EnvironmentUser OrganizationForm Types and LOVsItem Data TypesDataset Types

Day 2______

Lesson 5Lesson 6Lesson 7Lesson 8Lesson 9

Dataset Types(cont)Product Structure Data TypesCreating and Modifying PreferencesQueries and ReportsStatus Types and Revision Rules

Day 3______

Lesson 10Lesson 11Lesson 12

Access ManagerProjectsWorkflow Process Modeling

Day 4______

Lesson 12Lesson 13Lesson 14

Workflow Process Modeling (cont)Change ManagementBusiness Modeler

Day 5______

Lesson 15Lesson 16

Setup For NX IntegrationNX Integration Import and Release

team center engineering v10 admin

Documents