esmguide

8/2/2019 ESMGuide

1/53

Teamcenter 2005 SR1

engineering process management

Teamcenter EngineeringEmbedded Software Manager Guide

Publication Number

ENG00049 A

8/2/2019 ESMGuide

2/53

8/2/2019 ESMGuide

3/53

Teamcenter 2005 SR1

engineering process management

Teamcenter EngineeringEmbedded Software Manager Guide

This product is intended for use only described in this document. UGS

cannot be responsible for the proper functioning of undescribed features

and parameters.

Publication Number

ENG00049 A

8/2/2019 ESMGuide

4/53

Manual History

ManualRevision

TeamcenterEngineeringVersion

PublicationDate

A 2005 SR1 June 2006

2006 UGS Corp.

All Rights Reserved.

Produced in the United States of America.

2 Embedded Software Manager Guide ENG00049 A

8/2/2019 ESMGuide

5/53

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Organization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6Teamcenter Engineering Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . 9Submitting Comments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Software Copyright and Trademark Notices . . . . . . . . . . . . . . . . . . . . . . . 9

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Purpose of the Embedded Software Manager . . . . . . . . . . . . . . . . . . . . . . 1-1Installing the ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Installing Default Teamcenter Item Types for Managing Embedded

Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3Setting ESM Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5Customizing ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10Exporting and Importing Mechatronics Data . . . . . . . . . . . . . . . . . . . . . . 1-12Working in a Multi-Site Collaboration Environment . . . . . . . . . . . . . . . . . 1-13Functionality Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13

Managing Embedded Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

Initiating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Building the Functional Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2Building the Overall Product ECU Architecture . . . . . . . . . . . . . . . . . . . . 2-3Creating Software Data and Managing Dependencies . . . . . . . . . . . . . . . . 2-8Designing ECU Software and Associating it With the Appropriate Software

Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11Making Software Available to Flash Onto an ECU . . . . . . . . . . . . . . . . . . 2-11Associating a Software Item With a Teamcenter SCM Object . . . . . . . . . . 2-12Querying Hardware-Software Compatibility . . . . . . . . . . . . . . . . . . . . . . 2-12Registering the ECU Variant for a Given Product Configuration . . . . . . . . 2-13

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1

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

ENG00049 A Embedded Software Manager Guide 3

8/2/2019 ESMGuide

6/53

8/2/2019 ESMGuide

7/53

Preface

This manual describes the Embedded Software Manager (ESM) provided withTeamcenter Engineering. It includes information on the purpose of the ESM andhow to use it to manage embedded software binaries. Teamcenter Engineeringbelongs to the UGS portfolio of digital product lifecycle management softwareand services.

Audience

This manual is for persons responsible for installing or using the EmbeddedSoftware Manager (ESM).

Organization

This manual contains the following chapters and appendix.

Chapter 1 Getting Started provides an overview of the Embedded SoftwareManager (ESM).

Chapter 2 Managing Embedded Software describes how to use theEmbedded Software Manager to manage release binarysoftware.

Appendix A Glossary contains terms applicable to this document.


8/2/2019 ESMGuide

8/53

Preface

Conventions

This manual uses the conventions described in the following sections.

Note, Caution, and Warning Icons

The following icons represent note, caution, and warning messages:

A note icon identifies general instructions or comments that need to beemphasized.

A caution icon identifies practices that can either produce results contraryto what you expect or result in damage to software or data.

A warning icon identifies practices that could result in permanent loss ofdata or software.

Names and Values

This manual represents system names, file names, and values in fonts that help youinterpret the name or value. For example:

The file name is pom_schema_server-name_sid.

The conventions are:

Bold Bold font represents unvarying text or numbers within a name orvalue. Capitalization is as it appears.

In the preceding example, pom_schema_ identifies an unvaryingportion of the name.

Italic Italic font represents text or numbers that vary. The characters initalic text describe the entry. Letters are shown in lowercase, butthe varying text may include uppercase letters.

In the preceding example, server-name and sid represent varyingportions of the name.

text-text A hyphen separates two words that describe a single entry.

In the preceding example, server-name is a single value.

For example, the name of the pom_schema_server-name_sid file may be:

pom_schema_Blue5_f731


8/2/2019 ESMGuide

9/53

Preface

Command Line Entries, File Contents, and Code

This manual represents command line input and output, the contents of system files,and computer code in fonts that help you understand how to enter text or to interpretdisplayed text. For example, the following line represents a command entry:

create_change_types -u=user-name -p=password -g=group -f=file-name


Monospace Monospace font represents text or numbers you enter on acommand line, the computers response, the contents of systemfiles, and computer code.

Capitalization and spacing are shown exactly as you must enterthe characters or as the computer displays the characters.

In the preceding example, create_change_types identifies anunvarying portion of the command.

Italic Italic font represents text or numbers that vary. The words initalic text describe the entry.

The words are shown in lowercase letters, but the varying textmay include uppercase letters. When entering text, use the caserequired by the system.

In the preceding example, user-name, password, group, andfile-name identify varying portions of the command.

text-text A hyphen separates two words that describe a single entry.

In the preceding example, user-name is a single entry in the

command.

The following example is a correct entry for the preceding create_change_typescommand:

create_change_types -u=infodba -p=KLH3b -g=dba -f=change_types.dat


8/2/2019 ESMGuide

10/53

Preface

Syntax Definitions

This manual uses a set of conventions to define the syntax of Teamcenter commands,functions, and properties. Following is a sample syntax format:

harvester_jt.pl [bookmark-file-name bookmark-file-name ...][directory-name directory-name ...]


Bold Bold text represents words and symbols you must enter exactlyas shown.

In the preceding example, you enter harvester_jt.pl exactly asshown.

Italic Italic text represents values that you supply.

In the preceding example, you supply values for bookmark-file-name

and directory-name.

text-text A hyphen separates two words that describe a single value.

In the preceding example, bookmark-file-name is a single value.

[ ] Brackets represent optional elements.

... An ellipsis indicates that you can repeat the preceding element.

Following are examples of correct syntax for the harvester_jt.pl: command:

harvester_jt.pl

harvester_jt.pl assembly123.bkm

harvester_jt.pl assembly123.bkm assembly124.bkm assembly125.bkmharvester_jt.pl AssemblyBookmarks


8/2/2019 ESMGuide

11/53

Preface

Teamcenter Engineering Documentation

Teamcenter Engineering documentation is provided as online help and as printablemanuals:

You can access online help by choosingHelp from the menu bar of a TeamcenterEngineering rich client application or by clicking one of the links under the Helpicon in the Teamcenter Engineering thin client user interface.

You can access the printable manuals from the Teamcenter EngineeringDocumentation CD-ROM. To view the PDF-formatted manuals, use AdobeAcrobat Reader, downloadable free-of-charge from Adobe Systems Incorporatedat the following URL:

http://www.adobe.com

Acrobat Reader allows you to view these manuals online and print selectedpages, sections, or the entire manual. UGS grants permission for Teamcenter

Engineering users to print, duplicate, and distribute this documentation.

Submitting Comments

Portions of Teamcenter software are provided by third-party vendors. Specialagreements with these vendors require UGS to handle all problem reportsconcerning the software they provide. Please submit all comments directly to UGS.

Please feel free to give us your opinion of the usability of this manual, to suggestspecific improvements, and to report errors. Mail your comments to:

UGS Technical Communications

4233 Lexington Avenue N., Suite 3290Arden Hills, MN 55126-6198U.S.A.

To submit an incident report, you can use the UGS GTAC online support tools atthe following URL:

http://support.ugs.com

Software Copyright and Trademark Notices

2006 UGS Corp. All Rights Reserved. This software and related documentation

are proprietary to UGS Corp.

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

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

All other trademarks or registered trademarks belong to their respective holders.

http://www.adobe.com/http://support.ugs.com/http://support.ugs.com/http://www.adobe.com/

8/2/2019 ESMGuide

12/53

8/2/2019 ESMGuide

13/53

Chapter

1 Getting Started

Purpose of the Embedded Software Manager . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

Installing the ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Installing Default Teamcenter Item Types for Managing Embedded Software . . 1-3

Setting ESM Preferences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5

Customizing ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-10

Exporting and Importing Mechatronics Data . . . . . . . . . . . . . . . . . . . . . . . . . 1-12

Working in a Multi-Site Collaboration Environment . . . . . . . . . . . . . . . . . . . 1-13

Functionality Restrictions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-13

ENG00049 A Embedded Software Manager Guide

8/2/2019 ESMGuide

14/53

8/2/2019 ESMGuide

15/53

Chapter

1 Getting Started

This chapter provides an overview of the Embedded Software Manager (ESM).

This chapter includes the following topics:

The purpose of the ESM.

Installing the ESM.

Installing default ESM item types.

Setting ESM preferences.

Customizing ESM.

Exporting and importing Mechatronics data.

Working in a Multi-Site Collaboration environment.

Functionality restrictions.

Purpose of the Embedded Software Manager

The Embedded Software Manager (ESM) allows you to manage binary software inMy Navigator, Product Structure Editor (PSE), and the thin client in the same wayas you manage physical parts. You can view and manage the dependencies betweensoftware, electronic control units (ECUs) and processors. Users can release softwareparts, perform impact analysis, manage changes, and make the software availablefor downloading to external applications that flash (write) embedded softwareonto the ECUs. Detailed procedures for using the ESM are described in chapter 2, Managing Embedded Software.

ENG00049 A Embedded Software Manager Guide 1-1

8/2/2019 ESMGuide

16/53

Chapter 1 Getting Started

Installing the ESM

To install the ESM, you choose the ESM when you install the foundation TeamcenterEngineering product and the rich client with the Teamcenter Environment Manager.For more information, see Installation on Windows Servers, Installation on UNIX

and Linux Servers, and Teamcenter Environment Manager help, respectively.

Alternatively, if you already have Teamcenter installed, you can run TeamcenterEnvironment Manager to add the ESM. For more information, see the description ofhow to modify a configuration in Installation on Windows Servers or Installation onUNIX and Linux Servers.

When you choose the ESM foundation option, you are prompted if you have existingitem types that you want to represent software and processor parts and types, or ifyou want to install the default Teamcenter item types that represent these partsand types.

If you choose to use existing types, you are prompted to update the relevantpreferences after the installation is complete. For more information, seeInstalling Default Teamcenter Item Types for Managing Embedded Software,later in this chapter.

If you choose to install default embedded software item types, Teamcenter runsthe install-esm-software-types utility to install the item types described nextand sets the necessary preferences with the values of the installed types. Youcan also run this utility manually at any time to install these item types.

To activate the ESM functionality, your license file must include an ESM license. Ifan ESM license is not installed, the menu options described in chapter 2, ManagingEmbedded Software, are hidden. By default, these menu options are initially hiddenfor all users and an administrator can use the Command Suppression application

to show them for appropriate groups or users. If no ESM license is available whena user attempts to use the ESM options (for example, because all the licenses areassigned to other users), Teamcenter displays an error message.

1-2 Embedded Software Manager Guide ENG00049 A

8/2/2019 ESMGuide

17/53

Getting Started

Installing Default Teamcenter Item Types for Managing EmbeddedSoftware

When you install default Teamcenter item types, the install-esm-software-typesutility adds the following types to your database:

Type Parent TypeMandatory orOptional Purpose

AppSoftware Software Optional Represents the applicationsoftware, for example,radio.

Calibration Software Optional Represents calibrationsoftware embedded in anelectronic control unit(ECU).

ConfigFile Software Optional Represents configuration

software or a filecontaining informationused by the applicationsoftware. For example,the frequency range of aradio may differ betweenEurope and the U.S.A. Theradio application softwarereads the range from theconfiguration software toidentify the correct range.

PriBootLoader Software Optional Represents the primary

bootloader software thatloads operating softwareinto the ECU.

Processor Item Optional Represents an internalelectronic device that runssoftware. For example, anECU may contain threeCPUs, each of which ismodelled as a processor.

If you need to model aCPU as the product, createa subclass of item, rather

than using this type.

SecBootLoaderSoftware Optional Represents the secondarybootloader software thatcontrols flashing access tothe ECU.


8/2/2019 ESMGuide

18/53


Type Parent TypeMandatory orOptional Purpose

Software Item Optional Parent type for allembedded software. In

general, you would notcreate instances of thistype.

Message PSSignal Mandatory Represents a message thatgroups together simplesignals.

Embeds ImanRelation Mandatory Represents an associationfrom software to processorin the context of astructure. It indicatesthe embedded software(secondary) that is

embedded in a specifiedprocessor (primary).

DependentOn ImanRelation Mandatory Models dependenciesbetween embeddedsoftware within the sameECU or across differentECUs.

GatewayOf ImanRelation Mandatory Models dependenciesbetween processors. A processor that islinked and accessedthrough another processor

(commonly called agateway) is associatedwith the other processorby this relationship.

MemoryTypeLOV

ListOfValues Mandatory Provides the list of valuesfor the Memory Typeattribute of the processor.

ByteOrderLOV

ListOfValues Mandatory Provides the list of values for the byteOrderattribute of the processor.

Hardware

ArchitectureLOV

ListOfValues Mandatory Provides the list of values

for the architectureattribute of the processor,for example, 32bit and64bit.


8/2/2019 ESMGuide

19/53

Getting Started

Setting ESM Preferences

If you decide to use your own types rather than the Teamcenter defaults, theinstallation utility does not set the necessary preferences and you must set thefollowing preferences manually:

You should always set these preference immediately after installing theESM feature before users are given access to the system.

ESM_Software_Categories

This site preference holds values that represent the different categoriesof software in use. Valid values are PriBootloader, SecBootloader,Calibration, AppSoftware, and ConfigSoftware.

By default, this preference is set with these valid values. If your site managesother categories of software, add those categories to this preference and specifythe types for those categories in the ESM__Software_Types

preference described next. Conversely, if your site does not have some of thedefault categories, remove the unused values and corresponding software typesfrom the next preference.

ESM__Software_Types

Each of these site preferences holds a value that represents the Teamcenter typethat describes the relevant category. You should create one preference for eachcategory defined in the ESM_Software_Categories preference, following thenaming convention described in the title. You must provide a value for each ofpreferences you create. Subtypes of types mentioned as values in each categoryare considered as types of the corresponding category. Valid values are strings,representing the Teamcenter types corresponding to the category of the software.

For example, you set ESM_Software_Categories as follows:ESM_Software_Categories=

Bootloader

Calibration

Strategy

In this example, you should define the following preferences with appropriatevalues, for example:

ESM_Bootloader_Software_Types=

Bootloader

ESM_Calibration_Software_Types=

Calibration_Type_1

Calibration_Type_2

ESM_Application_Software_Types=

Strategy

ESM_Processor_Type

You should set this site preference to the name of the existing item type thatrepresents the ECU hardware processor. Valid values are any existing itemtypes in the database.


8/2/2019 ESMGuide

20/53


ESM_Processor_is_gateway_attr

You should set this site preference to the name of the existing processor revisionmaster forms logical attribute that represents if the processor is a gatewayprocessor. Valid values are any existing item types revision master forms logical

attribute in the database.

ESM_Processor_linked_attr

Set this site preference to the name of the existing processor revision masterforms logical attribute that represents if the processor is linked. This attributespecifies if the processor is linked to the network or not. Valid values are anyexisting item types revision master forms logical attribute representing ifa processor is linked.

ESM_Processor_programmableInService_attr

Set this site preference to the name of the existing processor revision master

forms logical attribute that represents if the processor is programmable inservice. This attribute specifies if the processor can be programmed in service.Valid values are any existing item types revision master forms logical attributerepresenting if a processor is programmable in service.

ESM_Processor_memoryType_attr

Set this site preference to the name of the existing processor revision masterforms string attribute that represents the memory type attribute of theprocessor. This attribute specifies the processors memory type. Valid values areany existing item types revision master forms string attribute representingthe processors memory type.

ESM_Processor_byteOrder_attr

Set this site preference to the name of the existing processor revision masterforms string attribute that represents the processors byte order. Valid valuesare any existing item types revision master forms string attribute representingthe byte order used by the processor.

ESM_Processor_architecture_attr

Set this site preference to the name of the existing processor revision masterforms string attribute that represents the processors architecture. Valid valuesare any existing item types revision master forms string attribute representingthe architecture (32-bit or 64-bit) used by the processor.

ESM_HW_Compatibility_Report_TransferMode

This site preference holds the value of the transfer mode used togenerate the PLM XML file containing the compatibility reports ofsoftware for a selected hardware. Depending on the transfer mode,you may ha ve to modify the corresponding style sheet preferenceESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset so that, ifthe transfer mode generates more information, the style sheet can display itcorrectly.


8/2/2019 ESMGuide

21/53

Getting Started

ESM_SW_Compatibility_Report_TransferMode

This site preference holds the value of the transfer mode used togenerate the PLM XML file containing the compatibility reports ofhardware for a selected software. Depending on the transfer mode,

you may have to modify the corresponding style sheet preferenceESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset so that, ifthe transfer mode generates more information, the style sheet can display itcorrectly.

ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset

Update this site preference with the name of the dataset containing the stylesheet used to display the compatible software of a given hardware in HTMLformat.

ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset

Update this site preference with the name of the dataset containing the stylesheet used to display the compatible hardware of a given software in HTMLformat.

ESM_HW_Compatibility_Report_Excel_StyleSheet_Dataset

Update this site preference with the name of the dataset containing the stylesheet used to display the compatible software of a given hardware in MicrosoftExcel format.

ESM_SW_Compatibility_Report_Excel_StyleSheet_Dataset

Update this site preference with the name of the dataset containing the style

sheet used to display the compatible hardware of a given software in MicrosoftExcel format.

ESM_Compatibility_Report_Excel_Template_Dataset

Update this site preference with the name of the dataset containing the MicrosoftExcel template used to display the hardware-software and software-hardwarecompatibility reports.

SIG_asystem_source_rules

Restricts the creation of associations of the source type for a message and signalto only the types or classes that appear in the preference. If the preferencevalue is a class or a type, the subtypes of the class or type are automaticallyincluded and considered as valid. Set this preference value with valid values oftypes or classes for the primary and secondary, for the associations to be created.Customer-specific types or classes previously used as primary or secondary forthis association must be appended to the values for this preference for theassociations to be created with those objects.

If this preference value is not set, the user cannot associate any object of anytype in the source role.


8/2/2019 ESMGuide

22/53


Do not remove the rules listed for this preference. If required, you should appendthe secondary list to include their valid secondaries for existing primary types oradd new values for their new primary types. Valid values are:

Message:Item,

Signal:Interfaces,

ProcessVariable:Interfaces,Item

Multiple values are allowed with each primary-secondary pair and should beseparated by commas.

SIG_asystem_target_rules

Restricts the creation of associations of the target type for a message and signalto only the types or classes that appear in the preference. If the preferencevalue is a class or a type, the subtypes of the class or type are automaticallyincluded and considered as valid. Set this preference value with valid values oftypes or classes for the primary and secondary, for the associations to be created.Customer-specific types or classes previously used as primary or secondary for

this association must be appended to the values for this preference for theassociations to be created with those objects.

If this preference value is not set, the user cannot associate any object of anytype in the target role.

Do not remove the rules listed for this preference. If required, append thesecondary list to include their valid secondaries for existing primary types or addnew values for their new primary types. Valid values are:

Message:Item,

Signal:Interfaces,

ProcessVariable:Interfaces,Item

Multiple values are allowed with each primary-secondary pair and should be

separated by commas.

SIG_asystem_transmitter_rules

Restricts the creation of associations of the transmitter type for a message andsignal to only the types or classes that appear in the preference. If the preferencevalue is a class or a type, the subtypes of the class or type are automaticallyincluded and considered as valid. Set this preference value with valid values oftypes or classes for the primary and secondary, for the associations to be created.Customer-specific types or classes previously used as primary or secondary forthis association must be appended to the values for this preference for theassociations to be created with those objects.

If this preference value is not set, the user cannot a PSSignal or its subtypewith an object of any type in the transmitter role.

Do not remove the rules listed for this preference. If required, append thesecondary list to include their valid secondaries for existing primary types or addnew values for their new primary types. Valid values are:

PSSignal:PSConnection,

ProcessVariable:PSConnection

Multiple values are allowed.


8/2/2019 ESMGuide

23/53

Getting Started

SIG_pvariable_rules

Restricts the creation of associations of the ProcessVariable type for amessage and signal to only the types or classes that appear in the preference.If the preference value is a class or a type, the subtypes of the class or type

are automatically included and considered as valid. Set this preference valuewith valid values of types or classes for the primary and secondary, for theassociations to be created. Customer-specific types or classes previously used asprimary or secondary for this association must be appended to the values for thispreference for the associations to be created with those objects.

If this preference value is not set, the user cannot a PSSignal or its subtypewith an object of any type in the process variable role.

Do not remove the rules listed for this preference. If required, append thesecondary list to include their valid secondaries for existing primary types or addnew values for their new primary types. The valid value is:

PSSignal:ProcessVariable

SIG_redundant_rules

Restricts the creation of associations of redundant signals or messages to onlythe types or classes that appear in the preference. If the preference value is aclass or a type, the subtypes of the class or type are automatically includedand considered as valid. Set this preference value with valid values of typesor classes for the primary and secondary, for the associations to be created.Customer-specific types or classes previously used as primary or secondary forthis association must be appended to the values for this preference for theassociations to be created with those objects.

If this preference value is not set, the user cannot a PSSignal or its subtype

with an object of any type in the redundant role.Do not remove the rules listed for this preference. If required, append thesecondary list to include their valid secondaries for existing primary types or addnew values for their new primary types. The valid value is:

PSSignal:PSSignal

WEB_menu_entry_suppressions

To allow users to see the ESM menu options in the thin client, you must removethe following values from this site preference:

Embedded Software Explorer

Embedded Software Manager

Signal Explorer

Associate Signal To

Remove Signal Association

For detailed information about these preferences, see the Configuration Guide.


8/2/2019 ESMGuide

24/53


Customizing ESM

The ESM module provides the following ITK functions that allow you to customizethe ESM operation:

ESM_is_processorGiven a BOM line tag, this function checks if it is a processor BOM line.

ESM_is_gateway

Given a processor BOM line tag, this function checks if it is a gateway processorBOM line.

ESM_is_software

Given a BOM line tag, this function checks if it is a software BOM line.

ESM_associate_processor_to_software

Given a processor BOM line and an array of software BOM lines, this methodassociates processor and software with the Embeds relation. To save theassociations, the BOM window must be saved.

ESM_associate_processor_to_processor

Given a gateway processor BOM line, and an array of software BOM lines, thismethod associates processor and software with the Embeds relation.

ESM_associate_software_to_software

Given a software BOM line and an array of software BOM lines, this methodassociates software with the Dependent On relation. To save the associations,the BOM window must be saved.

ESM_remove_processor_to_software_association

Given a processor BOM line and an array of software BOM lines, this methodremoves the Embeds relation association between processor and software lines.

ESM_remove_processor_to_processor_association

Given a gateway processor BOM line and an array of associated processor BOMlines, this method removes the GatewayOfrelation association between theprocessor lines.

ESM_remove_software_to_software_association

Given a software BOM line and an array of software BOM lines, this methodremoves the Dependent On relation association with the software lines.

ESM_ask_embedded_software_of_processor

Given a processor BOM line, this function gets an array of software BOM linesthat are associated to the processor with an Embeds relation.

ESM_ask_gateway_of_processor

Given a processor BOM line, this function gets an array of gateway processorBOM lines that are associated as the gateway with the input processor line.


8/2/2019 ESMGuide

25/53

Getting Started

ESM_ask_processors_accessedby_processor

Given a gateway processor BOM line, this function gets an array of processorBOM lines that are accessed through the input gateway.

ESM_ask_dependent_software_of_softwareGiven a primary software BOM line, this function gets an array of (secondary)software BOM lines that are dependent on the primary software.

ESM_ask_software_used_by_software

Given a (secondary) software BOM line, this function gets an array of (primary)software BOM lines that are used by the secondary software.

In addition, the SIG module provides the following ITK functions that allow you tocustomize the operations that can be performed on frames, signals, and relations.

SIG_ask_signal_source

Finds all the sources of a signal or message line tag using the associated_systemrelation.

SIG_ask_signal_target

Finds all the targets of a signal or message line tag using the associated_systemrelation.

SIG_ask_signal_transmitters

Finds all the transmitters of a signal or message line tag using theassociated_system relation.

SIG_ask_device_sources

Finds all the source devices that transmit messages or signals to the input targetdevice. This function uses the underlying associated_system relation betweensource and message or signal.

SIG_ask_device_targets

Finds all the targets devices to which the device transmits messages or signals.This function uses the underlying associated_system relation between targetand message or signal.

SIG_ask_device_ transmitted_signals

Finds all the frames or signals that are transmitted by a source device. This

function uses the underlyingassociated_system relation between source andmessage or signal.

SIG_ask_device_ received_signals

Finds all the messages or signals that are received by a target device. Thisfunction uses the underlyingassociated_system relation between target andmessage or signal.

For detailed information and syntax of these functions, see the Integration Toolkit Function Reference manual. Each of these functions has an equivalent serviceinterface, as described in the Web Services Guide.


8/2/2019 ESMGuide

26/53


Exporting and Importing Mechatronics Data

When you export or import structure data in PLM XML format, the followingMechatronics and embedded software object types are also transferred:

Connection (revisable)

GDELink (nonrevisable connection)

Signal

Message

Connection_Terminal (GDE)

Network_Port (GDE)

ProcessVariable (GDE)

Processor (item)

Software

Variant Item


8/2/2019 ESMGuide

27/53

Getting Started

Working in a Multi-Site Collaboration Environment

When you share product structures in a Multi-Site Collaboration environment, thefollowing embedded software objects can also be shared:

Software item

When a user imports or exports an assembly that includes a software item,Teamcenter transfers the associated relations (DependentOn, Embeds) andthe associated secondary objects.

Message

When a user imports or exports an assembly that includes messages, Teamcentertransfers the associated relations (Source and Target ECUs, transmitter)and the associated secondary objects.

Processor

When a user imports or exports an assembly that includes a processor,Teamcenter transfers the associated relations (Embeds and GatewayOf) andthe associated secondary objects.

Remote users can only modify shared structures if they have the necessary accessprivileges.

For information about the Multi-Site Collaboration environment, see Multi-SiteCollaboration Help.

Functionality Restrictions

In general, you can complete most tasks in the rich client or the thin client in similarways. However, the following functional restrictions exist in the thin client:

You cannot see general design elements (GDEs) within product structures in thethin client. Users can only create GDE objects in the My Navigator applicationof the rich client and cannot add or view them in the product structure in thethin client.

Software and hardware compatibility reports are not available in the thin client.View compatibility reports in the My Navigator application of the rich client,by choosing the ToolsEmbedded Software ManagerCompatibility Reportsmenu option.


8/2/2019 ESMGuide

28/53

8/2/2019 ESMGuide

29/53

Chapter

2 Managing Embedded Software

Initiating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Building the Functional Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

Building the Overall Product ECU Architecture . . . . . . . . . . . . . . . . . . . . . . 2-3Creating ECU Items and a Network of ECUs . . . . . . . . . . . . . . . . . . . . . 2-3

Creating and Associating Messages and Signals . . . . . . . . . . . . . . . . . . . 2-3Creating a Signal Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Associating Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4Removing Associations From Signals . . . . . . . . . . . . . . . . . . . . . . . . 2-4Showing the Associations of a Signal . . . . . . . . . . . . . . . . . . . . . . . . . 2-5Viewing Received and Transmitted Signals . . . . . . . . . . . . . . . . . . . . 2-5

Creating and Manipulating Processors . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6Creating a New Processor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6Viewing the Software Associated With a Processor . . . . . . . . . . . . . . . 2-6 Associating Processors With a Gateway Processor . . . . . . . . . . . . . . . 2-7Viewing the Processors Accessed Through a Gateway Processor . . . . . . 2-7Viewing the Gateway Processors Associated With a Processor . . . . . . . 2-7Removing Gateway Processors Associations From a Processor . . . . . . . 2-7

Creating Software Data and Managing Dependencies . . . . . . . . . . . . . . . . . . 2-8Creating a Software Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8Associating Software With Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9Removing Software Associations From a Processor . . . . . . . . . . . . . . . . . . 2-9Removing Associations Between Software Items . . . . . . . . . . . . . . . . . . . 2-10Showing the Processors Associated With a Software Item . . . . . . . . . . . . . 2-10Showing the Software Associated With a Software Item . . . . . . . . . . . . . . 2-10

Designing ECU Software and Associating it With the Appropriate Software

Part . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

Making Software Available to Flash Onto an ECU . . . . . . . . . . . . . . . . . . . . . 2-11

Associating a Software Item With a Teamcenter SCM Object . . . . . . . . . . . . . 2-12

Querying Hardware-Software Compatibility . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Reporting Compatible Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12Reporting Compatible Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13

Registering the ECU Variant for a Given Product Configuration . . . . . . . . . . . 2-13


8/2/2019 ESMGuide

30/53

8/2/2019 ESMGuide

31/53

Chapter

2 Managing Embedded Software

This chapter describes how to use the Embedded Software Manager to managerelease binary software.

The Embedded Software Manager (ESM) allows you to manage binary software

in the same way as you manage other hard parts. You can view and managethe dependencies between software and processors. Users can release softwareparts, perform impact analysis, manage changes, configure software, and makethe software available for downloading to external applications that flash (write)embedded software into memory.

The ESM menu options described in this chapter must be enabled using CommandSuppression, as described in Command Suppression Help.

All steps in the following procedures should be completed in PSE unlessstated otherwise.

The general steps when managing embedded software are:

1. Initiate a project.

2. Build the functional model.

3. Build the overall product ECU architecture.

4. Creating software data and managing dependencies

5. Designing software and associating it to the appropriate software part.

6. Making the software available for flashing on the ECU.

7. Registering the ECU variant for a given product configuration.

The following sections explain how you can perform each of these steps withTeamcenter.


8/2/2019 ESMGuide

32/53

Chapter 2 Managing Embedded Software

Initiating a Project

Before you use the ESM, the administrator creates the necessary projects andassigns user groups to them. The Organization application allows you to createprojects and groups, then assign groups or individual users to each project. For

more information, see Organization Help.

Building the Functional Model

A system engineer creates the required functions and decomposes the functionsinto further subfunctions. The information exchange between the functions is alsomodeled.

You create functions by choosing the FileNewItem menu option and selecting theFunctionality item. Create the functional decomposition by opening the functionin PSE and adding subfunctions to the function. Define ports of the function and

model information exchanges between ports by choosing the FileNewSignalsmenu option.


8/2/2019 ESMGuide

33/53

Managing Embedded Software

Building the Overall Product ECU Architecture

A system engineer creates the overall product architecture, as follows:

1. Identifies the number of electronic control units (ECUs) needed and creates

them within the product.

2. Identifies messaging protocols.

3. Creates the required networks and associates ECUs to the network.

4. Distributes functions across the ECU network.

5. Creates and adds processors to the ECUs.

6. Defines dependencies between ECUs, that is, frames between ECUs.

7. Identifi

es the signals that are consumed and transmitted as part of each frame.

8. Assigns each of the ECUs to a design engineer for detailed design work.

Creating ECU Items and a Network of ECUs

To create an ECU item, choose the NewItem menu option and select theappropriate item type that represents the ECU part at your site.

Teamcenter does not provide a specific default item type for ECUs.

To create a network of ECUs, choose the NewConnectionRevisable menu optionand select the Connection item type for each type of network to the product.

You can define ports on the ECUs while creating the ECU networks. To create aport, choose the NewInterface Definition menu option and select the InterfaceDefinition type.

After you create the networks, add them to the ECU structure and associate the ECUports on each network to the network by choosing the EditConnect menu option.

Distributing Functions Across the ECU Networks

The system engineer distributes the functions identified for the product acrossdifferent ECUs in the network. You use the Teamcenter Allocations functionalityto allocate functions from the functional model to the ECUs in the ECU structure.Allocations can only be made programmatically, as described in the Integration forWiring Harness Design Tools manual.

Creating and Associating Messages and Signals

The system engineer creates and associates messages and signals when building thestructure of the ECUs. The messages and signals exchanged between ECUs resultfrom how the functions are distributed across the ECUs. They help to identify thedependencies between ECUs and assist in managing the communication matrix.


8/2/2019 ESMGuide

34/53


Creating a Signal Object

To create a new signal:

1. Choose the FileNewSignal menu option, then choose the appropriate type of

signal (Message or Signal). Teamcenter displays the New Signal dialog window.

2. Enter an ID, revision, name, and description for the signal, then click Finish.Teamcenter creates a new signal of the specified type.

Optionally, you can click Next, rather than Finish, then proceed to define otherattributes of the signal and assign it to a project.

Associating Signals

You can associate a signal or message with other objects as follows:

1. Select a message and one or more objects of the appropriate type (for example,an ECU item for a message or a port for a signal) in the product structure. The

valid appropriate types are configured in the SIG_asystem_source_rules andSIG_asystem_target_rules preferences. For details of how to set preferences,see the Configuration Guide.

2. Choose the ToolsSignal ManagerAssociate Signal To menu option, thenchoose one of the following options:

Source

The object is the source, transmitter, or origin of the signal.

Target

The object is the target, receiver, or destination of the signal.

Transmitter

Select a connection or its subtype with the signal or message. Selection ofany other object is invalid in this role.

Process Variable

The process variable associated with the signal. Select the process variablewith the signal or message.

Redundant Signal

The signal is redundant. Copy the redundant signal to the clipboard, selectthe primary signal to associate with the copied redundant signal, and choosethe ToolsSignal ManagerAssociate Signal ToRedundant Signalmenu option.

Teamcenter associates the signal and object.

Removing Associations From Signals

To remove an association between a signal and an object such as an ECU:

1. Select the signal in the product structure.


8/2/2019 ESMGuide

35/53


2. Choose the ToolsSignal ManagerRemove Signal Assocation menu option,then choose one of the following options:

Source

Target

Transmitter

Process Variable

Redundant Signal

Teamcenter displays the Remove Signal Association dialog window containingall the associations of the selected type for the signal, if there is more than one.

In the case of a process variable, the Remove dialog window is notdisplayed and the association between the process variable and thesignal is removed immediately.

3. Select the required association, then click Remove. Teamcenter removes theselected association from the signal.

Showing the Associations of a Signal

To show the associations of a signal:

1. Select the signal in the product structure.

2. Choose the ViewSignal Explorermenu option, then choose one of the followingoptions:

Source

Target

Transmitter

Process Variable

Redundant Signal

Teamcenter highlights the appropriate associated objects depending on theselected option for the signal.

Viewing Received and Transmitted Signals

You can view the received or transmitted signals for a selected object such as anECU, as follows:

1. Select the object in the product structure.

2. To view signals received by the object, choose the ViewSignal ExplorerShowSignalsReceived menu option.

To view transmitted messages, choose the ViewSignal ExplorerShowSignalsTransmitted menu option.


8/2/2019 ESMGuide

36/53


Teamcenter highlights the object and signals of the chosen type in the productstructure. If you select an ECU and choose the Show Source option, Teamcenterhighlights the ECUs that transmit messages for which the selected ECU is atarget. Similarly, if you choose the Show Target option, Teamcenter highlightsECUs that are targets of messages of which the selected ECU is a source.

Creating and Manipulating Processors

The design engineer creates processors and adds them to the ECU hardware itemthat is under the ECU assembly in the product structure.

Creating a New Processor

To create a new processor:

1. Choose the FileNewItemProcessormenu option and Teamcenter displaysthe New Processor dialog window.

2. In the dialog window, enter the processor name and description, then click OK orApply. Teamcenter creates the new processor.

Optionally, you can click Next, rather than OK or Apply, then define the masterform attributes and assign the processor to a project.

If the processor is linked to the network, the linked attribute should be set toTrue and you should enter the processor identifier or define another processor (agateway) through which the processor is accessed. To enter the processor identifier,double-click the Occurrence Name cell and enter the appropriate value. You canuse the processors mapped occurrence name to identify the ECU for which this is aprocessor on the network. The occurrence name should be unique within a givenECU structure.

Viewing the Software Associated With a Processor

You can associate a software item of any type with one or more processors. Inthe product structure, select the software item and the processors in which it willbe embedded, then choose the ToolsEmbedded Software ManagerAssociateSoftware ToProcessormenu option. Teamcenter associates all the software itemswith the processor through an Embeds relationship.

To view the software associated with a processor:

1. Select the processor in the product structure.

2. Choose the ViewEmbedded Software ExplorerShow Associated Softwaremenu option, then choose the Embedded, Used, or Dependent option asappropriate. Teamcenter highlights the processor and all associated software ofthe chosen type in the product structure.


8/2/2019 ESMGuide

37/53


Associating Processors With a Gateway Processor

A gateway processor is one through which you can access other processors withinthe same ECU or across several ECUs. A gateway processor has the isGatewayattribute set to True.

You can associate one or more processors with a single gateway processor, as follows:

1. In the product structure, select each of the processors that you want to associatewith the gateway processor and copy them to the clipboard.

2. In the product structure, select the gateway processor and choose theToolsEmbedded Software ManagerAssociate Processors ToGatewaymenu option. Teamcenter associates all the processors you copied to theclipboard with the gateway processor.

Viewing the Processors Accessed Through a Gateway Processor

To view the processor that are accessed through the gateway processor:

1. Select the gateway processor in the product structure.

2. Choose the ViewEmbedded Software ExplorerShow AssociatedProcessor(s)Accessed By menu option. Teamcenter highlights the gatewayprocessor and all processors accessed through it.

Viewing the Gateway Processors Associated With a Processor

To view the gateway processors associated with a processor:


2. Choose the ViewEmbedded Software ExplorerShow AssociatedProcessor(s)Gateway menu option. Teamcenter highlights the processor andits gateway processors in the product structure.

Removing Gateway Processors Associations From a Processor

To remove the associations between a gateway and accessed processors:

1. Select the gateway processor in the product structure.

2. Choose the ToolsEmbedded Software ManagerRemove Processor

Associations menu option. Teamcenter displays the Remove ProcessorAssociation dialog window, listing all processors accessed through the selectedgateway processor.

3. In the dialog window, select all the accessed processors for which you want toremove the association with the selected gateway processor and click Remove.Teamcenter removes the selected associations.


8/2/2019 ESMGuide

38/53


Creating Software Data and Managing Dependencies

The design engineer creates software data and models dependencies, as follows:

1. Creates application software, calibration software, and bootloader software types

and adds them under the ECU item.

2. Embeds the different software items of the ECU into the processor of the ECUassembly hardware component.

3. Creates the following software dependencies:

Associates the calibration software to the application software binary.

Associates the application software binary to other application softwarebinaries (also called coordinated flash). This dependency may be useful toservice personnel, for example, when a vehicle is serviced. If a problem isidentified in one of the ECUs, the technician may decide to flash the latest

version of the application software onto the ECU. However, the latest versionof the software may work only with specific versions of software on otherECUs. Consequently, these dependent ECUs are affected by the change tothe faulty ECU. To identify this change, the technician must know the othersoftware in the assembly that is affected by changes to the updated software,so the corresponding ECUs can be identified and updated at the same time.

Creating a Software Item

To create a new software item:

1. Choose the FileNewItem menu option, then choose the appropriate type

of software: AppSoftware

Creates an application software item. This type represents the software thatimplements the actual functionality.

Calibration

Creates a calibration software item. This type represents the software thatcalibrates the application software.

Config File

Creates a confi

gurationfi

le software item. This type represents theconfiguration information on which the application software depends.

PriBootLoader

Creates a primary bootstrap loader software item. This type representsthe bootloader software of the ECU.

SecBootLoader

Creates a secondary bootstrap loader software item. This type representsthe software that makes the ECU flashable.


8/2/2019 ESMGuide

39/53


Software

This is the parent type of all the other software types that are installed if thedefault software types were selected during installation.

Do not instantiate this type, and do not create types of this type. Ifyou create and use this type in an ECU, the Embedded SoftwareManager functionality does not work. UGS recommends you useBusiness Modeler to hide this type or to restrict creation of anyrevisions of this type so that users do not accidentally createsoftware of this type.

Click Next and Teamcenter displays the New Item dialog window for the selectedsoftware type.

2. Enter the identifier and description of the new software item, then click OK orApply. Teamcenter creates a new software item of the selected type.

Optionally, you can click Next again, rather than OK or Apply, then define themaster form attributes and assign the software item to a project.

Associating Software With Software

You can associate one or more software items of any type with another, dependent,software item, as follows:

1. In the product structure, select each of the software items that depend on a givensoftware and copy them to the clipboard.

2. In the product structure, select the software item on which the other software

types selected in step 1 depend and choose the ToolsEmbedded SoftwareManagerAssociate Software ToSoftware menu option. Teamcenterassociates all the software items you copied to the clipboard with the softwareitem on which the items on clipboard depend.

Removing Software Associations From a Processor

To remove the associations between a processor and one or more software items:


2. Choose the ToolsEmbedded Software ManagerRemove Software

Association menu option. Teamcenter displays the Remove Software Associationdialog window, listing all associated software items.

3. In the dialog window, select all the software items that you want to dissociatefrom the processor and click Remove. Teamcenter removes the selectedassociations.


8/2/2019 ESMGuide

40/53


Removing Associations Between Software Items

To remove the associations between software items:

1. Select the software item on which other software item depend in the product

structure.

2. Choose the ToolsEmbedded Software ManagerRemove SoftwareAssociation menu option. Teamcenter displays the Remove Software Associationdialog window, listing all associated software items.

3. In the dialog window, select all the software items that you want to dissociatefrom the software item and click Remove. Teamcenter removes the selectedassociations.

Showing the Processors Associated With a Software Item

To show all the processors associated with a software item:

1. Select the software item in the product structure.

2. Choose the ViewEmbedded Software ExplorerShow AssociatedProcessor(s) menu option, then choose the Embedded option. Teamcenterhighlights the software item and all the processors on which the selectedsoftware is embedded.

Showing the Software Associated With a Software Item

To show all the software that depends on or is used by a software item:

1. Select the software item in the product structure.

2. Choose the ViewEmbedded Software ExplorerShow Associated Softwaremenu option, then choose the Embedded, Used or Depends option, asappropriate. Teamcenter highlights the software item and all the software inwhich the software item is used or on which it depends.


8/2/2019 ESMGuide

41/53


Designing ECU Software and Associating it With the AppropriateSoftware Part

A design engineer uses the data in Teamcenter to generate a software specificationthat is sent to an internal development group or external supplier to create thenecessary binary. The general work process is as follows:

A design engineer creates a software specification for the software to be flashedonto the ECU.

The design engineer sends the specification to an internal development group orexternal supplier.

The development group or supplier develops the software in compliance withestablished standards.

The development group or supplier validates the release binary by executing a

preconfigured file format checker. Optionally, the binary may also be convertedto other formats. This step must succeed before the binary is released.

The development group or supplier creates a release binary and associates itwith the software part in Teamcenter as a named reference. The source code ismanaged in the source control management (SCM) system and may also beassociated with the same software part.

To allow file format checkers to verify software binaries, you should create a datasetand attach the software files to it. For information about creating dataset types,see Business Modeler Help. For information about attachingfiles to datasets, seeMy Navigator Help.

Making Software Available to Flash Onto an ECU

The released binary is downloaded by the flashing application so that the flashingtool can store the binary on the ECU. Sometimes the ECU may be preconfiguredand preflashed with the release binary, in which case this step is not necessary.Production personnel or a service technician enters the ECU part number andsoftware type into the flashing application, which retrieves the release binary andmakes it available to the flashing tool for flashing onto the ECU.

The flashing application is linked to Teamcenter through the ApplicationInterface Web Service (AIWS). The flashing application must provide an

AIWS client that calls the exportNamedRefs AIWS method. For moreinformation on how to write an AIWS client, see the Application InterfaceWeb Service (AIWS) Configuration and Customization Guide.


8/2/2019 ESMGuide

42/53


Associating a Software Item With a Teamcenter SCM Object

To maintain traceability of the source code that created the embedded binarysoftware, you can use a source control management (SCM) system such as ClearCase,Perforce, VSS, or CVS. The Teamcenter Engineering SCM integration supports

the SCM_Element_Specification relationship. To establish traceability betweensource code and binary, you can paste a Teamcenter SCM object that represents theversion of the software source code to the software item that represents the softwarebinary with this relationship, as follows:

1. In My Navigator, select the Teamcenter SCM object and choose the EditCopymenu option.

2. Select the software item revision and choose the EditPaste... menu option.Teamcenter displays the Paste Add As dialog window.

3. Choose the SCM_Element_Specification relationship from the list in thedialog window and click OK.

Querying Hardware-Software Compatibility

During the life of a product, service engineers may need to change the hardwareor the software of the product. When making such changes, the engineer mustdetermine the compatibility of the replacement item with the existing parts. If thesoftware is changed, the existing hardware must be compatible the new version ofthe software. Similarly, when changing the hardware, the new hardware should becompatible with the software, otherwise a new software must be flashed.

You can use compatibility reports to:

For a given software, identify the compatible hardware by choosing theSoftware-Hardware option.

For a given hardware, identify the compatible software by choosing theHardware-Software option.

Reporting Compatible Software

Given a defined hardware identifier (for example, an ECU hardware part number),you can query for all compatible software parts and assemblies, as follows:

1. In My Navigator, choose the ToolsEmbedded SoftwareManagerCompatibility ReportHardware-Software menu optionand Teamcenter displays the Software Compatibility Report dialog window.

2. Enter the item identifier and revision of the hardware item and click Next.

3. Select a report format from the list of available formats, choose any otherformatting options, and click Finish. Teamcenter generates the requested report,which you can view, print or save.


8/2/2019 ESMGuide

43/53


Reporting Compatible Hardware

Given a defined software identifier, you can query for all compatible hardware partsand assemblies, as follows:

1. In My Navigator, choose the ToolsEmbedded SoftwareManagerCompatibility ReportSoftware-Hardware menu optionand Teamcenter displays the Hardware Compatibility Report dialog window.

2. Enter the item identifier and revision of the software item and click Next.

3. Select a report format from the list of available formats and click Finish.Teamcenter generates the requested report, which you can view, print or save.

Registering the ECU Variant for a Given Product Configuration

After the designer uploads the software part to Teamcenter, you can register itfor a given product configuration with the Add Part to Product wizard in PlatformDesigner. You can configure a given ECU to a particular variant and add the ECUvariant as a part to the product. Alternatively, you can add individual componentssuch as hardware or software to the product.

For details of how to set up Platform Designer and use the Add Part to Productwizard, see Platform Designer Help.


8/2/2019 ESMGuide

44/53

8/2/2019 ESMGuide

45/53

Appendix

A Glossary


8/2/2019 ESMGuide

46/53

8/2/2019 ESMGuide

47/53

Appendix

A Glossary

This appendix defines Teamcenter Engineering terms.

B

Bulk DataPhysical information represented in the database by a data item. Examples of bulkdata are file system items, paper documents, and microfiche. The TeamcenterEngineering database describes the bulk data. The bulk data resides elsewhere, forexample, in a file system or in a filing cabinet. See also Data Item.

C

ConnectionObject that defines the connectivity between two or more terminals in a physicalmodel.

D

Data ItemTeamcenter Engineering object representing bulk data defined and manipulated byapplication products, for example, papers that reside in a filing cabinet, directoriesand files that reside in a file system, Excel spreadsheets, and CAD model anddrawingfiles. Metadata for the data item resides in the Teamcenter Engineeringdatabase. See also Bulk Data and Metadata.

Dataset TypeTeamcenter Engineering object that contains a list of tools that can operate on adataset.

E

ECUSee Electronic Control Unit.

Electronic Control UnitSelf-containing processor unit that controls electromechanical functions within aproduct structure.

Embedded Software ManagerOptional extension to PSE and My Navigator that allows you to manage embeddedsoftware binaries as part of the product structure.

ENG00049 A Embedded Software Manager Guide A-1

8/2/2019 ESMGuide

48/53

Appendix A Glossary

ESMSee Embedded Software Manager.

F

FeaturePhysical or geometric object associated with a product, component, or part.Alternatively, a logical attribute of a product, component, or part. Examples: a weldpoint, a signal, or a geometric pattern. A feature may be represented by a genericdesign element (GDE) in a BOM. See also Generic Design Element.

G

GDESee Generic Design Element.

Generic Design ElementBOM item that cannot have different revisions. See also Feature.

I

Interface PortSingle access point to the functionality of a piece of equipment, for example, a USBport that provides an interface to a computer.

M

MechatronicsIntegration of mechanical engineering with electronics and intelligent computercontrol in the design and manufacture of products and processes.

MessageGroup of simple signals. A message is the payload data segment in a frame. Theframe conforms to a standard protocol such as CAN_HS, CAN-LS, FlexRay or MOST.

MetadataObject description in the Teamcenter Engineering database.

Multi-Site CollaborationTeamcenter Engineering capability that allows the exchange of data objects amongseveral Teamcenter Engineering databases. Transfer of objects among databases

is controlled by daemon processes running on designated servers. Objects arereplicated by exporting them from their original database and importing them intothe requesting database. Configuration of Multi-Site Collaboration is optional.

P

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

A-2 Embedded Software Manager Guide ENG00049 A

8/2/2019 ESMGuide

49/53

Glossary

PortOccurrence of an interface port that represents the access point of a functionalmodule in a given context, for example, a USB 2.0 port on a computer processor.

S

SignalPhysical (electrical) means of transferring a message from one system to another.

ENG00049 A Embedded Software Manager Guide A-3

8/2/2019 ESMGuide

50/53

8/2/2019 ESMGuide

51/53

Index

A

Adobe Acrobat Reader . . . . . . . . . . . . . . . 9 AppSoftware type . . . . . . . . . . . . . . . . . 1-3

B

ByteOrder LOV . . . . . . . . . . . . . . . . . . . 1-4

C

Calibration type . . . . . . . . . . . . . . . . . . 1-3Code conventions . . . . . . . . . . . . . . . . . . 7Command line entry conventions . . . . . . . 7ConfigFile type . . . . . . . . . . . . . . . . . . . 1-3Conventions

Caution icons . . . . . . . . . . . . . . . . . . . . 6Code . . . . . . . . . . . . . . . . . . . . . . . . . . 7Command line entries . . . . . . . . . . . . . 7File contents . . . . . . . . . . . . . . . . . . . . 7Names . . . . . . . . . . . . . . . . . . . . . . . . 6Note icons . . . . . . . . . . . . . . . . . . . . . . 6

Syntax definitions . . . . . . . . . . . . . . . . 8Values . . . . . . . . . . . . . . . . . . . . . . . . . 6Warning icons . . . . . . . . . . . . . . . . . . . 6

Customizing . . . . . . . . . . . . . . . . . . . . 1-10

D

DependentOn relation . . . . . . . . . . . . . . 1-4Documentation . . . . . . . . . . . . . . . . . . . . 9

Online help . . . . . . . . . . . . . . . . . . . . . 9Printable files . . . . . . . . . . . . . . . . . . . 9

EECU

Building architecture . . . . . . . . . . . . . 2-3Creating items . . . . . . . . . . . . . . . . . . 2-3Creating network . . . . . . . . . . . . . . . . 2-3

ECU networkDistributing functions . . . . . . . . . . . . 2-3

ECUsAssociating software part . . . . . . . . . 2-11Flashing software . . . . . . . . . . . . . . 2-11

Registering variant . . . . . . . . . . . . . 2-13Reporting compatible software . . . . . 2-12

Embedded Software Manager . . . . . . . . . 2-1Embeds relation . . . . . . . . . . . . . . . . . . 1-4ESM

Installation . . . . . . . . . . . . . . . . . . . . 1-2Purpose . . . . . . . . . . . . . . . . . . . . . . . 1-1

ESM__Software_Types

preference . . . . . . . . . . . . . . . . . . . . . . 1-5ESM_ask_dependent_software_of_softwareITK function . . . . . . . . . . . . . . . . . . . 1-11

ESM_ask_embedded_software_of_processorITK function . . . . . . . . . . . . . . . . . . . 1-10

ESM_ask_gateway_of_processor ITKfunction . . . . . . . . . . . . . . . . . . . . . . 1-10

ESM_ask_processors_accessedby_processorITK function . . . . . . . . . . . . . . . . . . . 1-11

ESM_ask_software_used_by_software ITKfunction . . . . . . . . . . . . . . . . . . . . . . 1-11

ESM_associate_processor_to_processor ITKfunction . . . . . . . . . . . . . . . . . . . . . . 1-10

ESM_associate_processor_to_software ITKfunction . . . . . . . . . . . . . . . . . . . . . . 1-10

ESM_associate_software_to_software ITKfunction . . . . . . . . . . . . . . . . . . . . . . 1-10

ESM_Compatibility_Report_Excel_Template_Dataset preference . . . 1-7

ESM_HW_Compatibility_Report_Excel_StyleSheet_Datasetpreference . . . . . . . . . . . . . . . . . . . . . . 1-7

ESM_HW_Compatibility_Report_HTML_StyleSheet_Datasetpreference . . . . . . . . . . . . . . . . . . . . . . 1-7

ESM_HW_Compatibility_Report_TransferMode preference . . . . . 1-6

ESM_is_gateway ITK function . . . . . . . 1-10ESM_is_processor ITK function . . . . . . 1-10ESM_is_software ITK function . . . . . . . 1-10ESM_Processor_ architecture_attr

preference . . . . . . . . . . . . . . . . . . . . . . 1-6ESM_Processor_byte Order_attr

preference . . . . . . . . . . . . . . . . . . . . . . 1-6ESM_Processor_is_ gateway_attr

preference . . . . . . . . . . . . . . . . . . . . . . 1-6

ENG00049 A Embedded Software Manager Guide Index-1

8/2/2019 ESMGuide

52/53

Index

ESM_Processor_linked_attrpreference . . . . . . . . . . . . . . . . . . . . . . 1-6

ESM_Processor_memory Type_attrpreference . . . . . . . . . . . . . . . . . . . . . . 1-6

ESM_Processor_programmable InService_attr

preference . . . . . . . . . . . . . . . . . . . . . . 1-6ESM_Processor_Type preference . . . . . . 1-5ESM_remove_processor_to_processor_association

ITK function . . . . . . . . . . . . . . . . . . . 1-10ESM_remove_processor_to_software_association

ITK function . . . . . . . . . . . . . . . . . . . 1-10ESM_remove_software_to_software_association

ITK function . . . . . . . . . . . . . . . . . . . 1-10ESM_Software_Categories preference . . . 1-5ESM_SW_Compatibility_

Report_TransferMode preference . . . . . 1-7ESM_SW_Compatibility_Report_

Excel_StyleSheet_Dataset preference . . 1-7ESM_SW_Compatibility_Report_HTML_StyleSheet_Datasetpreference . . . . . . . . . . . . . . . . . . . . . . 1-7

Exporting data . . . . . . . . . . . . . . . . . . 1-12

F

File contents conventions . . . . . . . . . . . . . 7Functional mode, building . . . . . . . . . . . 2-2Functions

Distributing across network . . . . . . . . 2-3

GGateway processor

Associating with processors . . . . . . . . 2-7Removing associated processors . . . . . 2-7Viewing accessing processors . . . . . . . 2-7Viewing associated processors . . . . . . . 2-7

GatewayOf relation . . . . . . . . . . . . . . . . 1-4

H

HardwareArchitecture LOV . . . . . . . . . . 1-4

I

Icon conventions . . . . . . . . . . . . . . . . . . . 6Importing data . . . . . . . . . . . . . . . . . . 1-12Installation

ESM . . . . . . . . . . . . . . . . . . . . . . . . . 1-2Item types . . . . . . . . . . . . . . . . . . . . . 1-3

Item types . . . . . . . . . . . . . . . . . . . . . . 1-3

L

LOVsByteOrder . . . . . . . . . . . . . . . . . . . . . 1-4

HardwareArchitecture . . . . . . . . . . . . 1-4MemoryType . . . . . . . . . . . . . . . . . . . 1-4

M

Manual set . . . . . . . . . . . . . . . . . . . . . . . 9MemoryType LOV . . . . . . . . . . . . . . . . . 1-4Message type . . . . . . . . . . . . . . . . . . . . 1-4Messages

Creating . . . . . . . . . . . . . . . . . . . . . . 2-3Manipulating . . . . . . . . . . . . . . . . . . . 2-3

Multi-Site Collaboration . . . . . . . . . . . 1-13

N

Name conventions . . . . . . . . . . . . . . . . . . 6

O

Online help . . . . . . . . . . . . . . . . . . . . . . . 9

P

PLM XML import/export . . . . . . . . . . . 1-12Preferences

ESM__Software_Types . . . 1-5ESM_Compatibility_Report_

Excel_Template_Dataset . . . . . . . . 1-7ESM_HW_Compatibility_

Report_Excel_StyleSheet_Dataset . . 1-7ESM_HW_Compatibility_

Report_TransferMode . . . . . . . . . . 1-6

ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset . . . . . . 1-7ESM_Processor_ architecture_attr . . . . 1-6ESM_Processor_byte Order_attr . . . . . 1-6ESM_Processor_is_ gateway_attr . . . . 1-6ESM_Processor_linked_attr . . . . . . . . 1-6ESM_Processor_memory Type_attr . . . 1-6ESM_Processor_programmable

InService_attr . . . . . . . . . . . . . . . . 1-6ESM_Processor_Type . . . . . . . . . . . . . 1-5ESM_Software_Categories . . . . . . . . . 1-5ESM_SW_Compatibility_

Report_Excel_StyleSheet_Dataset . . 1-7

ESM_SW_Compatibility_Report_TransferMode . . . . . . . . . . 1-7

ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset . . . . . . 1-7

Setting . . . . . . . . . . . . . . . . . . . . . . . 1-5SIG_asystem_source_rules . . . . . . . . . 1-7SIG_asystem_target_rules . . . . . . . . . 1-8SIG_asystem_transmitter_rules . . . . . 1-8SIG_pvariable_rules . . . . . . . . . . . . . . 1-9SIG_redundant_rules . . . . . . . . . . . . . 1-9WEB_ui_suppressed_actions . . . . . . . . 1-9

Index-2 Embedded Software Manager Guide ENG00049 A

8/2/2019 ESMGuide

53/53

Index

Primary BootLoader type . . . . . . . . . . . . 1-3Processor type . . . . . . . . . . . . . . . . . . . 1-3Processors

Associating with gateway processor . . . 2-7Creating . . . . . . . . . . . . . . . . . . . . . . 2-6

Creating new . . . . . . . . . . . . . . . . . . . 2-6Manipulating . . . . . . . . . . . . . . . . . . . 2-6Removing associated gateway

processor . . . . . . . . . . . . . . . . . . . 2-7Removing associated software . . . . . . . 2-9Showing associated software . . . . . . . 2-10Viewing accessed gateway processor . . 2-7 Viewing associated gateway

processor . . . . . . . . . . . . . . . . . . . 2-7 Viewing associated software . . . . . . . . 2-6

ProjectsInitiating for ESM . . . . . . . . . . . . . . . 2-2

R

RelationsDependentOn . . . . . . . . . . . . . . . . . . 1-4Embeds . . . . . . . . . . . . . . . . . . . . . . . 1-4GatewayOf . . . . . . . . . . . . . . . . . . . . 1-4

Restrictions . . . . . . . . . . . . . . . . . . . . 1-13

S

Secondary BootLoader type . . . . . . . . . . 1-3SIG_ask_device_ received_signals ITK

function . . . . . . . . . . . . . . . . . . . . . . 1-11SIG_ask_device_ transmitted_signals ITK

function . . . . . . . . . . . . . . . . . . . . . . 1-11SIG_ask_device_sources ITK

function . . . . . . . . . . . . . . . . . . . . . . 1-11SIG_ask_device_targets ITK function . . 1-11SIG_ask_signal_source ITK function . . . 1-11SIG_ask_signal_target ITK function . . . 1-11SIG_ask_signal_transmitters ITK

function . . . . . . . . . . . . . . . . . . . . . . 1-11SIG_asystem_source_rules preference . . . 1-7SIG_asystem_target_rules preference . . . 1-8SIG_asystem_transmitter_rules

preference . . . . . . . . . . . . . . . . . . . . . . 1-8SIG_pvariable_rules preference . . . . . . . 1-9SIG_redundant_rules preference . . . . . . 1-9Signals

Associating . . . . . . . . . . . . . . . . . . . . 2-4C ti 2 3

Creating signal object . . . . . . . . . . . . . 2-4Manipulating . . . . . . . . . . . . . . . . . . . 2-3Removing . . . . . . . . . . . . . . . . . . . . . 2-4Showing associations . . . . . . . . . . . . . 2-5Showing source . . . . . . . . . . . . . . . . . 2-5

Showing target . . . . . . . . . . . . . . . . . 2-5Showing transmitter . . . . . . . . . . . . . 2-5 Viewing received . . . . . . . . . . . . . . . . 2-5 Viewing transmitted . . . . . . . . . . . . . 2-5

Software Associating software . . . . . . . . . . . . . . 2-9Associating with SCM object . . . . . . . 2-12Creating data . . . . . . . . . . . . . . . . . . 2-8Creating new item . . . . . . . . . . . . . . . 2-8Flashing onto ECU . . . . . . . . . . . . . . 2-11Managing dependencies . . . . . . . . . . . 2-8Removing associated processors . . . . . 2-9

Removing associated software . . . . . . 2-10Reporting compatible for ECU . . . . . . 2-12Reporting compatible hardware . . . . . 2-13Showing associated processors . . . . . 2-10Showing associated software . . . . . . . 2-10Viewing associated processors . . . . . . . 2-6

Software type . . . . . . . . . . . . . . . . . . . . 1-4Software, managing embedded . . . . . . . . 2-1Source code management (SCM) . . . . . . 2-12Syntax definition conventions . . . . . . . . . . 8

T

Types . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3AppSoftware . . . . . . . . . . . . . . . . . . . 1-3Calibration . . . . . . . . . . . . . . . . . . . . 1-3ConfigFile . . . . . . . . . . . . . . . . . . . . . 1-3Message . . . . . . . . . . . . . . . . . . . . . . 1-4Primary BootLoader . . . . . . . . . . . . . . 1-3Processor . . . . . . . . . . . . . . . . . . . . . 1-3Secondary BootLoader . . . . . . . . . . . . 1-3Software . . . . . . . . . . . . . . . . . . . . . . 1-4

V

Value conventions . . . . . . . . . . . . . . . . . . 6

Variant, registering ECU . . . . . . . . . . . 2-13

W

WEB_ui_suppressed_actionsf 1 9

esmguide

Documents