Teamcenter 2005 SR1 engineering process management Teamcenter Engineering Embedded Software Manager Guide

Publication Number ENG00049 A

Teamcenter 2005 SR1 engineering process management Teamcenter Engineering Embedded 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

Manual History

Manual Revision A

Teamcenter Engineering Version 2005 SR1

Publication Date June 2006

2006 UGS Corp. All Rights Reserved. Produced in the United States of America. 2 Embedded Software Manager Guide ENG00049 A

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Audience . . . . . . . . . . . . . . . . . . . . . . . . . Organization . . . . . . . . . . . . . . . . . . . . . . Conventions . . . . . . . . . . . . . . . . . . . . . . . Teamcenter Engineering Documentation . . . Submitting Comments . . . . . . . . . . . . . . . . Software Copyright and Trademark Notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

5 5 5 6 9 9 9

Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Purpose of the Embedded Software Manager . . . . . . . . . Installing the ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . Installing Default Teamcenter Item Types for Managing Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting ESM Preferences . . . . . . . . . . . . . . . . . . . . . . . Customizing ESM . . . . . . . . . . . . . . . . . . . . . . . . . . . . Exporting and Importing Mechatronics Data . . . . . . . . . Working in a Multi-Site Collaboration Environment . . . . Functionality Restrictions . . . . . . . . . . . . . . . . . . . . . . ......... ......... Embedded ......... ......... ......... ......... ......... ......... . . . . 1-1 . . . . 1-2 . . . . . . . . . . . . . . . . . . . . . . . . 1-3 1-5 1-10 1-12 1-13 1-13

Managing Embedded Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1 Initiating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Building the Functional Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Building the Overall Product ECU Architecture . . . . . . . . . . . . . . . . . . . . 2-3 Creating Software Data and Managing Dependencies . . . . . . . . . . . . . . . . 2-8 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-12 Registering the ECU Variant for a Given Product Conguration . . . . . . . . 2-13 Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1 Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Index-1

ENG00049 A

Embedded Software Manager Guide

Preface

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

Audience
This manual is for persons responsible for installing or using the Embedded Software Manager (ESM).

Organization
This manual contains the following chapters and appendix. Chapter 1 Chapter 2 Getting Started provides an overview of the Embedded Software Manager (ESM). Managing Embedded Software describes how to use the Embedded Software Manager to manage release binary software. Glossary contains terms applicable to this document.

Appendix A

ENG00049 A

Embedded Software Manager Guide

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 identies general instructions or comments that need to be emphasized. A caution icon identies practices that can either produce results contrary to what you expect or result in damage to software or data. A warning icon identies practices that could result in permanent loss of data or software.

Names and Values

This manual represents system names, le names, and values in fonts that help you interpret the name or value. For example: The le name is pom_schema_server-name_sid. The conventions are: Bold Bold font represents unvarying text or numbers within a name or value. Capitalization is as it appears. In the preceding example, pom_schema_ identies an unvarying portion of the name. Italic Italic font represents text or numbers that vary. The characters in italic text describe the entry. Letters are shown in lowercase, but the varying text may include uppercase letters. In the preceding example, server-name and sid represent varying portions 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 le may be: pom_schema_Blue5_f731

Embedded Software Manager Guide

ENG00049 A

Preface

Command Line Entries, File Contents, and Code

This manual represents command line input and output, the contents of system les, and computer code in fonts that help you understand how to enter text or to interpret displayed text. For example, the following line represents a command entry:
create_change_types -u=user-name -p=password -g=group -f=file-name

The conventions are:

Monospace

Monospace font represents text or numbers you enter on a command line, the computers response, the contents of system les, and computer code. Capitalization and spacing are shown exactly as you must enter the characters or as the computer displays the characters. In the preceding example, create_change_types identies an unvarying portion of the command.

Italic

Italic font represents text or numbers that vary. The words in italic text describe the entry. The words are shown in lowercase letters, but the varying text may include uppercase letters. When entering text, use the case required by the system. In the preceding example, user-name, password, group, and le-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_types command:
create_change_types -u=infodba -p=KLH3b -g=dba -f=change_types.dat

ENG00049 A

Embedded Software Manager Guide

Preface

Syntax Denitions
This manual uses a set of conventions to dene the syntax of Teamcenter commands, functions, and properties. Following is a sample syntax format: harvester_jt.pl [bookmark-le-name bookmark-le-name ...] [directory-name directory-name ...] The conventions are: Bold Bold text represents words and symbols you must enter exactly as shown. In the preceding example, you enter harvester_jt.pl exactly as shown. Italic Italic text represents values that you supply. In the preceding example, you supply values for bookmark-le-name and directory-name. text-text A hyphen separates two words that describe a single value. In the preceding example, bookmark-le-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.bkm harvester_jt.pl AssemblyBookmarks

Embedded Software Manager Guide

ENG00049 A

Preface

Teamcenter Engineering Documentation

Teamcenter Engineering documentation is provided as online help and as printable manuals: You can access online help by choosing Help from the menu bar of a Teamcenter Engineering rich client application or by clicking one of the links under the Help icon in the Teamcenter Engineering thin client user interface. You can access the printable manuals from the Teamcenter Engineering Documentation CD-ROM. To view the PDF-formatted manuals, use Adobe Acrobat Reader, downloadable free-of-charge from Adobe Systems Incorporated at the following URL: http://www.adobe.com Acrobat Reader allows you to view these manuals online and print selected pages, 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. Special agreements with these vendors require UGS to handle all problem reports concerning 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 suggest specic improvements, and to report errors. Mail your comments to: UGS Technical Communications 4233 Lexington Avenue N., Suite 3290 Arden Hills, MN 55126-6198 U.S.A. To submit an incident report, you can use the UGS GTAC online support tools at the 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 its subsidiaries in the United States and in other countries. Java and all Java-based marks are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries. All other trademarks or registered trademarks belong to their respective holders.

ENG00049 A

Embedded Software Manager Guide

Chapter

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

Chapter

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 in My Navigator, Product Structure Editor (PSE), and the thin client in the same way as you manage physical parts. You can view and manage the dependencies between software, electronic control units (ECUs) and processors. Users can release software parts, perform impact analysis, manage changes, and make the software available for downloading to external applications that ash (write) embedded software onto the ECUs. Detailed procedures for using the ESM are described in chapter 2, Managing Embedded Software.

ENG00049 A

Embedded Software Manager Guide

1-1

Chapter 1

Getting Started

Installing the ESM

To install the ESM, you choose the ESM when you install the foundation Teamcenter Engineering 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 Teamcenter Environment Manager to add the ESM. For more information, see the description of how to modify a conguration in Installation on Windows Servers or Installation on UNIX and Linux Servers. When you choose the ESM foundation option, you are prompted if you have existing item types that you want to represent software and processor parts and types, or if you want to install the default Teamcenter item types that represent these parts and types. If you choose to use existing types, you are prompted to update the relevant preferences after the installation is complete. For more information, see Installing Default Teamcenter Item Types for Managing Embedded Software, later in this chapter. If you choose to install default embedded software item types, Teamcenter runs the install-esm-software-types utility to install the item types described next and sets the necessary preferences with the values of the installed types. You can also run this utility manually at any time to install these item types.

To activate the ESM functionality, your license le must include an ESM license. If an ESM license is not installed, the menu options described in chapter 2, Managing Embedded Software, are hidden. By default, these menu options are initially hidden for 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 when a user attempts to use the ESM options (for example, because all the licenses are assigned to other users), Teamcenter displays an error message.

1-2

Embedded Software Manager Guide

ENG00049 A

Getting Started

Installing Default Teamcenter Item Types for Managing Embedded Software

When you install default Teamcenter item types, the install-esm-software-types utility adds the following types to your database: Type AppSoftware Parent Type Software Mandatory or Optional Optional Purpose Represents the application software, for example, radio. Represents calibration software embedded in an electronic control unit (ECU). Represents conguration software or a le containing information used by the application software. For example, the frequency range of a radio may differ between Europe and the U.S.A. The radio application software reads the range from the conguration software to identify the correct range. Represents the primary bootloader software that loads operating software into the ECU. Represents an internal electronic device that runs software. For example, an ECU may contain three CPUs, each of which is modelled as a processor. If you need to model a CPU as the product, create a subclass of item, rather than using this type. SecBootLoader Software Optional Represents the secondary bootloader software that controls ashing access to the ECU.

Calibration

Software

Optional

CongFile

Software

Optional

PriBootLoader Software

Optional

Processor

Item

Optional

ENG00049 A

Embedded Software Manager Guide

1-3

Chapter 1

Getting Started

Type Software

Parent Type Item

Mandatory or Optional Optional

Purpose Parent type for all embedded software. In general, you would not create instances of this type. Represents a message that groups together simple signals. Represents an association from software to processor in the context of a structure. It indicates the embedded software (secondary) that is embedded in a specied processor (primary). Models dependencies between embedded software within the same ECU or across different ECUs. Models dependencies between processors. A processor that is linked and accessed through another processor (commonly called a gateway) is associated with the other processor by this relationship. Provides the list of values for the Memory Type attribute of the processor. Provides the list of values for the byteOrder attribute of the processor. Provides the list of values for the architecture attribute of the processor, for example, 32bit and 64bit.

Message

PSSignal

Mandatory

Embeds

ImanRelation

Mandatory

DependentOn ImanRelation

Mandatory

GatewayOf

ImanRelation

Mandatory

MemoryType LOV ByteOrder LOV Hardware Architecture LOV

ListOfValues

Mandatory

ListOfValues

Mandatory

ListOfValues

Mandatory

1-4

Embedded Software Manager Guide

ENG00049 A

Getting Started

Setting ESM Preferences

If you decide to use your own types rather than the Teamcenter defaults, the installation utility does not set the necessary preferences and you must set the following preferences manually: You should always set these preference immediately after installing the ESM feature before users are given access to the system. ESM_Software_Categories This site preference holds values that represent the different categories of software in use. Valid values are PriBootloader, SecBootloader, Calibration, AppSoftware, and CongSoftware. By default, this preference is set with these valid values. If your site manages other categories of software, add those categories to this preference and specify the types for those categories in the ESM_<Category>_Software_Types preference described next. Conversely, if your site does not have some of the default categories, remove the unused values and corresponding software types from the next preference. ESM_<Category>_Software_Types Each of these site preferences holds a value that represents the Teamcenter type that describes the relevant category. You should create one preference for each category dened in the ESM_Software_Categories preference, following the naming convention described in the title. You must provide a value for each of preferences you create. Subtypes of types mentioned as values in each category are 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 dene the following preferences with appropriate values, 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 that represents the ECU hardware processor. Valid values are any existing item types in the database.

ENG00049 A

Embedded Software Manager Guide

1-5

Chapter 1

Getting Started

ESM_Processor_is_gateway_attr You should set this site preference to the name of the existing processor revision master forms logical attribute that represents if the processor is a gateway processor. 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 master forms logical attribute that represents if the processor is linked. This attribute species if the processor is linked to the network or not. Valid values are any existing item types revision master forms logical attribute representing if a 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 in service. This attribute species if the processor can be programmed in service. Valid values are any existing item types revision master forms logical attribute representing if a processor is programmable in service.

ESM_Processor_memoryType_attr Set this site preference to the name of the existing processor revision master forms string attribute that represents the memory type attribute of the processor. This attribute species the processors memory type. Valid values are any existing item types revision master forms string attribute representing the processors memory type.

ESM_Processor_byteOrder_attr Set this site preference to the name of the existing processor revision master forms string attribute that represents the processors byte order. Valid values are any existing item types revision master forms string attribute representing the byte order used by the processor.

ESM_Processor_architecture_attr Set this site preference to the name of the existing processor revision master forms string attribute that represents the processors architecture. Valid values are any existing item types revision master forms string attribute representing the 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 to generate the PLM XML le containing the compatibility reports of software for a selected hardware. Depending on the transfer mode, you may have to modify the corresponding style sheet preference ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset so that, if the transfer mode generates more information, the style sheet can display it correctly.

1-6

Embedded Software Manager Guide

ENG00049 A

Getting Started

ESM_SW_Compatibility_Report_TransferMode This site preference holds the value of the transfer mode used to generate the PLM XML le containing the compatibility reports of hardware for a selected software. Depending on the transfer mode, you may have to modify the corresponding style sheet preference ESM_SW_Compatibility_Report_HTML_StyleSheet_Dataset so that, if the transfer mode generates more information, the style sheet can display it correctly.

ESM_HW_Compatibility_Report_HTML_StyleSheet_Dataset Update this site preference with the name of the dataset containing the style sheet used to display the compatible software of a given hardware in HTML format.

ESM_SW_Compatibility_Report_HTML_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 HTML format.

ESM_HW_Compatibility_Report_Excel_StyleSheet_Dataset Update this site preference with the name of the dataset containing the style sheet used to display the compatible software of a given hardware in Microsoft Excel 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 Microsoft Excel format.

ESM_Compatibility_Report_Excel_Template_Dataset Update this site preference with the name of the dataset containing the Microsoft Excel template used to display the hardware-software and software-hardware compatibility reports.

SIG_asystem_source_rules Restricts the creation of associations of the source type for a message 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 value with valid values of types or classes for the primary and secondary, for the associations to be created. Customer-specic types or classes previously used as primary or secondary for this association must be appended to the values for this preference for the associations to be created with those objects. If this preference value is not set, the user cannot associate any object of any type in the source role.

ENG00049 A

Embedded Software Manager Guide

1-7

Chapter 1

Getting Started

Do not remove the rules listed for this preference. If required, you should append the secondary list to include their valid secondaries for existing primary types or add 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 be separated by commas. SIG_asystem_target_rules Restricts the creation of associations of the target type for a message 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 value with valid values of types or classes for the primary and secondary, for the associations to be created. Customer-specic types or classes previously used as primary or secondary for this association must be appended to the values for this preference for the associations to be created with those objects. If this preference value is not set, the user cannot associate any object of any type in the target role. Do not remove the rules listed for this preference. If required, append the secondary list to include their valid secondaries for existing primary types or add 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 be separated by commas. SIG_asystem_transmitter_rules Restricts the creation of associations of the transmitter type for a message 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 value with valid values of types or classes for the primary and secondary, for the associations to be created. Customer-specic types or classes previously used as primary or secondary for this association must be appended to the values for this preference for the associations 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 transmitter role. Do not remove the rules listed for this preference. If required, append the secondary list to include their valid secondaries for existing primary types or add new values for their new primary types. Valid values are:
PSSignal:PSConnection, ProcessVariable:PSConnection

Multiple values are allowed.

1-8

Embedded Software Manager Guide

ENG00049 A

Getting Started

SIG_pvariable_rules Restricts the creation of associations of the ProcessVariable type for a message 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 value with valid values of types or classes for the primary and secondary, for the associations to be created. Customer-specic types or classes previously used as primary or secondary for this association must be appended to the values for this preference for the associations 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 process variable role. Do not remove the rules listed for this preference. If required, append the secondary list to include their valid secondaries for existing primary types or add new 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 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 value with valid values of types or classes for the primary and secondary, for the associations to be created. Customer-specic types or classes previously used as primary or secondary for this association must be appended to the values for this preference for the associations 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 the secondary list to include their valid secondaries for existing primary types or add new 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 remove the 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 Conguration Guide.

ENG00049 A

Embedded Software Manager Guide

1-9

Chapter 1

Getting Started

Customizing ESM
The ESM module provides the following ITK functions that allow you to customize the ESM operation: ESM_is_processor Given 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 processor BOM 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 method associates processor and software with the Embeds relation. To save the associations, the BOM window must be saved. ESM_associate_processor_to_processor Given a gateway processor BOM line, and an array of software BOM lines, this method 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 method associates 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 method removes 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 BOM lines, this method removes the GatewayOf relation association between the processor lines. ESM_remove_software_to_software_association Given a software BOM line and an array of software BOM lines, this method removes 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 lines that 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 processor BOM lines that are associated as the gateway with the input processor line.

1-10

Embedded Software Manager Guide

ENG00049 A

Getting Started

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

ESM_ask_dependent_software_of_software Given 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 to customize 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_system relation. SIG_ask_signal_target Finds all the targets of a signal or message line tag using the associated_system relation. SIG_ask_signal_transmitters Finds all the transmitters of a signal or message line tag using the associated_system relation. SIG_ask_device_sources Finds all the source devices that transmit messages or signals to the input target device. This function uses the underlying associated_system relation between source 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 target and 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 underlying associated_system relation between source and message or signal. SIG_ask_device_ received_signals Finds all the messages or signals that are received by a target device. This function uses the underlying associated_system relation between target and message or signal. For detailed information and syntax of these functions, see the Integration Toolkit Function Reference manual. Each of these functions has an equivalent service interface, as described in the Web Services Guide.

ENG00049 A

Embedded Software Manager Guide

1-11

Chapter 1

Getting Started

Exporting and Importing Mechatronics Data

When you export or import structure data in PLM XML format, the following Mechatronics 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

1-12

Embedded Software Manager Guide

ENG00049 A

Getting Started

Working in a Multi-Site Collaboration Environment

When you share product structures in a Multi-Site Collaboration environment, the following 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) and the associated secondary objects. Message When a user imports or exports an assembly that includes messages, Teamcenter transfers 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) and the associated secondary objects. Remote users can only modify shared structures if they have the necessary access privileges. For information about the Multi-Site Collaboration environment, see Multi-Site Collaboration Help.

Functionality Restrictions
In general, you can complete most tasks in the rich client or the thin client in similar ways. However, the following functional restrictions exist in the thin client: You cannot see general design elements (GDEs) within product structures in the thin client. Users can only create GDE objects in the My Navigator application of the rich client and cannot add or view them in the product structure in the thin 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 Reports menu option.

ENG00049 A

Embedded Software Manager Guide

1-13

Chapter

Managing Embedded Software

Initiating a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Building the Functional Model . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2 Building the Overall Product ECU Architecture . . . . . . . . . . . . . . . . Creating ECU Items and a Network of ECUs . . . . . . . . . . . . . . . Creating and Associating Messages and Signals . . . . . . . . . . . . . Creating a Signal Object . . . . . . . . . . . . . . . . . . . . . . . . . . . Associating Signals . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Removing Associations From Signals . . . . . . . . . . . . . . . . . . Showing the Associations of a Signal . . . . . . . . . . . . . . . . . . . Viewing Received and Transmitted Signals . . . . . . . . . . . . . . Creating and Manipulating Processors . . . . . . . . . . . . . . . . . . . . Creating a New Processor . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing the Software Associated With a Processor . . . . . . . . . Associating Processors With a Gateway Processor . . . . . . . . . Viewing the Processors Accessed Through a Gateway Processor Viewing the Gateway Processors Associated With a Processor . Removing Gateway Processors Associations From a Processor . Creating Software Data and Managing Dependencies . . . . . Creating a Software Item . . . . . . . . . . . . . . . . . . . . . . . Associating Software With Software . . . . . . . . . . . . . . . Removing Software Associations From a Processor . . . . . Removing Associations Between Software Items . . . . . . Showing the Processors Associated With a Software Item Showing the Software Associated With a Software Item . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3 2-3 2-3 2-4 2-4 2-4 2-5 2-5 2-6 2-6 2-6 2-7 2-7 2-7 2-7 2-8 2-8 2-9 2-9 2-10 2-10 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-12 Reporting Compatible Software . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12 Reporting Compatible Hardware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13 Registering the ECU Variant for a Given Product Conguration . . . . . . . . . . . 2-13

ENG00049 A

Embedded Software Manager Guide

Chapter

Managing Embedded Software

This chapter describes how to use the Embedded Software Manager to manage release 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 manage the dependencies between software and processors. Users can release software parts, perform impact analysis, manage changes, congure software, and make the software available for downloading to external applications that ash (write) embedded software into memory. The ESM menu options described in this chapter must be enabled using Command Suppression, as described in Command Suppression Help. All steps in the following procedures should be completed in PSE unless stated 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 ashing on the ECU. 7. Registering the ECU variant for a given product conguration. The following sections explain how you can perform each of these steps with Teamcenter.

ENG00049 A

Embedded Software Manager Guide

2-1

Chapter 2

Managing Embedded Software

Initiating a Project
Before you use the ESM, the administrator creates the necessary projects and assigns user groups to them. The Organization application allows you to create projects 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 functions into further subfunctions. The information exchange between the functions is also modeled. You create functions by choosing the FileNewItem menu option and selecting the Functionality item. Create the functional decomposition by opening the function in PSE and adding subfunctions to the function. Dene ports of the function and model information exchanges between ports by choosing the FileNewSignals menu option.

2-2

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

Building the Overall Product ECU Architecture

A system engineer creates the overall product architecture, as follows: 1. Identies the number of electronic control units (ECUs) needed and creates them within the product. 2. Identies 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. Denes dependencies between ECUs, that is, frames between ECUs. 7. Identies 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 the appropriate item type that represents the ECU part at your site. Teamcenter does not provide a specic default item type for ECUs. To create a network of ECUs, choose the NewConnectionRevisable menu option and select the Connection item type for each type of network to the product. You can dene ports on the ECUs while creating the ECU networks. To create a port, choose the NewInterface Denition menu option and select the Interface Denition type. After you create the networks, add them to the ECU structure and associate the ECU ports on each network to the network by choosing the EditConnect menu option.

Distributing Functions Across the ECU Networks

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

Creating and Associating Messages and Signals

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

ENG00049 A

Embedded Software Manager Guide

2-3

Chapter 2

Managing Embedded Software

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 specied type. Optionally, you can click Next, rather than Finish, then proceed to dene other attributes 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 congured in the SIG_asystem_source_rules and SIG_asystem_target_rules preferences. For details of how to set preferences, see the Conguration Guide. 2. Choose the ToolsSignal ManagerAssociate Signal To menu option, then choose 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 of any other object is invalid in this role. Process Variable The process variable associated with the signal. Select the process variable with the signal or message. Redundant Signal The signal is redundant. Copy the redundant signal to the clipboard, select the primary signal to associate with the copied redundant signal, and choose the ToolsSignal ManagerAssociate Signal ToRedundant Signal menu 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.

2-4

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

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 containing all 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 not displayed and the association between the process variable and the signal is removed immediately. 3. Select the required association, then click Remove. Teamcenter removes the selected 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 Explorer menu option, then choose one of the following options: Source Target Transmitter Process Variable Redundant Signal

Teamcenter highlights the appropriate associated objects depending on the selected option for the signal. Viewing Received and Transmitted Signals You can view the received or transmitted signals for a selected object such as an ECU, as follows: 1. Select the object in the product structure. 2. To view signals received by the object, choose the ViewSignal ExplorerShow SignalsReceived menu option. To view transmitted messages, choose the ViewSignal ExplorerShow SignalsTransmitted menu option.

ENG00049 A

Embedded Software Manager Guide

2-5

Chapter 2

Managing Embedded Software

Teamcenter highlights the object and signals of the chosen type in the product structure. If you select an ECU and choose the Show Source option, Teamcenter highlights the ECUs that transmit messages for which the selected ECU is a target. Similarly, if you choose the Show Target option, Teamcenter highlights ECUs 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 item that is under the ECU assembly in the product structure. Creating a New Processor To create a new processor: 1. Choose the FileNewItemProcessor menu option and Teamcenter displays the New Processor dialog window. 2. In the dialog window, enter the processor name and description, then click OK or Apply. Teamcenter creates the new processor. Optionally, you can click Next, rather than OK or Apply, then dene the master form attributes and assign the processor to a project. If the processor is linked to the network, the linked attribute should be set to True and you should enter the processor identier or dene another processor (a gateway) through which the processor is accessed. To enter the processor identier, double-click the Occurrence Name cell and enter the appropriate value. You can use the processors mapped occurrence name to identify the ECU for which this is a processor on the network. The occurrence name should be unique within a given ECU structure. Viewing the Software Associated With a Processor You can associate a software item of any type with one or more processors. In the product structure, select the software item and the processors in which it will be embedded, then choose the ToolsEmbedded Software ManagerAssociate Software ToProcessor menu option. Teamcenter associates all the software items with 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 Software menu option, then choose the Embedded, Used, or Dependent option as appropriate. Teamcenter highlights the processor and all associated software of the chosen type in the product structure.

2-6

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

Associating Processors With a Gateway Processor A gateway processor is one through which you can access other processors within the same ECU or across several ECUs. A gateway processor has the isGateway attribute 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 associate with the gateway processor and copy them to the clipboard. 2. In the product structure, select the gateway processor and choose the ToolsEmbedded Software ManagerAssociate Processors ToGateway menu option. Teamcenter associates all the processors you copied to the clipboard 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 Associated Processor(s)Accessed By menu option. Teamcenter highlights the gateway processor and all processors accessed through it. Viewing the Gateway Processors Associated With a Processor To view the gateway processors associated with a processor: 1. Select the processor in the product structure. 2. Choose the ViewEmbedded Software ExplorerShow Associated Processor(s)Gateway menu option. Teamcenter highlights the processor and its 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 Processor Association dialog window, listing all processors accessed through the selected gateway processor. 3. In the dialog window, select all the accessed processors for which you want to remove the association with the selected gateway processor and click Remove. Teamcenter removes the selected associations.

ENG00049 A

Embedded Software Manager Guide

2-7

Chapter 2

Managing Embedded Software

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 ECU assembly 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 software binaries (also called coordinated ash). This dependency may be useful to service personnel, for example, when a vehicle is serviced. If a problem is identied in one of the ECUs, the technician may decide to ash the latest version of the application software onto the ECU. However, the latest version of the software may work only with specic versions of software on other ECUs. Consequently, these dependent ECUs are affected by the change to the faulty ECU. To identify this change, the technician must know the other software in the assembly that is affected by changes to the updated software, so the corresponding ECUs can be identied 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 that implements the actual functionality. Calibration Creates a calibration software item. This type represents the software that calibrates the application software. Cong File Creates a conguration le software item. This type represents the conguration information on which the application software depends. PriBootLoader Creates a primary bootstrap loader software item. This type represents the bootloader software of the ECU. SecBootLoader Creates a secondary bootstrap loader software item. This type represents the software that makes the ECU ashable.

2-8

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

Software This is the parent type of all the other software types that are installed if the default software types were selected during installation. Do not instantiate this type, and do not create types of this type. If you create and use this type in an ECU, the Embedded Software Manager functionality does not work. UGS recommends you use Business Modeler to hide this type or to restrict creation of any revisions of this type so that users do not accidentally create software of this type.

Click Next and Teamcenter displays the New Item dialog window for the selected software type. 2. Enter the identier and description of the new software item, then click OK or Apply. Teamcenter creates a new software item of the selected type. Optionally, you can click Next again, rather than OK or Apply, then dene the master 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 given software 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 Software ManagerAssociate Software ToSoftware menu option. Teamcenter associates all the software items you copied to the clipboard with the software item 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: 1. Select the processor in the product structure. 2. Choose the ToolsEmbedded Software ManagerRemove Software Association menu option. Teamcenter displays the Remove Software Association dialog window, listing all associated software items. 3. In the dialog window, select all the software items that you want to dissociate from the processor and click Remove. Teamcenter removes the selected associations.

ENG00049 A

Embedded Software Manager Guide

2-9

Chapter 2

Managing Embedded Software

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 Software Association menu option. Teamcenter displays the Remove Software Association dialog window, listing all associated software items. 3. In the dialog window, select all the software items that you want to dissociate from the software item and click Remove. Teamcenter removes the selected associations.

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 Associated Processor(s) menu option, then choose the Embedded option. Teamcenter highlights the software item and all the processors on which the selected software 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 Software menu option, then choose the Embedded, Used or Depends option, as appropriate. Teamcenter highlights the software item and all the software in which the software item is used or on which it depends.

2-10

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

Designing ECU Software and Associating it With the Appropriate Software Part
A design engineer uses the data in Teamcenter to generate a software specication that is sent to an internal development group or external supplier to create the necessary binary. The general work process is as follows: A design engineer creates a software specication for the software to be ashed onto the ECU. The design engineer sends the specication to an internal development group or external supplier. The development group or supplier develops the software in compliance with established standards. The development group or supplier validates the release binary by executing a precongured le format checker. Optionally, the binary may also be converted to other formats. This step must succeed before the binary is released. The development group or supplier creates a release binary and associates it with the software part in Teamcenter as a named reference. The source code is managed in the source control management (SCM) system and may also be associated with the same software part.

To allow le format checkers to verify software binaries, you should create a dataset and attach the software les to it. For information about creating dataset types, see Business Modeler Help. For information about attaching les to datasets, see My Navigator Help.

Making Software Available to Flash Onto an ECU

The released binary is downloaded by the ashing application so that the ashing tool can store the binary on the ECU. Sometimes the ECU may be precongured and preashed with the release binary, in which case this step is not necessary. Production personnel or a service technician enters the ECU part number and software type into the ashing application, which retrieves the release binary and makes it available to the ashing tool for ashing onto the ECU. The ashing application is linked to Teamcenter through the Application Interface Web Service (AIWS). The ashing application must provide an AIWS client that calls the exportNamedRefs AIWS method. For more information on how to write an AIWS client, see the Application Interface Web Service (AIWS) Conguration and Customization Guide.

ENG00049 A

Embedded Software Manager Guide

2-11

Chapter 2

Managing Embedded Software

Associating a Software Item With a Teamcenter SCM Object

To maintain traceability of the source code that created the embedded binary software, 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_Specication relationship. To establish traceability between source code and binary, you can paste a Teamcenter SCM object that represents the version of the software source code to the software item that represents the software binary with this relationship, as follows: 1. In My Navigator, select the Teamcenter SCM object and choose the EditCopy menu 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_Specication relationship from the list in the dialog window and click OK.

Querying Hardware-Software Compatibility

During the life of a product, service engineers may need to change the hardware or the software of the product. When making such changes, the engineer must determine the compatibility of the replacement item with the existing parts. If the software is changed, the existing hardware must be compatible the new version of the software. Similarly, when changing the hardware, the new hardware should be compatible with the software, otherwise a new software must be ashed. You can use compatibility reports to: For a given software, identify the compatible hardware by choosing the Software-Hardware option. For a given hardware, identify the compatible software by choosing the Hardware-Software option.

Reporting Compatible Software

Given a dened hardware identier (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 Software ManagerCompatibility ReportHardware-Software menu option and Teamcenter displays the Software Compatibility Report dialog window. 2. Enter the item identier and revision of the hardware item and click Next. 3. Select a report format from the list of available formats, choose any other formatting options, and click Finish. Teamcenter generates the requested report, which you can view, print or save.

2-12

Embedded Software Manager Guide

ENG00049 A

Managing Embedded Software

Reporting Compatible Hardware

Given a dened software identier, you can query for all compatible hardware parts and assemblies, as follows: 1. In My Navigator, choose the ToolsEmbedded Software ManagerCompatibility ReportSoftware-Hardware menu option and Teamcenter displays the Hardware Compatibility Report dialog window. 2. Enter the item identier 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 Conguration

After the designer uploads the software part to Teamcenter, you can register it for a given product conguration with the Add Part to Product wizard in Platform Designer. You can congure a given ECU to a particular variant and add the ECU variant as a part to the product. Alternatively, you can add individual components such as hardware or software to the product. For details of how to set up Platform Designer and use the Add Part to Product wizard, see Platform Designer Help.

ENG00049 A

Embedded Software Manager Guide

2-13

Appendix

Glossary

ENG00049 A

Embedded Software Manager Guide

Appendix

Glossary

This appendix denes Teamcenter Engineering terms.

B Bulk Data Physical information represented in the database by a data item. Examples of bulk data are le system items, paper documents, and microche. The Teamcenter Engineering database describes the bulk data. The bulk data resides elsewhere, for example, in a le system or in a ling cabinet. See also Data Item. C Connection Object that denes the connectivity between two or more terminals in a physical model. D Data Item Teamcenter Engineering object representing bulk data dened and manipulated by application products, for example, papers that reside in a ling cabinet, directories and les that reside in a le system, Excel spreadsheets, and CAD model and drawing les. Metadata for the data item resides in the Teamcenter Engineering database. See also Bulk Data and Metadata. Dataset Type Teamcenter Engineering object that contains a list of tools that can operate on a dataset. E ECU See Electronic Control Unit. Electronic Control Unit Self-containing processor unit that controls electromechanical functions within a product structure. Embedded Software Manager Optional extension to PSE and My Navigator that allows you to manage embedded software binaries as part of the product structure.

ENG00049 A

Embedded Software Manager Guide

A-1

Appendix A

Glossary

ESM See Embedded Software Manager. F Feature Physical or geometric object associated with a product, component, or part. Alternatively, a logical attribute of a product, component, or part. Examples: a weld point, a signal, or a geometric pattern. A feature may be represented by a generic design element (GDE) in a BOM. See also Generic Design Element. G GDE See Generic Design Element. Generic Design Element BOM item that cannot have different revisions. See also Feature. I Interface Port Single access point to the functionality of a piece of equipment, for example, a USB port that provides an interface to a computer. M Mechatronics Integration of mechanical engineering with electronics and intelligent computer control in the design and manufacture of products and processes. Message Group of simple signals. A message is the payload data segment in a frame. The frame conforms to a standard protocol such as CAN_HS, CAN-LS, FlexRay or MOST. Metadata Object description in the Teamcenter Engineering database. Multi-Site Collaboration Teamcenter Engineering capability that allows the exchange of data objects among several Teamcenter Engineering databases. Transfer of objects among databases is controlled by daemon processes running on designated servers. Objects are replicated by exporting them from their original database and importing them into the requesting database. Conguration of Multi-Site Collaboration is optional. P PLM XML UGS format for facilitating product life cycle interoperability using XML. PLM XML is open and based on standard W3C XML schemas. Representing a variety of product data both explicitly and via references, PLM XML provides a lightweight, extensible, and exible mechanism for transporting high-content product data over the Internet.

A-2

Embedded Software Manager Guide

ENG00049 A

Glossary

Port Occurrence of an interface port that represents the access point of a functional module in a given context, for example, a USB 2.0 port on a computer processor. S Signal Physical (electrical) means of transferring a message from one system to another.

ENG00049 A

Embedded Software Manager Guide

A-3

Index

A Adobe Acrobat Reader . . . . . . . . . . . . . . . 9 AppSoftware type . . . . . . . . . . . . . . . . . 1-3 B ByteOrder LOV . . . . . . . . . . . . . . . . . . . 1-4 C Calibration type . . . . . . . . . . . . Code conventions . . . . . . . . . . . Command line entry conventions CongFile type . . . . . . . . . . . . . Conventions Caution icons . . . . . . . . . . . . . Code . . . . . . . . . . . . . . . . . . . Command line entries . . . . . . File contents . . . . . . . . . . . . . Names . . . . . . . . . . . . . . . . . Note icons . . . . . . . . . . . . . . . Syntax denitions . . . . . . . . . Values . . . . . . . . . . . . . . . . . . Warning icons . . . . . . . . . . . . Customizing . . . . . . . . . . . . . . . D DependentOn relation Documentation . . . . . Online help . . . . . . Printable les . . . . E ECU Building architecture . . . Creating items . . . . . . . . Creating network . . . . . . ECU network Distributing functions . . ECUs Associating software part Flashing software . . . . . . . . . . . . . . . 2-3 . . . . . . . . . . 2-3 . . . . . . . . . . 2-3 . . . . . . . . . . 2-3 . . . . . . . . . 2-11 . . . . . . . . . 2-11 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4 . 9 . 9 . 9 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3 . 7 . 7 1-3

.. 6 .. 7 .. 7 .. 7 .. 6 .. 6 .. 8 .. 6 .. 6 1-10

Registering variant . . . . . . . . . . . . . 2-13 Reporting compatible software . . . . . 2-12 Embedded Software Manager . . . . . . . . . 2-1 Embeds relation . . . . . . . . . . . . . . . . . . 1-4 ESM Installation . . . . . . . . . . . . . . . . . . . . 1-2 Purpose . . . . . . . . . . . . . . . . . . . . . . . 1-1 ESM_<Category>_Software_Types preference . . . . . . . . . . . . . . . . . . . . . . 1-5 ESM_ask_dependent_software_of_software ITK function . . . . . . . . . . . . . . . . . . . 1-11 ESM_ask_embedded_software_of_processor ITK function . . . . . . . . . . . . . . . . . . . 1-10 ESM_ask_gateway_of_processor ITK function . . . . . . . . . . . . . . . . . . . . . . 1-10 ESM_ask_processors_accessedby_processor ITK function . . . . . . . . . . . . . . . . . . . 1-11 ESM_ask_software_used_by_software ITK function . . . . . . . . . . . . . . . . . . . . . . 1-11 ESM_associate_processor_to_processor ITK function . . . . . . . . . . . . . . . . . . . . . . 1-10 ESM_associate_processor_to_software ITK function . . . . . . . . . . . . . . . . . . . . . . 1-10 ESM_associate_software_to_software ITK function . . . . . . . . . . . . . . . . . . . . . . 1-10 ESM_Compatibility_Report_ Excel_Template_Dataset preference . . . 1-7 ESM_HW_Compatibility_ Report_Excel_StyleSheet_Dataset preference . . . . . . . . . . . . . . . . . . . . . . 1-7 ESM_HW_Compatibility_ Report_HTML_StyleSheet_Dataset preference . . . . . . . . . . . . . . . . . . . . . . 1-7 ESM_HW_Compatibility_ Report_TransferMode preference . . . . . 1-6 ESM_is_gateway ITK function . . . . . . . 1-10 ESM_is_processor ITK function . . . . . . 1-10 ESM_is_software ITK function . . . . . . . 1-10 ESM_Processor_ architecture_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6 ESM_Processor_byte Order_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6 ESM_Processor_is_ gateway_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6

ENG00049 A

Embedded Software Manager Guide

Index-1

Index

ESM_Processor_linked_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6 ESM_Processor_memory Type_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6 ESM_Processor_programmable InService_attr preference . . . . . . . . . . . . . . . . . . . . . . 1-6 ESM_Processor_Type preference . . . . . . 1-5 ESM_remove_processor_to_processor_association ITK function . . . . . . . . . . . . . . . . . . . 1-10 ESM_remove_processor_to_software_association ITK function . . . . . . . . . . . . . . . . . . . 1-10 ESM_remove_software_to_software_association ITK function . . . . . . . . . . . . . . . . . . . 1-10 ESM_Software_Categories preference . . . 1-5 ESM_SW_Compatibility_ Report_TransferMode preference . . . . . 1-7 ESM_SW_Compatibility_Report_ Excel_StyleSheet_Dataset preference . . 1-7 ESM_SW_Compatibility_Report_ HTML_StyleSheet_Dataset preference . . . . . . . . . . . . . . . . . . . . . . 1-7 Exporting data . . . . . . . . . . . . . . . . . . 1-12 F File contents conventions . . . . . . . . . . . . . 7 Functional mode, building . . . . . . . . . . . 2-2 Functions Distributing across network . . . . . . . . 2-3 G Gateway processor Associating with processors . . Removing associated processors Viewing accessing processors . Viewing associated processors . GatewayOf relation . . . . . . . . . . H HardwareArchitecture LOV . . . . . . . . . . 1-4 I Icon conventions Importing data . Installation ESM . . . . . . . Item types . . . Item types . . . . L LOVs ByteOrder . . . . . . . . . . . . . . . . . . . . . 1-4 ................... 6 . . . . . . . . . . . . . . . . . 1-12 . . . . . . . . . . . . . . . . . . 1-2 . . . . . . . . . . . . . . . . . . 1-3 . . . . . . . . . . . . . . . . . . 1-3 .. . .. .. .. . . . . . . . . . . . . . . . . . . . . 2-7 2-7 2-7 2-7 1-4

HardwareArchitecture . . . . . . . . . . . . 1-4 MemoryType . . . . . . . . . . . . . . . . . . . 1-4 M Manual set . . . . . . . . . . MemoryType LOV . . . . . Message type . . . . . . . . Messages Creating . . . . . . . . . . Manipulating . . . . . . . Multi-Site Collaboration

............. 9 . . . . . . . . . . . . 1-4 . . . . . . . . . . . . 1-4 . . . . . . . . . . . . 2-3 . . . . . . . . . . . . 2-3 . . . . . . . . . . . 1-13

N Name conventions . . . . . . . . . . . . . . . . . . 6 O Online help . . . . . . . . . . . . . . . . . . . . . . . 9 P PLM XML import/export . . . . . . . . . . Preferences ESM_<Category>_Software_Types . ESM_Compatibility_Report_ Excel_Template_Dataset . . . . . . ESM_HW_Compatibility_ Report_Excel_StyleSheet_Dataset ESM_HW_Compatibility_ Report_TransferMode . . . . . . . . ESM_HW_Compatibility_Report_ HTML_StyleSheet_Dataset . . . . ESM_Processor_ architecture_attr . . ESM_Processor_byte Order_attr . . . ESM_Processor_is_ gateway_attr . . ESM_Processor_linked_attr . . . . . . ESM_Processor_memory Type_attr . ESM_Processor_programmable InService_attr . . . . . . . . . . . . . . ESM_Processor_Type . . . . . . . . . . . ESM_Software_Categories . . . . . . . ESM_SW_Compatibility_ Report_Excel_StyleSheet_Dataset ESM_SW_Compatibility_ Report_TransferMode . . . . . . . . ESM_SW_Compatibility_Report_ HTML_StyleSheet_Dataset . . . . Setting . . . . . . . . . . . . . . . . . . . . . SIG_asystem_source_rules . . . . . . . SIG_asystem_target_rules . . . . . . . SIG_asystem_transmitter_rules . . . SIG_pvariable_rules . . . . . . . . . . . . SIG_redundant_rules . . . . . . . . . . . WEB_ui_suppressed_actions . . . . . .

. 1-12 . . 1-5 . . 1-7 . . 1-7 . . 1-6 . . . . . . . . . . . . 1-7 1-6 1-6 1-6 1-6 1-6

. . 1-6 . . 1-5 . . 1-5 . . 1-7 . . 1-7 . . . . . . . . . . . . . . . . 1-7 1-5 1-7 1-8 1-8 1-9 1-9 1-9

Index-2

Embedded Software Manager Guide

ENG00049 A

Index

Primary BootLoader type . . . . . . . . . . Processor type . . . . . . . . . . . . . . . . . Processors Associating with gateway processor . Creating . . . . . . . . . . . . . . . . . . . . Creating new . . . . . . . . . . . . . . . . . Manipulating . . . . . . . . . . . . . . . . . Removing associated gateway processor . . . . . . . . . . . . . . . . . Removing associated software . . . . . Showing associated software . . . . . . Viewing accessed gateway processor Viewing associated gateway processor . . . . . . . . . . . . . . . . . Viewing associated software . . . . . . Projects Initiating for ESM . . . . . . . . . . . . . R Relations DependentOn Embeds . . . . . GatewayOf . . Restrictions . . . S . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . 1-3 . . 1-3 . . . . . . . . . . . . 2-7 2-6 2-6 2-6

. 2-7 . 2-9 2-10 . 2-7

. . 2-7 . . 2-6 . . 2-2

. . . .

. 1-4 . 1-4 . 1-4 1-13

Creating signal object . . . . . . . Manipulating . . . . . . . . . . . . . Removing . . . . . . . . . . . . . . . Showing associations . . . . . . . Showing source . . . . . . . . . . . Showing target . . . . . . . . . . . Showing transmitter . . . . . . . Viewing received . . . . . . . . . . Viewing transmitted . . . . . . . Software Associating software . . . . . . . . Associating with SCM object . . Creating data . . . . . . . . . . . . Creating new item . . . . . . . . . Flashing onto ECU . . . . . . . . . Managing dependencies . . . . . Removing associated processors Removing associated software . Reporting compatible for ECU . Reporting compatible hardware Showing associated processors Showing associated software . . Viewing associated processors . Software type . . . . . . . . . . . . . . Software, managing embedded . . Source code management (SCM) . Syntax denition conventions . . . T Types . . . . . . . . . . . . . . AppSoftware . . . . . . . Calibration . . . . . . . . CongFile . . . . . . . . . Message . . . . . . . . . . Primary BootLoader . . Processor . . . . . . . . . Secondary BootLoader Software . . . . . . . . . . V . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . .

2-4 2-3 2-4 2-5 2-5 2-5 2-5 2-5 2-5

. 2-9 2-12 . 2-8 . 2-8 2-11 . 2-8 . 2-9 2-10 2-12 2-13 2-10 2-10 . 2-6 . 1-4 . 2-1 2-12 .. 8

Secondary BootLoader type . . . . . . . . . . 1-3 SIG_ask_device_ received_signals ITK function . . . . . . . . . . . . . . . . . . . . . . 1-11 SIG_ask_device_ transmitted_signals ITK function . . . . . . . . . . . . . . . . . . . . . . 1-11 SIG_ask_device_sources ITK function . . . . . . . . . . . . . . . . . . . . . . 1-11 SIG_ask_device_targets ITK function . . 1-11 SIG_ask_signal_source ITK function . . . 1-11 SIG_ask_signal_target ITK function . . . 1-11 SIG_ask_signal_transmitters ITK function . . . . . . . . . . . . . . . . . . . . . . 1-11 SIG_asystem_source_rules preference . . . 1-7 SIG_asystem_target_rules preference . . . 1-8 SIG_asystem_transmitter_rules preference . . . . . . . . . . . . . . . . . . . . . . 1-8 SIG_pvariable_rules preference . . . . . . . 1-9 SIG_redundant_rules preference . . . . . . 1-9 Signals Associating . . . . . . . . . . . . . . . . . . . . 2-4 Creating . . . . . . . . . . . . . . . . . . . . . . 2-3

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

. . . . . . . . .

1-3 1-3 1-3 1-3 1-4 1-3 1-3 1-3 1-4

Value conventions . . . . . . . . . . . . . . . . . . 6 Variant, registering ECU . . . . . . . . . . . 2-13 W WEB_ui_suppressed_actions preference . . . . . . . . . . . . . . . . . . . . . . 1-9

ENG00049 A

Embedded Software Manager Guide

Index-3