SAP ECTR interface to PTC Creo

User Guide
2018 - 01
SAP ECTR interface to PTC Creo

Contact: www.riess.de
Version: 2018 - 01
Validity: SAP Engineering Control Center interface to PTC Creo ≥ 1.1.15.xxx
Author(s): Andreas Stein - .riess engineering europe gmbh

© Copyright 2017 .riess engineering gmbh / .riess engineering europe gmbh

This document may not be copied, reproduced, transmitted or duplicated or published in parts or as a
whole in printed or electronic or any other form without written consent of .riess engineering gmbh / .riess
engineering europe gmbh.
The information contained in this document is for general information purposes only. The present
documentation and software may be changed without prior notice. It implies no warranty or obligation on
the part of .riess engineering gmbh / .riess engineering europe gmbh.
.riess engineering gmbh / .riess engineering europe gmbh shall not assume responsibility or liability for
possible errors or inaccuracies that may occur in this manual.
PTC®, Creo®; Pro/ENGINEER®, Wildfire®, Windchill®, Pro/INTRALINK®, Pro/TOOLKIT® are trademarks
or registered trademarks of PTC Inc. or its subsidiaries in the USA and in other countries.
ABAP™, BAPI®, SAP®, SAP® PLM are trademarks or registered trademarks of SAP AG in Germany and
in many other countries.
Excel®, Internet Explorer®, Microsoft®, PowerPoint®, Windows®, Word®, MS-DOS® are trademarks or
registered trademarks of Microsoft Corporation in the USA and in other countries.

Symbols
The symbols in the margin have the following meaning:
Symbol Meaning Symbol Meaning Symbol Meaning
Note Best practice Error
Warning / prerequisite Example Cause / question
Tip Parameters Solution / answer
SAP note Not Validity
recommended
Instructions

Formatting
In this text, the following formatting is used:
Format Meaning
bold Commands and buttons in procedures are formatted in bold.
Important information in the text is highlighted in bold.
italics References to other parts of the text and hyperlinks are formatted in italics.
Courier Filenames, folders, and paths are formatted in Courier font.
Courier Options, parameters, and their values are formatted in Courier.
* An asterisk is used to mark the default value of an option or parameter.
[ ] Square brackets mean that no option or parameter value has been set.
<user <user input> is formatted in Courier and enclosed in angle brackets.
input>

Default values
Options and parameters for which no explicit values are specified use the default value.
SAP ECTR interface to PTC Creo - Table of contents

Table of contents
1 Objective and Intended Audience of This Manual ................................................................................6
1.1 .riess engineering .........................................................................................................................6
1.2 Objective ......................................................................................................................................6
1.3 Intended Audience .......................................................................................................................7
1.3.1 Administrators ..........................................................................................................................7
1.3.2 Users .......................................................................................................................................7
2 Introduction ...........................................................................................................................................8
2.1 The SAP ECTR interface to PTC Creo TOOLKIT Tool ...............................................................8
2.2 Data Model ...................................................................................................................................9
2.2.1 Documents and Object Types .................................................................................................9
2.2.2 Document structures and sort strings ....................................................................................10
2.3 Icons for PTC Creo Parametric Originals ..................................................................................11
2.3.1 Object type icons for PTC Creo Parametric ..........................................................................12
2.3.2 Object type overlays for PTC Creo Parametric .....................................................................12
2.4 Starting SAP ECTR interface to PTC Creo ................................................................................13
3 System Requirements and Installation ...............................................................................................14
3.1 Notes in the SAP Support Portal................................................................................................14
3.2 System Requirements ................................................................................................................15
3.3 Downloading the software ..........................................................................................................15
3.4 Installation ..................................................................................................................................16
3.4.1 SAP Front End Installer .........................................................................................................16
3.4.2 Installation Directory ..............................................................................................................16
3.4.2.1 "documentation" folder ..................................................................................................16
3.4.2.2 "appdata" folder.............................................................................................................17
3.4.2.3 "basis" folder .................................................................................................................17
3.4.2.4 "template-customize" folder ..........................................................................................17
3.4.2.5 "customize" folder .........................................................................................................17
3.4.2.6 "template-templates" Folder..........................................................................................17
3.4.2.7 "templates" folder ..........................................................................................................18
3.5 Installing Updates.......................................................................................................................18
3.6 Licensing ....................................................................................................................................19
4 Configuration ......................................................................................................................................20
4.1 Using the Pre-configured Configuration Files ............................................................................21
4.1.1 Defining workstation applications ..........................................................................................21
4.1.2 Defining document types .......................................................................................................21
4.2 Configuring the SAP System .....................................................................................................22
4.2.1 Workstation application for CAD originals .............................................................................22
4.2.2 Document types for CAD originals ........................................................................................23
4.3 Configuring SAP ECTR ..............................................................................................................24
4.4 Configuring PTC Creo Parametric .............................................................................................25

I
SAP ECTR interface to PTC Creo - Table of contents

4.5 Starting SAP ECTR interface to PTC Creo ................................................................................25

4.6 Configuring SAP ECTR interface to PTC Creo ..........................................................................26
4.6.1 Settings file SAPECTRInterface.prefs ...................................................................................26
4.6.2 Opening configuration dialog .................................................................................................26
4.6.3 Configuring settings on the System page ..............................................................................28
4.6.3.1 PTC Creo Parametric startup file ..................................................................................28
4.6.3.2 Execute in .....................................................................................................................29
4.6.3.3 Defining and enabling the PTC Creo Parametric start environment.............................29
4.6.3.4 Trace Level ...................................................................................................................30
4.6.4 Configuring settings on the Menu page .................................................................................30
4.6.4.1 SAP PLM menu and context menu ...............................................................................31
4.6.5 Configuring settings on the Save page .................................................................................32
4.6.5.1 Creating and saving additional originals .......................................................................32
4.6.5.2 Refreshing the attributes of originals before saving .....................................................33
4.6.5.3 Including formats in the document structure .................................................................33
4.6.5.4 Delete old versions from the working directory when saving to SAP ...........................34
4.6.5.5 Include User-Defined Features in Document Structure ................................................34
4.6.6 Configuring settings on the Parameter page .........................................................................35
4.6.6.1 Initializing parameters ...................................................................................................35
4.6.7 Configuring settings on the Ballooning page .........................................................................36
4.6.7.1 Refresh Component Parameters ..................................................................................36
4.6.8 Configuring settings on the Import page ...............................................................................37
4.6.8.1 Import On Demand dialog .............................................................................................37
4.6.9 Configuring settings on the Directories page ........................................................................37
4.6.9.1 Change working directory .............................................................................................37
4.6.10 Configuring settings on the Advanced page .....................................................................38
4.6.10.1 Show CAD Structure .....................................................................................................38
4.6.10.2 Disabling default limitations ..........................................................................................38
4.6.11 Configuring settings on the ModelCHECK page ...............................................................39
5 Advanced Configuration .....................................................................................................................41
5.1 Using different CAD environments.............................................................................................42
5.1.1 CAD environments - typical use cases ..................................................................................42
5.1.2 CAD environments—configuration ........................................................................................43
5.1.2.1 Configuration of SAP ECTR..........................................................................................44
5.1.2.2 Configuration of SAP ECTR interface to PTC Creo......................................................44
5.1.2.3 CAD startup directories .................................................................................................45
5.1.2.4 Batch files......................................................................................................................45
5.1.2.5 DType and seedfile .......................................................................................................46
5.2 Integrating SAP ECTR interface to PTC Creo into CAD environments launched by an external
application ...............................................................................................................................................48
5.3 Refreshing attributes and SAP fields .........................................................................................50
5.3.1 Refreshing attributes by using values from SAP fields..........................................................51
5.3.2 Refreshing values in SAP fields by using attributes ..............................................................52

II
SAP ECTR interface to PTC Creo - Table of contents

5.4 Managing formats in SAP ..........................................................................................................53

5.5 Using smart containers for drawings .........................................................................................55
5.6 Displaying dependent drawings in the Where Referenced container ........................................57
5.7 Defining a Dtype for family tables ..............................................................................................58
5.7.1 DType for generic files ...........................................................................................................58
5.7.2 Relation between the DType for generic file and the DType for instances ...........................59
5.8 Setting the Initial Expansion Level of the Application Structure ................................................60
5.9 Using Ballooning Functions .......................................................................................................61
5.10 Managing User-Defined Features in SAP ..................................................................................63
5.10.1 UDF in PTC Creo Parametric ............................................................................................63
5.10.2 Using UDFs in SAP PLM...................................................................................................64
5.10.3 DType for UDFs and UDF reference models ....................................................................64
5.10.4 Adding UDFs to the document structure ...........................................................................65
5.10.5 Making UDFs available in the working directory ...............................................................65
5.11 Loading CAD structures—without referenced objects ...............................................................68
6 Using the Menu and Commands ........................................................................................................73
6.1 Displaying the SAP PLM Menu ..................................................................................................74
6.1.1 SAP PLM Menu as a TOOLKIT Tool .....................................................................................74
6.1.2 SAP PLM menu in the model tree context menu ..................................................................75
6.1.3 SAP PLM menu in the application structure ..........................................................................75
6.1.4 SAP PLM menu on the quick access toolbar ........................................................................76
6.1.5 User-defined tab with the SAP PLM menu ............................................................................76
6.1.6 SAP PLM menu in the Common tab......................................................................................76
6.2 Scope of Commands Selected from the SAP PLM Menu .........................................................77
6.2.1 Scope of commands: current or active original .....................................................................77
6.2.2 Scope of commands: model tree context menu ....................................................................77
6.2.3 Scope of commands: application structure context menu .....................................................77
6.2.4 Scope of commands: user-defined tab ..................................................................................77
6.2.5 Files without document or material ........................................................................................78
6.2.6 Including originals in the document structure of the scope ...................................................78
6.2.7 Removing originals in memory from the scope .....................................................................78
6.2.8 Alternative effects on the scope ............................................................................................78
6.3 SAP PLM Menu Commands ......................................................................................................79
6.3.1 ECTR menu commands ........................................................................................................79
6.3.1.1 Open ECTR .............................................................................................................79
6.3.1.2 Show CAD Structure ...............................................................................................79
6.3.2 Original menu commands ......................................................................................................80
6.3.2.1 New ..........................................................................................................................81
6.3.2.2 Open ........................................................................................................................81
6.3.2.3 Save .........................................................................................................................82
6.3.2.4 Edit ...........................................................................................................................83
6.3.2.5 Save and Display .....................................................................................................83

III
SAP ECTR interface to PTC Creo - Table of contents

6.3.2.6 Save as New Version ..............................................................................................84

6.3.2.7 Save as New Document ..........................................................................................84
6.3.2.8 Refresh Originals .....................................................................................................85
6.3.2.9 Refresh Attributes ....................................................................................................85
6.3.2.10 Cancel ......................................................................................................................86
6.3.2.11 Import.......................................................................................................................87
6.3.2.12 Add Component .......................................................................................................88
6.3.2.13 Add Format ..............................................................................................................88
6.3.2.14 Replace Version ......................................................................................................89
6.3.3 Document menu commands ..................................................................................................90
6.3.3.1 Display Document....................................................................................................90
6.3.3.2 Add to Object List ....................................................................................................90
6.3.3.3 Open Original of Dependent Document ..................................................................91
6.3.3.4 Create Dependent Document ..................................................................................91
6.3.4 Commands in the Additional Functions menu .......................................................................92
6.3.4.1 Create Bill of Material ..............................................................................................93
6.3.4.2 Display Bill of Material .............................................................................................93
6.3.4.3 Edit Bill of Material ...................................................................................................94
6.3.4.4 Assign Material ........................................................................................................94
6.3.4.5 Display Material .......................................................................................................95
6.3.4.6 Settings ....................................................................................................................95
6.3.4.7 Trace Level ..............................................................................................................96
6.3.4.8 Cancel Edit ..............................................................................................................96
6.3.4.9 Import UDF ..............................................................................................................97
6.3.4.10 Initialize Parameters ................................................................................................98
6.3.4.11 Open Log Directory .................................................................................................98
6.3.4.12 Open Working Directory ..........................................................................................99
6.3.4.13 Delete old versions ..................................................................................................99
6.3.4.14 About .......................................................................................................................99
6.3.4.15 Add Table ..............................................................................................................100
6.3.4.16 Refresh Component Parameter.............................................................................102
6.4 SAP PLM Context Menu Commands in the Model Tree .........................................................103
6.5 Commands in the Application Structure Context Menu ...........................................................103
6.5.1 Application structure commands .........................................................................................103
6.5.2 Additional application structure commands .........................................................................103
6.5.2.1 Display ...................................................................................................................104
6.5.2.2 Select .....................................................................................................................104
7 Tabs and Groups in PTC Creo Parametric.......................................................................................105
7.1 Customizing the Ribbon ...........................................................................................................105

IV
SAP ECTR interface to PTC Creo - Table of contents

7.2 Saving Customizations in the toolkitribbon.rbn and ribbonui.txt Files .....................................108

7.3 Saving Customizations in the creo_parametric_customization.ui File.....................................110

V
SAP ECTR interface to PTC Creo - Objective and Intended Audience of This Manual

This section informs you about the objective and the intended
audience of this manual.

1 Objective and Intended Audience of This Manual

1.1 .riess engineering

The SAP Engineering Control Center interface to PTC Creo (short: SAP ECTR interface to PTC Creo) is
developed by .riess engineering. For information on .riess engineering and SAP ECTR interface to PTC
Creo, please refer to our website.

.riess engineering reducing complexity

Visit us at: http://www.riess.de

1.2 Objective

This manual has been designed to provide you with all information required to work with SAP ECTR
interface to PTC Creo and to configure SAP ECTR interface to PTC Creo.

Documentation on SAP Engineering Control Center

For information on how to use and administer SAP Engineering Control Center (short: SAP ECTR) please
refer to the SAP ECTR documentation.
Select Help  Display Documentation to display the documentation directly from within SAP ECTR.

SAP Community Network

Join the SAP Community Network! It provides valuable information and discussion forums on SAP ECTR.
https://wiki.scn.sap.com/wiki/display/WHP/Home

6
SAP ECTR interface to PTC Creo - Objective and Intended Audience of This Manual

1.3 Intended Audience

This manual is intended for administrators and users of SAP ECTR interface to PTC Creo.

1.3.1 Administrators

This manual is intended for all persons responsible for the installation, administration, and maintenance of
SAP ECTR interface to PTC Creo.
The responsible persons should have the following CAD and SAP knowledge:
• Administration of the PTC Creo Parametric CAD system
 Installing PTC Creo Parametric
 Configuring PTC Creo Parametric (e.g. using the config.pro, parametric.bat files)
• Administration of SAP ECTR
 Installing SAP ECTR
 Configuring SAP ECTR (e.g. using the dtype.xml, default.txt files)
 Understanding the concept and application of SAP ECTR
• Administration of SAP systems including:
 Importing SAP notes / transports
 Using SAP Download Center
 Knowledge of the SAP Document Management System (e.g. documents, workstation
applications)
 Customizations (e.g. transactions such as SPRO, CSADMIN, CDESK_CUS (ECC) or
CAD_SRV_CUS (S4/Hana))
 Creating and transferring customization transports
 Creating, enabling, and disabling a BAdI implementation
 Importing Business Configuration Sets

1.3.2 Users

Chapter 6, “Using the Menu and Commands”, is intended for the users of SAP ECTR interface to PTC
Creo.
The users should have the following CAD and SAP knowledge:
• Using PTC Creo Parametric
 Knowledge and understanding of the dependencies and references between CAD objects
• SAP PLM concepts and applications
 Understanding and using SAP Engineering Control Center
 Understanding and using the SAP Document Management System
 Creating and editing documents
 Creating and editing material master records
 Creating and editing bills of material
 Creating and editing change master records

7
SAP ECTR interface to PTC Creo - Introduction

The Introduction contains general information and basics related to

SAP ECTR interface to PTC Creo.

2 Introduction

SAP ECTR interface to PTC Creo integrates PTC Creo Parametric with SAP Engineering Control Center.
You can launch SAP ECTR interface to PTC Creo, together with PTC Creo Parametric, from within SAP
ECTR.

More information
For more information on SAP ECTR interface to PTC Creo, please refer to our website. Visit us at:
http://www.riess.de

2.1 The SAP ECTR interface to PTC Creo TOOLKIT Tool

SAP ECTR interface to PTC Creo is registered and embedded into PTC Creo Parametric as a TOOLKIT
tool (auxiliary application). The SAP PLM menu of SAP ECTR interface to PTC Creo can be displayed in
the PTC Creo Parametric ribbon.

Figure: SAP ECTR interface to PTC Creo in the PTC Creo Parametric ribbon

SAP ECTR interface to PTC Creo allows you to access the SAP ECTR features directly from within the
CAD session.
SAP ECTR interface to PTC Creo includes the following features:
• Launch SAP ECTR
• Create originals including document info record
• Save originals to SAP and load from SAP
• Import files to SAP
• Refresh CAD parameters (attributes) using SAP field data and vice versa
• View and edit documents
• Assign and display materials
• Create, display, and edit bills of material

8
SAP ECTR interface to PTC Creo - Introduction

2.2 Data Model

The data model for mapping CAD data from PTC Creo Parametric to SAP PLM uses the following
objects, among others:
• Documents and object types
• Document structures and sort strings

2.2.1 Documents and Object Types

For each file created in PTC Creo Parametric and managed by SAP PLM, a document info record is
required. The CAD file will be linked to the document info record. CAD files having a document info record
are called originals or CAD originals. Documents consist of the document info record and the original file.
In PTC Creo Parametric, you can create different types of CAD originals. Depending on the CAD type,
the Reserve Field 4 of the document info record contains a corresponding entry. This entry indicates the
object type.

Object type
Each object type consists of two parts:
• Application type
• Application role
You can specify both the application type and the application role in the corresponding DType definition.
In the object type, the application type and the application role are separated by a colon.

Application type
The application type depends on the CAD system. For PTC Creo Parametric, the application type is PRO.

Application role
The application role is formed depending on the type of CAD original and on its function. Based on the
type and function, an application role may contain multiple identifiers.
CAD type Extension Application role
Sketch *.sec S
Part *.prt P
Assembly *.asm A
Manufacturing *.asm (*.mfg) M
Drawing *.drw D
Format *.frm F
Report *.rpt R
Diagram *.dgm T
Notebook *.lay L
User-Defined Feature *.gph H

Table: Object types for PTC Creo Parametric original types

Function Application role

Family table—generic file G
Family table—instance I
Skeleton S
Standard part N
Library part B

9
SAP ECTR interface to PTC Creo - Introduction

Table: Additional object type specifications for the PTC Creo Parametric function

Additional object type specifications

The following table shows a selection of available object types for parts:
Type Function Object type
Part Design part PRO:P
Part Skeleton in assembly PRO:PS
Part Family table—generic file PRO:PG
Part Family table—instance PRO:PI
Part Family table—generic file - standard part PRO:PGN
Part Design part—standard part PRO:PN

Table: Selection of available object types

2.2.2 Document structures and sort strings

The relationships within CAD structures, e.g. between assemblies and their components, are mapped
using document structures (document BOMs).
The relationships between the documents in the document structure and the document of the BOM
header are mapped in the SORTF field for each BOM item. The entry in the SORTF field is referred to as
the sort string.

Sort string
The sort string consists of two parts:
• Application type
• Reference type
In the sort string, the application type and the reference type are separated by a colon.

Application type
The application type depends on the CAD system. For PTC Creo Parametric, the application type is PRO.

10
SAP ECTR interface to PTC Creo - Introduction

Standard reference types

The reference type is formed depending on the kind of reference. By default, SAP ECTR interface to PTC
Creo knows the following sort strings:
Reference type Subtype Sort string
Assembly Component PRO:C
Suppressed components PRO:CS
Envelope component PRO:CV
Exchange assemblies Model interchange assembly PRO:CA
Reference General reference PRO:CY
Family tables Instance generic file PRO:G
Instance of a generic file PRO:G
Drawings Represented Modell PRO:DM
Additional represented model PRO:D
Used format PRO:
Notebook Controlling model layout PRO:L

Table: Standard reference types

2.3 Icons for PTC Creo Parametric Originals

Certain information on documents is displayed in SAP ECTR using icons. Besides general icons that
apply to all documents, there are special icons for the PTC Creo Parametric object types. Depending on
the document status, the background of object type icons may have a specific color.
More information on the PTC Creo Parametric object is shown as overlays placed on top of the object
type icon.

Example
The following figure shows the PTC Creo Parametric object type icon (first icon from the left). The icons at
the other positions are general icons.

Figure: Document icons

Configuring Icons
In the dtype.xml file, you can specify the icons to be displayed and their order for each DType. The
status-dependent background color for the object type icons is defined in the default.txt file.

More information
For further details on the icons and overlays in SAP ECTR, please refer to the SAP ECTR
documentation.

11
SAP ECTR interface to PTC Creo - Introduction

2.3.1 Object type icons for PTC Creo Parametric

The application_role attribute in the DType definition determines the object type icon to be used.

Icons for object types

The following icons are available for the PTC Creo Parametric object types:
Icon Meaning
Sketch

Part

Assembly

Manufacturing

Drawing

Format

Report

Diagram

Notebook

User-Defined Feature

Table: PTC Creo Parametric object icons in SAP ECTR

2.3.2 Object type overlays for PTC Creo Parametric

Object type overlays—supplemental object type information

The following overlays provide supplemental information on the object type:
Overlay Meaning
Family table—generic file

Family table—instance

Table: PTC Creo Parametric Object type overlays—supplemental object type information

Object type overlays—flags

These are overlays that display additional information:
Overlay Meaning
Object has dirty flag

Object is obsolete

Table: PTC Creo Parametric Object type overlays—flags

12
SAP ECTR interface to PTC Creo - Introduction

2.4 Starting SAP ECTR interface to PTC Creo

PTC Creo Parametric must be launched from SAP ECTR. The CAD session will then be connected to
SAP ECTR.
Each time you start PTC Creo Parametric, SAP ECTR interface to PTC Creo is registered as a TOOLKIT
tool and embedded into the application.

Launching PTC Creo Parametric from SAP ECTR

Do the following to launch PTC Creo Parametric from SAP ECTR:
1) Launch SAP ECTR.
2) Select System  Launch Application  Launch PTC Creo.
Result: This launches PTC Creo Parametric and embeds SAP ECTR interface to PTC Creo as a
TOOLKIT tool. The Creo session is connected to SAP ECTR.

User interface language of SAP ECTR interface to PTC Creo

The user interface language of SAP ECTR interface to PTC Creo is determined (automatically) as
follows:
• PTC Creo Parametric will start with the user interface language specified by the language variable,
e.g. set LANG=english, in the PTC Creo Parametric startup file, e.g.
%PTC_CREO_PARAMETRIC_INSTDIR%\Parametric\bin\Parametric.bat.
• If no language variable has been set or if it is invalid, PTC Creo Parametric will start with the
current operating system language.
• SAP ECTR interface to PTC Creo will be integrated with the same language as used by PTC Creo
Parametric.
• If this user interface language is not supported by SAP ECTR interface to PTC Creo yet, SAP
ECTR interface to PTC Creo will be started in English.

13
SAP ECTR interface to PTC Creo - System Requirements and Installation

This chapter contains information on the system requirements for

SAP ECTR interface to PTC Creo. In addition, it describes how to
install and configure SAP ECTR interface to PTC Creo.

3 System Requirements and Installation

SAP ECTR interface to PTC Creo can only be installed successfully if the system requirements are met.
The installer must be downloaded from the SAP Software Download Center. Then, you can use the SAP
Front-End Installer to install SAP ECTR interface to PTC Creo.
Update installations must also be performed with the SAP Front-End Installer.

3.1 Notes in the SAP Support Portal

The following important notes are available in the SAP Support Portal:

Installation and patches

2112629 SAP ECTR interface to PTC Creo: Installation and patches

Licensing for SAP ECTR interface to PTC Creo

2107448 Licensing for SAP ECTR interface to PTC Creo

Support process
2107391 Support process for .riess engineering gmbh for SAP ECTR interface to PTC Creo

Release strategy for SAP ECTR

2049249 ECTR: Release strategy for ABAP Add-on ECTR

Improvement requests
2307014: Improvement request for SAP ECTR

Product availability matrix

For information on the currently available software, please refer to the ECTR INTERFACE TO CREO 1.x
and SAP ECTR 5.x entries in the Product Availability Matrix.
https://support.sap.com/release-upgrade-maintenance/pam.html

14
SAP ECTR interface to PTC Creo - System Requirements and Installation

3.2 System Requirements

The following requirements for the systems / components listed must be met in order to use SAP ECTR
interface to PTC Creo:
System Prerequisite
SAP ECTR SAP ECTR 5.1 or higher
PTC Creo Parametric 1.0 or higher
Hardware See PTC Hardware Notes
Platform Windows 7 and higher (64-bit Edition)

Table: System requirements for SAP ECTR interface to PTC Creo

SAP ECTR
In order to use SAP ECTR, further system requirements must be met, in particular with respect to the
SAP system. For further details, please refer to the SAP ECTR documentation.

3.3 Downloading the software

SAP ECTR interface to PTC Creo can be downloaded from the SAP Software Download Center.

Prerequisite
The software is only available as a download for customers with a valid contract or trial contract. Without
any contract, you will not have access to the software in the SAP Software Download Center.

Permissions for the SAP Software Download Center

To download the software, you must be logged in as an S user who has the permission for software
download.

Procedure
Do the following to download SAP ECTR interface to PTC Creo from the SAP Software Download Center:
1) Log in to the SAP Software Download Center:
https://support.sap.com/swdc
or
https://launchpad.support.sap.com/#/softwarecenter
2) Under By Alphabetical Index (A-Z), go to E and search for ECTR INTERFACE TO CREO.
3) In the results list, select the most recent software version.
4) Click Support Packages and Patches.
5) Click Comprised Software Component Versions.
6) Download the most recent patch from the SAP Software Download Center.
Result: The SAP ECTR interface to PTC Creo installer is available on your workstation.

15
SAP ECTR interface to PTC Creo - System Requirements and Installation

3.4 Installation

For the installation of SAP ECTR interface to PTC Creo, the SAP Front End Installer must be
used. During the installation, the installer creates the installation directory and various subdirectories.

3.4.1 SAP Front End Installer

Prerequisite
Before you can install SAP ECTR interface to PTC Creo, SAP ECTR must already have been installed.

Procedure
Do the following to install SAP ECTR interface to PTC Creo.
1) Unpack the download object you downloaded from the SAP Software Download Center on
your workstation.
2) Run the program named EctrCreo<xx>P<y>.exe.
3) Follow the instructions of the SAP Front End Installer.
4) Exit the SAP Front End Installer.
Result: SAP ECTR interface to PTC Creo is now installed in the folder named
%PLM_INSTDIR%\applications\pro under the SAP ECTR installation directory.

Registration
When SAP ECTR interface to PTC Creo is launched for the first time from SAP ECTR, it will be registered
automatically as a TOOLKIT tool.

3.4.2 Installation Directory

The SAP ECTR interface to PTC Creo installation directory %PLM_INSTDIR%\applications\pro

contains the following folders:
• documentation
• appdata
• basis
• template-customize
• customize
• template-templates
• templates

3.4.2.1 "documentation" folder

The documentation folder contains the current SAP ECTR interface to PTC Creo documentation.

16
SAP ECTR interface to PTC Creo - System Requirements and Installation

3.4.2.2 "appdata" folder

The appdata folder contains the various components of the SAP ECTR interface to PTC Creo
application (Software, Preferences, and Properties):

Purpose of the user-specific config.pro file

During the installation of SAP ECTR interface to PTC Creo, a file named config.pro is copied to the
SAP ECTR interface to PTC Creo installation directory. This file contains the settings required for SAP
ECTR interface to PTC Creo. Add your user-specific settings to this file.
If you do not save your config.pro file to the installation directory of the SAP ECTR interface to PTC
Creo, make sure that your user-defined config.pro file contains the required options and will be read
when PTC Creo Parametric is launched.
In this case, delete the config.pro file from the installation directory of SAP ECTR interface to PTC
Creo.

3.4.2.3 "basis" folder

The basis folder contains SAP ECTR files that are required for SAP ECTR interface to PTC Creo.

3.4.2.4 "template-customize" folder

The template-customize folder contains the SAP ECTR configuration file templates that are required
for using SAP ECTR interface to PTC Creo, such as the dtype.xml file.

Initial Installation
When you install SAP ECTR interface to PTC Creo for the first time on your workstation, the entire
content of the template-customize folder is copied to the customize folder.

3.4.2.5 "customize" folder

The customize folder contains the SAP ECTR configuration files that are required for using SAP ECTR
interface to PTC Creo, such as the dtype.xml file.

Editing Files in the customize Folder%PLM_INSTDIR%\applications\pro

Edit the files in the customize folder in order to perform a user-specific and CAD system-specific
configuration of SAP ECTR and SAP ECTR interface to PTC Creo. For further details, please refer to the
SAP ECTR documentation.

Update
Please note that, if the customize folder already contains files, they will not be overwritten when you
update SAP ECTR interface to PTC Creo using the SAP Front End Installer.

3.4.2.6 "template-templates" Folder

The template-templates folder contains the PTC Creo Parametric template files (startup files) that
can be used as templates when creating new originals.

Initial Installation
If you install SAP ECTR interface to PTC Creo for the first time on your workstation, the entire content of
the template-templates folder is copied to the templates folder.

17
SAP ECTR interface to PTC Creo - System Requirements and Installation

3.4.2.7 "templates" folder

The templates folder contains the PTC Creo Parametric template files (startup files) that can be used
as templates when creating new originals (seed files).

Using company-specific start files

Copy your own company-specific start files to the templates directory. Enter the paths to your start files
into your company-specific config.pro configuration file. Enter the filenames of your start files into the
dtype.xml file.

Update
Please note that, if the templates folder already contains files, they will not be overwritten when you
update SAP ECTR interface to PTC Creo using the SAP Front End Installer.

3.5 Installing Updates

For the update installations of SAP ECTR interface to PTC Creo, the SAP Front End Installer
must be used. During the installation, the content of the installation directory and most subdirectories will
be overwritten.

"templates" and "customize" folders

Please note that the content of the templates and customize folders will not be overwritten when you
update SAP ECTR interface to PTC Creo!
The PTC Creo Parametric template files (startup files) in the templates folder that are used as
templates (seed files) when you create new originals will be kept.
The configuration files in the customize folder will also be kept.

Editing configuration files

If an update of SAP ECTR interface to PTC Creo contains new configuration options, you can edit the
configuration files in the customize folder to add the new options.

Saving the configuration dialog

When you open the SAP ECTR interface to PTC Creo configuration dialog after a successful update
installation, the Save button might be active immediately. The Save button is always active if changes
have been made to the configuration. In this case, the update added new configuration features that have
not been saved yet. The the new configuration options have been preset with default values.

18
SAP ECTR interface to PTC Creo - System Requirements and Installation

3.6 Licensing

For SAP ECTR interface to PTC Creo, a valid license check file stored in the
%PLM_INSTDIR%\applications\pro\customize\license directory is required.

License check file for production systems

In order to use SAP ECTR interface to PTC Creo in your production system, you need a license check
file. If more users than indicated in the license check file work with SAP ECTR interface to PTC Creo, a
corresponding message is displayed. This license check file allows you to use SAP ECTR interface to
PTC Creo also in non-production systems (development, test, QA, etc.).

Temporary license check file for non-production systems

In order to use SAP ECTR interface to PTC Creo in your non-production systems, you need a temporary
license check file.

SAP note
2107448: Licensing for SAP ECTR interface to PTC Creo

19
SAP ECTR interface to PTC Creo - Configuration

This chapter explains how to configure SAP Engineering Control

Center interface to PTC Creo.

4 Configuration

In order to integrate PTC Creo Parametric with SAP ECTR interface to PTC Creo, you need to configure
the following systems:
• SAP
• SAP ECTR
• PTC Creo Parametric
• SAP ECTR interface to PTC Creo
As an alternative, you can use the pre-configured configuration files that have been copied to the
%PLM_INSTDIR%\applications\pro\template-customize\config folder during the installation
of SAP ECTR interface to PTC Creo.

Prerequisite
Before starting to configure SAP ECTR interface to PTC Creo, make sure that SAP ECTR has been
configured properly, as described in the SAP ECTR documentation.

Business Configuration Sets

Part of the configuration required in the SAP system can be imported via a BC set. The BC set named
/DSCAG/ECTR_PRO that is suitable for SAP ECTR interface to PTC Creo is part of the SAP ECTR
Backend Installation.

20
SAP ECTR interface to PTC Creo - Configuration

4.1 Using the Pre-configured Configuration Files

During the initial installation of SAP ECTR interface to PTC Creo, the pre-configured configuration files
from the %PLM_INSTDIR%\applications\pro\template-customize\config directory are copied
to the %PLM_INSTDIR%\applications\pro\customize\config directory.
The various configuration files are adapted to each other. The SAP objects specified in the configuration
files, such as workstation applications, match the specifications in the SAP ECTR documentation.
The following objects need to be created in the SAP system if they have not been imported via the BC
set:
• Workstation applications
• Document types

Using configuration templates

The pre-configured configuration files help you set up a working environment for SAP ECTR interface to
PTC Creo quickly. You can then successively customize this environment to suit your specific
requirements.

4.1.1 Defining workstation applications

In addition to the workstation applications mentioned in the SAP ECTR documentation, define the PRO
workstation application (see 4.2.1 Workstation application for CAD originals).

4.1.2 Defining document types

Define the following document types for PTC Creo Parametric originals (see: 4.2.2 Document types for
CAD originals).
Document type File type
PPR *.prt
PAS *asm
PDR *.drw
PSK *.sec
PLY *.lay
PCE *.cem
PRE *.rpt
PDG *.dgm
PFR *.frm
PUF *.gph

Table: Document Types for PTC Creo Parametric Originals

Using other document types

If you need other document types, you can create them. Specify these document types by editing the
dtype.xml file, using the document_type attribute for the appropriate DType.

21
SAP ECTR interface to PTC Creo - Configuration

4.2 Configuring the SAP System

SAP ECTR interface to PTC Creo and SAP ECTR check CAD files into the SAP Document Management
System. For this purpose, workstation applications and document types including a status network and a
classification are required.
The required document types and status networks depend on the customer-specific design process
mapping concept.
Document types and workstation applications are required when you define a DType.

Detailed information
For further details on how to configure the SAP system, please refer to the SAP ECTR documentation in
the %PLM_INSTDIR%\documentation\Manuals directory.

4.2.1 Workstation application for CAD originals

Creating the PRO workstation application

Do the following to create the PRO workstation application for CAD originals in the Document
Management System:
1) Use the DC30 transaction to open the Define workstation application view.
2) Click New Entries.
3) Define the settings for the PRO workstation application:
Workstation Application
WS application PRO
Description Creo Parametric
File format *.*
 Start Authorization
 You cannot rename temporary files

Table: Settings for the PRO workstation application

4) Save your settings.
Result: The PRO workstation application has been created and can be used in the DType definition.

You cannot rename temporary files

Make sure to enable the You cannot rename temporary files checkbox.

Workstation application for additional originals

If you create additional originals when saving CAD originals in SAP, e.g. for thumbnails, the
corresponding workstation applications must exist in the SAP system.

22
SAP ECTR interface to PTC Creo - Configuration

4.2.2 Document types for CAD originals

Defining document types

Do the following to create document types for PTC Creo Parametric originals:
1) Use the DC10 transaction to open the Define document types view.
2) Click New Entries.
3) Define a document type for CAD originals by editing the input fields.
4) Save your settings.
5) Click the icon.
6) In the dialog structure, click the new document type.
7) In the dialog structure, double-click Define document status.
8) Define the status network for the new document type.
9) Save your settings.
Result: The document type has been defined and can now be used for CAD originals and for the DType
definition.

Document type attributes

Make sure to define the attributes of the document type as follows:
Define Document Types
 Use KPro
 Status Switch
 Version assign.
Def. Def. WS appl. PRO
Dis. WS applic. PRO

Table: Defining document types

The other attributes can be defined in line with the customer-specific requirements.

Defining other document types

First, define a document type including its status network. Then, copy the document type.

Document types and statuses

Use numerical names for your document types and statuses. The document type and status descriptions
can be maintained in multiple languages and edited at any time.

23
SAP ECTR interface to PTC Creo - Configuration

4.3 Configuring SAP ECTR

Before you can use SAP ECTR interface to PTC Creo, you need to configure SAP ECTR as well.
Settings made in the following configuration files in the
%PLM_INSTDIR%\applications\pro\customize\config folder will influence the behavior of SAP
ECTR interface to PTC Creo:
• dtype.xml
• default.txt
• menu_macros.txt
• attributes-from-sap.xml
• attributes-to-sap.xml
• SAPECTRInterface.prefs

Detailed information
For further details on how to configure SAP ECTR, please refer to the SAP ECTR documentation.

DType definitions for PTC Creo Parametric files

Create a separate DType for each file type. Use a separate seed file for each subtype. Please note
that additional DType definitions will be required for family tables (generic files and instances).

PTC Creo Parametric types

In PTC Creo Parametric, the following different types are available:
• Sketch
• Part
• Assembly
• Manufacturing
• Drawing
• Format
• Notebook

Examples
You can find sample configuration files in the following directory:
%PLM_INSTDIR%\applications\pro\template-customize\config.
You can find sample DType definitions in the following file:
%PLM_INSTDIR%\applications\pro\template-customize\config\dtype.xml.

Distributing the settings from a central location

It is possible to distribute the settings via the SAP system to the individual workstations. Further
information on this topic is available in the SAP Community Network at:
https://wiki.scn.sap.com/wiki/display/PLM/How+to+configure+the+distribution+of+SAP+ECTR+configurati
ons+via+SAP+system

24
SAP ECTR interface to PTC Creo - Configuration

4.4 Configuring PTC Creo Parametric

For SAP ECTR interface to PTC Creo, you need to set the following options and values in the
config.pro file:
Option Value
save_objects changed_and_specified
override_store_back no
save_object_in_current no
file_open_default_folder working_directory
save_instance_accelerator none
retrieve_instance_dependencies instance_and_generic_deps
tk_enable_ribbon_custom_save yes
visible_message_lines 4
allow_create_pdm_param yes

Table: Required options and values in the config.pro file

4.5 Starting SAP ECTR interface to PTC Creo

You can launch SAP ECTR interface to PTC Creo, together with PTC Creo Parametric, from SAP ECTR.
When you start SAP ECTR interface to PTC Creo for the first time, the configuration dialog appears.

Procedure
Do the following to start PTC Creo Parametric for the first time from SAP ECTR:
1) Launch SAP ECTR.
2) Select System  Launch Application  Launch PTC Creo.
3) In the PTC Creo Start File field, specify the path to the PTC Creo Parametric startup file, e.g.
C:\Program Files\PTC\Creo 4.0\M010\Parametric\bin\parametric.bat.
4) In the Execute in field, specify the path to the PTC Creo Parametric startup directory, e.g. C:\SAP
PLM start.
5) Click Start.
Result: This launches PTC Creo Parametric and embeds SAP ECTR interface to PTC Creo as a
TOOLKIT tool. The configuration dialog is displayed.

25
SAP ECTR interface to PTC Creo - Configuration

4.6 Configuring SAP ECTR interface to PTC Creo

For the configuration of SAP ECTR interface to PTC Creo, a configuration dialog is available. The
settings you specify in the configuration dialog will be stored in the SAPECTRInterface.prefs file.

4.6.1 Settings file SAPECTRInterface.prefs

The file SAPECTRInterface.prefs contains static settings that will not be changed by SAP ECTR
interface to PTC Creo.

Location of the SAPECTRInterface.prefs file

%PLM_INSTDIR%\applications\pro\customize\config\SAPECTRInterface.prefs

Other system settings

Other settings are stored in the following file:
%APPDATA%\Roaming\.riess\SAPECTRInterface\SAPECTRInterface.prefs This file contains
dynamic settings that are made automatically by SAP ECTR interface to PTC Creo. This settings may not
be edited manually.

Distributing a standardized configuration

Make sure that all users work with the same configuration. Distribute the file named
%PLM_INSTDIR%\applications\pro\customize\config\SAPECTRInterface.prefs to other
users and their workstations.

Distributing the SAPECTRInterface.prefs file

Do the following to distribute the
%PLM_INSTDIR%\applications\pro\customize\config\SAPECTRInterface.prefs reference
file to other users:
1) Configure the settings on the System page of the SAP ECTR interface to PTC Creo configuration
dialog.
2) Configure the system settings for SAP ECTR interface to PTC Creo (see 4.6.3 Configuring settings
on the System page).
3) Save your settings.
4) Navigate to the %PLM_INSTDIR%\applications\pro\customize\config directory.
5) Copy the SAPECTRInterface.prefs file to a transfer drive.
6) Distribute the SAPECTRInterface.prefs to other users.
Result: All users will work with the same settings when selecting Launch Application from SAP ECTR.

Required entries
The %PLM_INSTDIR%\applications\pro\customize\config\SAPECTRInterface.prefs file
must contain the following entries:
• Execute in
de.riess.proeectr.proeExecFolder =<Path\PTC_CREO_PARAMETRIC_START_DIR>
• PTC Creo Start File
de.riess.proeectr.wildFireExe =<Path\PTC_CREO_PARAMETRIC_START_FILE>

4.6.2 Opening configuration dialog

You can open the configuration dialog from the SAP PLM menu or using the configure.exe
application.
In this dialog, the available configuration options are grouped by topics and displayed on separate pages.

26
SAP ECTR interface to PTC Creo - Configuration

The configuration dialog consists of the following pages:

• System
• Menu
• Save
• Parameter
• Ballooning
• Import
• Directories
• Advanced
• ModelCHECK

Other Settings
Please note that besides the settings in the configuration dialog for SAP ECTR interface to PTC Creo,
additional settings in the SAP ECTR configuration files are required in order to fully benefit from the
features of SAP ECTR interface to PTC Creo.

The configure.exe file in the installation directory

The configure.exe application is stored under the installation directory in the following path:
%PLM_INSTDIR%\applications\pro\appdata\configure.exe.

Permissions
You need write permissions to the
C:\Users\<Username>\AppData\Roaming\.riess\SAPECTRInterface directory.
Without write permissions, you will not be able to launch SAP ECTR interface to PTC Creo.
You need write permissions to the
%PLM_INSTDIR%\applications\pro\customize\config directory.
Without write permissions, you will not be able to configure SAP ECTR interface to PTC Creo.

Opening the configuration dialog from SAP ECTR interface to PTC Creo
Do the following to open the configuration dialog from the SAP PLM menu.
1) Click SAP PLM  Additional Functions  Settings  Settings.
2) Configure SAP ECTR interface to PTC Creo.
3) Save your settings.
Result: The configuration dialog is open and the settings have been saved.

Alternative: Opening the configuration dialog with configure.exe

Do the following to open the configuration dialog with configure.exe:
1) In the Windows Explorer, navigate to the %PLM_INSTDIR%\applications\pro\data directory.
2) Run the configure.exe file.
3) Configure SAP ECTR interface to PTC Creo.
4) Save your settings.
Result: The configuration dialog is open and the settings have been saved.

Closing the configuration dialog

Close the configuration dialog by clicking .

27
SAP ECTR interface to PTC Creo - Configuration

4.6.3 Configuring settings on the System page

On the System page, you can specify the files and paths that are required to launch SAP ECTR interface
to PTC Creo.
Only if all required settings have been made on the System page, it is possible to embed SAP ECTR
interface to PTC Creo as a TOOLKIT tool in PTC Creo Parametric and start it.
If you start PTC Creo Parametric for the first time from SAP ECTR and SAP ECTR interface to PTC Creo
has not been configured completely on the System page, the configuration dialog will open automatically.

4.6.3.1 PTC Creo Parametric startup file

To start PTC Creo Parametric from SAP ECTR, select System  Launch Application  Launch PTC
Creo.
In the PTC Creo Start File field, specify the path to the start files to be used for launching PTC Creo
Parametric.

Example
C:\Program Files\PTC\Creo 4.0\M010\Parametric\bin\parametric.bat

Path to the start file

Depending on the location of the start file, SAP ECTR interface to PTC Creo determines other paths, e.g.
to start the corresponding version of SAP ECTR interface to PTC Creo that matches the PTC Creo
version.
If you intend to use another start file than
%PTC_CREO_PARAMETRIC_INSTDIR%\Parametric\bin\parametric.bat, it must be located in the
%PTC_CREO_PARAMETRIC_INSTDIR%\parametric\bin directory.

Using an environment variable

Instead of the path, you can specify an environment variable that contains the path to the PTC Creo
Parametric start file. If you use environment variables, it is not possible to start PTC Creo Parametric
directly from the configuration dialog. Instead, start PTC Creo Parametric from SAP ECTR.

Example
%PTC_CREO_PARAMETRIC_START_FILE%

Using uppercase letters

Please note that the environment variable must always be written in uppercase letters.

Example
Set PTC_CREO_PARAMETRIC_START_FILE=
C:\Program Files\PTC\Creo 4.0\M010\Parametric\bin\Parametric.bat

Specifying the PTC Creo Parametric startup file

Specify the path to the PTC Creo Parametric startup file in the PTC Creo Start File field.
1) Click the PTC Creo Start File field.
2) Specify the full path to the startup file including its file name or use Browse, or specify the
appropriate environment variable.
3) Save your settings.
Result: By selecting System  Launch Applications Launch PTC Creo, you launched PTC Creo
Parametric using the specified startup file.

28
SAP ECTR interface to PTC Creo - Configuration

4.6.3.2 Execute in
To start PTC Creo Parametric from SAP ECTR, select System  Launch Application  Launch PTC
Creo.
In the Execute in field, specify the path to the directory from where you want to start PTC Creo
Parametric.
If this directory does not contain the config.pro and creo_parametric_customization.ui files
yet, they will be copied there from the
%ECTR_INSDIR%\applications\pro\appdata\config\proe directory.
In case errors occur, the std.err and traceback.log files will be created in this directory.

Example
C:\Data\CAD_Start_Directory

Using an environment variable

Instead of the path, you can specify an environment variable that contains the path to the startup
directory. If you use environment variables, it is not possible to start PTC Creo Parametric directly from
the configuration dialog. Instead, start PTC Creo Parametric from SAP ECTR.

Example
%PTC_CREO_PARAMETRIC_EXECUTE_IN%

Using uppercase letters

Please note that the environment variable must always be written in uppercase letters.

Example
Set PTC_CREO_PARAMETRIC_EXECUTE_IN=C:\Data\CAD_Start_Directory

Specifying the PTC Creo Parametric startup directory

Do the following to specify the path to the PTC Creo Parametric startup directory in the Execute in field:
1) Click the Execute in field.
2) Specify the full path to the startup file including its file name or use Browse, or specify the
appropriate environment variable.
3) Save your settings.
Result: By selecting System  Launch Applications  Launch PTC Creo, you launched PTC Creo
Parametric using the specified startup file.

Saving config.pro and creo_parametric_customization.ui in the startup directory

Make sure to save user-defined configuration files for PTC Creo Parametric, such as config.pro and
creo_parametric_customization.ui, in the startup directory.

4.6.3.3 Defining and enabling the PTC Creo Parametric start environment
Due to varying requirements or customers, it might be necessary to work in different PTC Creo
Parametric environments. SAP ECTR interface to PTC Creo, together with SAP ECTR, supports you in
switching between environments.
When you open an original, SAP ECTR interface to PTC Creo will check, together with SAP ECTR, if the
active CAD environment matches the one specified for the original. The CAD environment is derived
automatically from specific environment properties.

More information
For more details on Define and activate PTC Creo Parametric start environments, please refer to 5.1
Using different CAD environments.

29
SAP ECTR interface to PTC Creo - Configuration

4.6.3.4 Trace Level

SAP ECTR interface to PTC Creo logs (traces) the entire session and any errors that might occur. The
scope of tracing and the contents of the log files can be controlled by setting the desired trace level.
Three trace levels are available for selection:
• ERROR
If set to the ERROR trace level, the system will only log errors.
• INFO
If set to the INFO trace level, the system will log errors and other information.
• DEBUG
If set to the DEBUG trace level, the system will log errors, general information, and debug
information.

Using the trace level

The ERROR trace level is suitable for stable systems that have been tested thoroughly. The INFO trace
level is best suited for the system implementation phase.
Please note that writing log files in the DEBUG trace level will have a significant impact on the system
performance. Only use the DEBUG trace level temporarily if actual errors occur.

4.6.4 Configuring settings on the Menu page

On the Menu page, you can configure the SAP PLM menu and the context menu. Changes in the SAP
PLM menu configuration will only become effective when you restart PTC Creo Parametric.

Synchronizing the SAP PLM menu and the SAP PLM tab
Now, you need to remove the options that you removed from the Menu page of the SAP PLM menu also
from the SAP PLM tab on the PTC Creo Parametric ribbon.

30
SAP ECTR interface to PTC Creo - Configuration

4.6.4.1 SAP PLM menu and context menu

The SAP PLM menu of SAP ECTR interface to PTC Creo is displayed in the TOOLKIT group on the
Tools tab of the PTC Creo Parametric ribbon.
By default, all available commands are displayed in the SAP PLM menu and in the context menu.
In the menu tree on the Menu page, you can specify the commands to be displayed in the SAP PLM
menu and context menu.

Configuring the SAP PLM menu and context menu

Do the following to configure the SAP PLM menu and the context menu.
1) Expand the menu tree until you see the desired command.
2) Enable the checkboxes of all commands you want to display in the SAP PLM menu and in the
context menu.
3) Disable the checkboxes of all commands you do not want to display in the SAP PLM menu and in
the context menu.
4) Save your settings.
Result: After a restart of PTC Creo Parametric , the SAP PLM menu and the SAP ECTR interface to PTC
Creo context menu will be displayed as configured.

Synchronizing the SAP PLM menu and the SAP PLM tab
Now, you need to remove the commands that you removed from the SAP PLM menu (by configuring the
Menu page) also from the SAP PLM tab on the PTC Creo Parametric ribbon.

Invariable checkboxes
The checkboxes of commands whose setting cannot be changed (i.e. enabled or disabled) are controlled
via settings on a different page of the configuration dialog. Depending on the setting there, the
corresponding command is available or not in the SAP PLM menu.

31
SAP ECTR interface to PTC Creo - Configuration

4.6.5 Configuring settings on the Save page

On the Save page, you can define the behavior of SAP ECTR interface to PTC Creo when saving
originals in SAP.

4.6.5.1 Creating and saving additional originals

In SAP ECTR, thumbnails of CAD originals are displayed in JPEG format. When you save a CAD original
in SAP PLM, SAP ECTR interface to PTC Creo creates these thumbnails and saves them as additional
originals associated with the document. In addition to the thumbnails, other additional originals can be
created in various formats.
Under Additional Originals, you can specify the additional originals to be created.

Configuring additional original formats

Do the following to configure the additional originals to be created when saving CAD originals:
1) Enable the Create and save additional originals checkbox.
2) Enable the checkboxes of the formats to be created when saving CAD originals.
3) Disable the checkboxes of the formats not to be created when saving CAD originals.
4) Save your settings.
Result: When you save CAD originals, the system will create and save additional originals in the selected
formats.

Enabling thumbnails
To create thumbnails for SAP ECTR, enable the checkboxes of the JPEG formats for 3D models and 2D
drawings.

Configuring workstation applications and DTypes

Please note that for the additional originals, the corresponding workstation applications must be available
in your SAP system. In addition, you need to edit the dtype.xml file (primary_application 
checkin_rules  save_direct) in order to specify the specific file extensions and workstation
applications in the definition of the DType to be used.

Using a conversion service

The thumbnails and the additional originals created when saving CAD originals are only a snapshot of the
CAD originals shown in the graphics window. You achieve better results with corresponding background
conversions, e.g. after release of a document.

32
SAP ECTR interface to PTC Creo - Configuration

4.6.5.2 Refreshing the attributes of originals before saving

When you select the Originals  Refresh Attributes command or open CAD originals from within SAP,
values from document data and additional data are transferred to parameters (attribute) of the CAD
originals.
It is also possible to refresh the attributes automatically before saving the originals in SAP by selecting
Originals  Save or Originals  Save and Display.
By enabling the Refresh attributes of original before Save in SAP checkbox, you can specify that the
attributes will be refreshed.

1.3.2 Refresh attributes of original before Save in SAP

Do the following to configure that the attributes of CAD originals will be refreshed before saving in SAP:
1) Enable the Refresh attributes of original before Save in SAP checkbox.
Result: The attributes of CAD originals are refreshed before saving in SAP.

Refreshing the attributes of originals before saving

Enable the Refresh attributes of original before Save in SAP checkbox. This way, you can make sure
that the attributes of the saved CAD originals are up-to-date. This is particularly important if the attributes
are used in downstream processes, e.g. conversions.

Configuring the DType and the attributes section

Please note that when editing the dtype.xml file in order to define the DType to be used, the reference
to the corresponding attributes section in the attributes-from-sap.xml file must be specified
(primary_application attribute_section). The attributes are refreshed depending on the
configuration of the attributes section in the attributes-from-sap.xml file.

4.6.5.3 Including formats in the document structure

With Originals Add Format, you can load drawing formats from SAP and add them to the drawing.
Formats added from within SAP can be included in the drawing document structure.
By enabling the Include Formats in Document Structure checkbox, you can specify that formats added
from within SAP will be included in the drawing document structure.

Including formats in the document structure

Do the following to configure that formats added from within SAP will be included in the drawing
document structure:
1) Enable the Include Formats in Document Structure checkbox.
Result: Formats added from within SAP are included in the document structure when saving a drawing in
SAP.

33
SAP ECTR interface to PTC Creo - Configuration

4.6.5.4 Delete old versions from the working directory when saving to SAP
PTC Creo Parametric does not overwrite CAD files when saving them, but creates additional versions of
these files in the working directory.
The file names are incremented by one (this number is added to the file extension).
1000004711ppr000.prt
1000004711ppr000.prt.1
1000004711ppr000.prt.2
1000004711ppr000.prt.3
When saving originals to SAP with Originals  Save or Originals  Save and Display, the file with the
highest number is copied (without that number) and checked in to SAP.
It is possible to have the numbered files deleted automatically after saving the most recent file (without its
number) to the SAP working directory.
With Delete old versions (e.g. *.prt.1 - *.prt.n) after Save in SAP from working directory, you can
specify that old versions will be deleted from the working directory after saving the most recent file
(without its number) to SAP.

Deleting old versions from the SAP working directory after saving
Do the following to configure that old versions will be deleted from the working directory after saving to
SAP.
1) Enable the Delete old versions (e.g. *.prt.1 - *.prt.n) after Save in SAP from working directory
checkbox.
2) In the pull-down menu, select one of the following options:
 Delete all versions
 Keep highest version
3) Save your settings.
Result: The numbered files are deleted automatically after saving the most recent file (without its number)
to the SAP working directory.

4.6.5.5 Include User-Defined Features in Document Structure

By enabling the Include User-Defined Features in Document Structure checkbox, you can specify that
UDF documents will be included in the document structure.

Include User-Defined Features in Document Structure

Do the following to ensure that User-Defined Features will be included in the document structure.
1) Enable the Include User-Defined Features in Document Structure checkbox.
Result: User-Defined Features will be included in the document structure when you save your files in
SAP.

Import UDF
The command SAP PLM  Additional Functions  Extras  UDF Import UDF is also activated by
enabling the Include Formats User-Defined Features in Document Structure checkbox.

34
SAP ECTR interface to PTC Creo - Configuration

4.6.6 Configuring settings on the Parameter page

On the Parameter page, you can define the behavior of SAP ECTR interface to PTC Creo when
initializing CAD parameters.

4.6.6.1 Initializing parameters

CAD originals that were migrated to SAP from legacy systems might not contain all required parameters.
When you add a format from within SAP by selecting Originals Add Format or SAP PLM 
Additional Functions  Extras  Initialize Parameters, you can create the missing parameters and
populate them with the desired values.
Under Initialize Values, specify the parameters to be created and the values to be used for initializing. In
addition, you can specify, for each parameter, the target drawing or model (part or assembly) to be used
for initializing.

Initializing parameters
Do the following to specify the name, target, and value of parameters to be initialized:
1) Enable the Define CAD Parameters, which are initialized using the commands "Add format"
and "Initialize Parameters" checkbox.
2) Double-click to enable the input field in the Name column.
3) Enter the parameter name into the Name column.
4) To initialize the parameter in a drawing, enable the checkbox in the Drawing column.
5) Double-click to enable the input field in the Drawing column.
6) Enter the desired initial value.
7) To initialize the parameter in a model, enable the checkbox in the Model column.
8) Double-click to enable the input field in the Model column.
9) Enter the desired initial value.
10) Repeat these steps for other parameters you need and then save your settings.
Result: When you add a format from within SAP by selecting Originals Add Format or SAP PLM 
Additional Functions  Extras  Initialize Parameters, the missing parameters will be created and
initialized with the desired values.

Deleting parameters from the list

To delete a parameter from the list, right-click to open the context menu and select Remove.

Parameters without a value

Parameters for which you did not specify an initial value will be created in the enabled target without a
value, i.e. they will be blank.

35
SAP ECTR interface to PTC Creo - Configuration

4.6.7 Configuring settings on the Ballooning page

On the Ballooning page, you can define the behavior of SAP ECTR interface to PTC Creo when
refreshing component parameters.

4.6.7.1 Refresh Component Parameters

A SAP bill of materials for an assembly can only be represented in a drawing if a table with repeat region
has been added to the drawing. This table shows component parameters with data from the bill of
materials, such as the item number and material number.
By selecting SAP PLM  Additional Functions  Ballooning  Refresh Component Parameters,
you can transfer data from bills of materials to component parameters.
Under Component Parameters, you can specify the component parameters to be created and the data
from the bill of materials to be used for refreshing the component parameters.
The following data types can be refreshed:
Type Description
MATNR Material number (internal representation)
MATNR_EXTERN Material number (external representation—without leading zeros)
POSNR Item number (internal representation—6 digits)
POSNR_EXTERN Item number (external representation—4 digits)
POSTEXT_1 Item text 1
POSTEXT_2 Item text 2

Table: Data types to be refreshed from bills of materials

Refreshing component parameters

Do the following to define the names of the component parameters to be refreshed:
1) Enable the Define CAD Component Parameters which are created and initialized using the
command "Refresh Component Parameters" checkbox.
2) Select the line that contains the desired type (right-hand column).
3) Double-click to enable the input field in the Name column.
4) Enable the checkbox.
5) Repeat these steps for other parameters you need and then save your settings.
Result: By selecting SAP PLM  Additional Functions  Ballooning  Refresh Component
Parameters, the data from bills of materials will be transferred to component parameters.

Disabling individual parameters

Disable the checkbox in the line of the parameter.

36
SAP ECTR interface to PTC Creo - Configuration

4.6.8 Configuring settings on the Import page

On the Import page, you can define the behavior of SAP ECTR interface to PTC Creo when importing
CAD files.

4.6.8.1 Import On Demand dialog

With SAP PLM  Original  Import, you can import CAD files to SAP PLM. In the Import On Demand
dialog of SAP ECTR, you need to select the appropriate DType or confirm the suggested DType.
If you previously defined exactly one DType for each CAD object type, you can skip the Import On
Demand dialog.

Skipping the Import On Demand dialog

Do the following to skip the display of the Import On Demand dialog:
1) Disable the Always show SAP ECTR Import On Demand Dialog checkbox.
Result: The Import On Demand dialog of SAP ECTR will not be displayed any longer.

DType / CAD object type association

If the Import On Demand dialog of SAP ECTR is still displayed, there is no unique association of the
DType to the CAD object types.

4.6.9 Configuring settings on the Directories page

On the Directories page, you can define the behavior of SAP ECTR interface to PTC Creo when
refreshing directories.

4.6.9.1 Change working directory

SAP ECTR interface to PTC Creo links the CAD session- to the SAP ECTR working directory. SAP ECTR
interface to PTC Creo ensures that the user does not change the working directory. Some modules such
as PTC Creo Mechanism Design, however, need to change the working directory temporarily.
Under Temporary directories, you can specify the directories to which PTC Creo Parametric is allowed
to change temporarily.

Enable the Specify the working directories PTC Creo Parametric is allowed to change to
temporarily checkbox
Specify the directories to which PTC Creo Parametric is allowed to change temporarily.
1) Enable the Specify the working directories PTC Creo Parametric is allowed to change to
temporarily checkbox.
2) Under Change Working Directory, enter one allowed directory per line into the Directories input
field.
3) Confirm your input by pressing the [ ] key.
4) Enter more paths, if required.
Result: If required, PTC Creo Parametric is now allowed to change to the working directories you
indicated.

37
SAP ECTR interface to PTC Creo - Configuration

4.6.10 Configuring settings on the Advanced page

On the Advanced page, you can define settings that override defaults and limitations.

4.6.10.1 Show CAD Structure

From within SAP ECTR interface to PTC Creo, it is possible to display the application structure of the
SAP ECTR. By default, family tables are expanded completely when you display the application structure.

Expand family tables completely

Do the following to expand the family tables completely when displaying the application structure.
1) Enable the Expand family tables completely checkbox.
Result: Family tables are expanded completely when you open the application structure.

Do not expand family tables completely

Disable the Expand family tables completely checkbox. This ensures that the family tables are not
expanded completely, speeding up the application structure display. In the application structure, you can
expand the family tables by clicking the [+] symbol.

Initial expansion level of the application structure

You can set the initial resolution level of the application structure via the
plm.structure.application.init.strategy.levels.pro preference. For details on the
expansion level, please refer to section 5.8, Setting the Initial Expansion Level of the Application
Structure.

Restriction
Only disable the Expand family tables completely checkbox if the
plm.structure.application.init.strategy.levels.pro preference has a value ≠ all.

4.6.10.2 Disabling default limitations

Undesired system behavior and data inconsistencies

In order to avoid undesired system behavior and data inconsistencies, SAP ECTR interface to PTC Creo
by default limits the use of certain CAD system functions.
You can disable these limitations at your own risk.

4.6.10.2.1 Disable limitation ʺNo renaming of originals in the CAD systemʺ

By default, you are not allowed to rename originals that are already known to SAP and that are linked to a
document info record.

Disable limitation ʺNo renaming of originals in the CAD systemʺ

Do the following to disable the limitation ʺNo renaming of originals in the CAD systemʺ:
1) Enable the Disable limitation ʺNo renaming of originals in the CAD systemʺ checkbox.
Result: CAD files with a linked document can be renamed in PTC Creo Parametric.

38
SAP ECTR interface to PTC Creo - Configuration

4.6.10.2.2 Disable limitation ʺDo not create UDF if the reference part has no
Documentʺ
When you import CAD files, they are usually renamed. Once a UDF (User-Defined Feature) has been
created, its UDF reference model may no longer be renamed. Otherwise, the UDF will lose its link to the
reference part and thus might become useless. By default, you can only create new UDFs in SAP ECTR
interface to PTC Creo if a document already exists for the associated UDF reference model.

Disable limitation ʺDo not create UDF if the reference part has no Documentʺ
Disable the limitation ʺDo not create UDF if the reference part has no Documentʺ
1) Enable the Disable limitation ʺDo not create UDF if the reference part has no Documentʺ
checkbox.
Result: You can create UDFs even though no document is linked to the UDF reference model.

4.6.11 Configuring settings on the ModelCHECK page

On the ModelCHECK page, you can specify how SAP ECTR interface to PTC Creo will interact with PTC
Creo ModelCHECK.
PTC Creo ModelCHECK can be executed when you save or save and display CAD originals in SAP.
Optionally, you can prevent originals with errors from being saved or saved and displayed in SAP.

Execute PTC Creo ModelCHECK before saving originals in SAP

Do the following to execute PTC Creo ModelCHECK before saving originals in SAP.
1) Enable the Excecute PTC Creo ModelCheck before saving originals in SAP checkbox.
2) Enable the checkbox for the desired option in the Settings section.
3) In the Configurations section, select the directory that contains the PTC Creo ModelCHECK
configuration to be used (radio button  option).
4) In the Results section, select where to save the PTC Creo ModelCHECK result files (radio button
 option) and enter or select the desired directory, if appropriate.
Result: PTC Creo ModelCHECK will be executed when you save or save and display CAD originals.

Settings
Enable both checkboxes in the Settings section. The PTC Creo ModelCHECK results are shown in the
internal browser, allowing you to correct any errors immediately.

Configurations
In the Configurations section, enable the Optional path (radio button  option), if you want to execute
other checks than those specified in the default path before saving your CAD originals in SAP.

39
SAP ECTR interface to PTC Creo - Configuration

Prevent saving originals with errors

Do the following to prevent saving originals with errors:
1) Enable the Prevent saving originals with errors checkbox.
2) In the pull-down menu, select the type of notification in case originals with errors are found.
3) In the Errors and warnings section, configure whether both errors and warnings will be
considered.
4) Optionally specify the number of errors and warnings to be tolerated.
Result: Originals with errors will not be checked in to SAP. A message will be displayed to the user.

Messages
If you select the Display message option from the pull-down menu, a message will be displayed in case
of errors. Saving of originals with errors must be aborted.
If you select the No message option from the pull-down menu, a message will be displayed in case of
errors. Saving of originals with errors will always be aborted. A message in the message area will inform
the PTC Creo Parametric user that saving has been aborted.
If you select the Display dialog option from the pull-down menu, a dialog box will be displayed in case of
errors. You can then select to continue or abort the procedure of saving originals with errors.

40
SAP ECTR interface to PTC Creo - Advanced Configuration

This chapter covers specific configuration topics. Some of them

require combined settings from multiple systems involved.

5 Advanced Configuration

You can only fully benefit from the scope of functionality of SAP ECTR interface to PTC Creo if the entire
system has been configured accordingly. This usually implies editing various configuration files of the
systems involved.
The following functions typically require a combination of various settings:
• CAD environments
 Using different CAD environments
 Integrating SAP ECTR interface to PTC Creo into CAD environments launched by an external
application
• Attributes and formats
 Refreshing attributes and SAP fields
 Managing Drawing Frames in SAP
• Smart containers
 Using smart containers for drawings
 Displaying dependent drawings in the Where Referenced container
• Family tables
 Defining a DType for family tables
• Application structure
 Setting the Initial Expansion Level of the Application Structure
• Advanced use cases
 Using ballooning functions
 Managing User-Defined Features in SAP
 Loading CAD structures—without referenced objects

41
SAP ECTR interface to PTC Creo - Advanced Configuration

5.1 Using different CAD environments

Due to varying requirements or customers, it might be necessary to work in different PTC Creo
Parametric environments. SAP ECTR interface to PTC Creo, together with SAP ECTR, supports you in
switching between environments.
When starting PTC Creo Parametric, you can select a defined CAD environment. In each batch file, the
PTC Creo Parametric startup file (parametric.bat) and the startup directory (Execute in) to be used
can be specified explicitly. For example, PTC Creo Parametric reads the config.pro file stored in the
startup directory and starts as configured there. In each batch file, you can set other environment
variables that are specific to the CAD environment and copy additional files to the startup directory.
When opening an original, SAP ECTR interface to PTC Creo checks, together with SAP ECTR, whether
the active CAD environment matches the one specified for the original. The CAD environment is derived
automatically from specific environment properties.

CAD environment properties

The following environment properties are used to distinguish the various CAD environments:
• Version
• Version Ext. (Date Code)
• CAD Environment

5.1.1 CAD environments - typical use cases

Among others, the following use cases can occur:

• Launching PTC Creo Parametric from within SAP ECTR using a selected environment.
• Launching PTC Creo Parametric by opening an original in SAP ECTR.
• PTC Creo Parametric has already been launched and an original is being opened from SAP ECTR.

Launching PTC Creo Parametric from within SAP ECTR using a selected environment
If you launch PTC Creo Parametric from SAP ECTR using Launch PTC Creo, a selection dialog
displays. In the selection dialog, you can select the desired CAD environment from a list of available CAD
environments. With Launch PTC Creo, PTC Creo Parametric will then be launched in the selected
environment. SAP ECTR will then assign the corresponding CAD environment properties to all CAD
originals you create or modify in the selected CAD environment or to the associated documents.
• Version
• Date Code
• Environment

Launching PTC Creo Parametric by opening an original from SAP ECTR

If you launch PTC Creo Parametric by opening an original from SAP ECTR, a selection dialog displays.
The selection dialog displays and defaults to the CAD environment derived from the CAD environment
properties ( checkbox). You can use Launch PTC Creo to launch PTC Creo Parametric in the default
CAD environment. If you want to open the original in a different CAD environment, select it in the
selection dialog ( checkbox).

No CAD environment specified

If no CAD environment has been associated with the original, there is no default CAD environment in the
selection dialog.

42
SAP ECTR interface to PTC Creo - Advanced Configuration

Opening an original from SAP ECTR while PTC Creo Parametric is already running
If PTC Creo Parametric has already been started in a selected CAD environment and you open an
original from SAP ECTR, SAP ECTR compares the CAD environment properties with the running CAD
environment. If the CAD environment matches these properties, the original will be opened in PTC Creo
Parametric. If the CAD environment does not match these properties, a dialog displays. There, the user
can select whether to cancel opening the original or to open the original in the currently running CAD
environment.

No CAD environment specified

If no particular CAD environment is associated with the original, the original will be started in the currently
running environment.

5.1.2 CAD environments—configuration

Prerequisite
In order to work with multiple CAD environments, make sure that the following prerequisites are met:
Configuration of SAP ECTR
• In the default.txt file, the plm.check.environment.PRO = true preference must be set.
Configuration of SAP ECTR interface to PTC Creo
• The environment variables set in the batch files must have been specified in the SAP ECTR
interface to PTC Creo settings.
• The CAD environments must have been defined and enabled.
CAD startup directories
• The CAD startup directories for each CAD environment must have been defined.
• The PTC Creo Parametric configuration files specific to each CAD environment must exist in the
CAD startup directories.
Batch files
• The
%PLM_INSTDIR%\applications\pro\customize\scripts\batches\
prepare_environment
directory must contain the batch files specific to that CAD environment.
• The batch files must contain environment variables indicating the path to the corresponding PTC
Creo Parametric startup file and startup directory.
Optionally: DType and seedfile
• For each CAD environment, you can define an environment-specific DType and seedfile.

43
SAP ECTR interface to PTC Creo - Advanced Configuration

5.1.2.1 Configuration of SAP ECTR

Setting the preference for the environment check

Do the following to set the plm.check.environment.PRO preference in the default.txt file.
1) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\applications\pro\customize\config\default.txt file.
2) Search for plm.check.environment.PRO.
3) Set plm.check.environment.PRO = true.
Result: The environment check for PTC Creo Parametric originals is now enabled in SAP ECTR.

Defining and enabling the PTC Creo Parametric start environment

Only use the plm.check.environment.PRO = true preference if the  Define and activate PTC
Creo Parametric start environments checkbox is enabled in the SAP ECTR interface to PTC Creo
configuration dialog.

5.1.2.2 Configuration of SAP ECTR interface to PTC Creo

Defining and enabling CAD environments in SAP ECTR interface to PTC Creo
Do the following to configure and enable the CAD environments:
1) Open the configuration dialog of SAP ECTR interface to PTC Creo (see 4.6 SAP ECTR interface to
PTC Creo).
2) Open the System page.
3) Click the PTC Creo Start File field.
4) Specify the correct environment variable, such as %PTC_CREO_PARAMETRIC_START_FILE%.
5) Click the Execute in field.
6) Specify the correct environment variable, such as %PTC_CREO_PARAMETRIC_EXECUTE_IN%.
7) Enable the  Define and activate PTC Creo Parametric start environments checkbox.
8) Click New.
9) Specify all properties for the environment, starting at the left.
CAD Version  Date Code  Environment
10) Click OK.
11) Repeat these steps for other CAD environments.
12) Click Save to save your settings.
Result: The CAD environments are now properly defined and enabled.

plm.check.environment.PRO
If you enable the  Define and activate PTC Creo Parametric start environments checkbox, the
plm.check.environment.PRO = true preference in the
%PLM_INSTDIR%\applications\pro\customize\config\default.txt file must be set.

Date Code
When entering the date code, make sure to specify it correctly. Example: M010.

Environment
Make sure to enter a meaningful name for the environment.

Batch files
If you filled in the CAD Version, Version Ext. (Date Code), and CAD Environment fields completely, a
filename will be suggested in the Batch File field. Confirm the suggested filename. Alternatively, you can
select a different filename or path. In this case, click the button.

44
SAP ECTR interface to PTC Creo - Advanced Configuration

5.1.2.3 CAD startup directories

You can create a separate CAD startup directory for each CAD environment. PTC Creo Parametric will
be executed from this startup directory and will use the configuration files stored there.

Creating CAD startup directories

Do the following to create the CAD startup directories:
1) Create a separate CAD startup directory for each CAD environment.
2) Copy all PTC Creo Parametric configuration files relevant to the respective environment to these
directories.
Result: The CAD startup directories have been created and SAP ECTR interface to PTC Creo can be run
from there.

CAD working directories

The structure of the CAD startup directories might look like this:
CAD Environment
| Creo4_M010_English
| Creo4_M010_German

5.1.2.4 Batch files

For each CAD environment, a corresponding batch file must be available that will be executed before
PTC Creo Parametric is launched. The batch files must contain environment variables indicating the path
to the corresponding PTC Creo Parametric startup file and startup directory.
In addition, you can use a batch file to copy environment-specific PTC Creo Parametric configuration
files, such as the config.pro file, to the startup directory.

Creating batch files

Do the following to create a separate batch file for each CAD environment:
1) Open a text editor such as Notepad ++.
2) Set environment variables that contain the following paths:
 Path to the CAD startup file
 Path to the CAD startup directory
3) Add other entries to the batch file, depending on the further CAD environment requirements.
4) Save the batch file in the following directory:
%PLM_INSTDIR%\applications\pro\customize\scripts\batches\
prepare_environment.
Result: Once you select a specific environment, the associated batch file will be executed. The PTC Creo
Parametric startup file indicated in the batch file is executed from the specified CAD startup directory.

Environment variables
Use the same environment variables as those specified in the SAP ECTR interface to PTC Creo
configuration dialog. Examples:
• PTC Creo Start File
Set PTC_CREO_PARAMETRIC_START_FILE=
C:\Program Files\PTC\Creo 4.0\M010\Parametric\bin\parametric_en.bat
• Execute in
Set PTC_CREO_PARAMETRIC_EXECUTE_IN=
C:\CAD Environment\ Creo4_M010_English

45
SAP ECTR interface to PTC Creo - Advanced Configuration

Encoding
When you save your batch files, make sure to select the correct encoding. Set the encoding in your
editor, e.g. Notepad++, to ANSI.

Quotes
When specifying the paths, do not use quotes (double inverted commas)!

Filenames
Use the same filenames as those suggested for the respective environment in the SAP ECTR interface to
PTC Creo configuration dialog, such as
• Creo 4.0_M010_english.bat
• Creo 4.0_M010_german.bat

5.1.2.5 DType and seedfile

If different CAD environments require different seed files, you need to check in the corresponding
seed file to SAP PLM. The DType definition must be adapted accordingly.

Checking in the seed file to SAP PLM

Do the following to create an environment-specific seed file:
1) Launch PTC Creo Parametric in the desired CAD environment.
2) Create a new seed file.
3) Check this seed file in to SAP PLM.
4) Release the seed file.
Result: A document has been created for the new, released seed file. The seed file can be added
to the DType definition

Adding the seed file to the DType definition

Do the following to add the seed file to the DType definition:
1) Edit the file named %PLM_INSTDIR%\applications\pro\customize\config\dtype.xml.
2) Add the seedfile definition to the document_create element in the DType definition.
Result: The seed file can now be used. When creating a new original, SAP ECTR interface to PTC
Creo checks, together with SAP ECTR, whether the active CAD environment matches the one specified
in the seedfile.

Seed file in the DType definition

Add the seed file to the DType definition, as shown in the following example:
<seedfile
default="yes"
type="template"
workstation_application="PRO"
docnumber="1000004711"
doctype="PPR"
docpart="000"
filename_pattern=".+(?&lt;!(\.var|_gp))\.prt$"
component_reference="no"
appl_enwironment="english"
appl_release="Creo 4.0"
appl_release_ext="M010"
>
<description language="EN" text="Solid"/>
<description language="DE" text="Volumenkörper"/>
</seedfile>

46
SAP ECTR interface to PTC Creo - Advanced Configuration

Make sure that the environment attributes match the configuration of SAP ECTR interface to PTC Creo:

Environment attributes SAP ECTR interface to PTC Creo

appl_environment Environment
appl_release CAD Version Date Code
appl_release_extern Date Code

Table: Environment attributes and matching configuration options

47
SAP ECTR interface to PTC Creo - Advanced Configuration

5.2 Integrating SAP ECTR interface to PTC Creo into CAD

environments launched by an external application

By default, SAP ECTR interface to PTC Creo is set up so that PTC Creo Parametric will be launched from
within the SAP ECTR. During startup of PTC Creo Parametric the SAP ECTR interface to PTC Creo is
registered and embedded into PTC Creo Parametric as a TOOLKIT tool (auxiliary application).
If you control your CAD environment by adding corresponding applications and startup tools, you can
modify the startup behavior of SAP ECTR interface to PTC Creo. If an environment has already been
launched, SAP ECTR interface to PTC Creo will be integrated later into it.
Set the following environment variables:
• PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM
• PLM_RIESS_EXTERNAL_START_MAX_TRIES

Batch files
For this purpose, use the batch files described in section 15.1 Using different CAD environments.

PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM
The PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM environment
variable modifies the startup behavior of SAP ECTR interface to PTC Creo. This way, SAP ECTR
interface to PTC Creo can be integrated into a PTC Creo Parametric session that has already been
started. The value of this environment variable indicates the startup delay in seconds. At the end of the
startup delay, SAP ECTR interface to PTC Creo is integrated into PTC Creo Parametric.

PLM_RIESS_EXTERNAL_START_MAX_TRIES
Within the startup delay specified in
PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM, the system will try
three times to integrate SAP ECTR interface to PTC Creo into the PTC Creo Parametric session
launched by an external application. With the PLM_RIESS_EXTERNAL_START_MAX_TRIES environment
variable, you can explicitly specify the number of tries within the startup delay.

Creating batch files

Do the following to create a separate batch file for each CAD environment:
1) Open a text editor such as Notepad ++.
2) Set the PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM
environment variable and, if required, the
PLM_RIESS_EXTERNAL_START_MAX_TRIES
environment variable.
3) Set environment variables that contain the following paths:
 Path to the CAD startup file
 Path to the CAD startup directory
4) Add other entries to the batch file, depending on the CAD environment requirements.
5) Save the batch file in the following directory:
%PLM_INSTDIR%\applications\pro\customize\scripts\batches\
prepare_environment
Result: Once you select a specific environment, the associated batch file will be executed. The PTC Creo
Parametric startup file indicated in the batch file is executed from the specified CAD startup directory.

Startup delay
Define a startup delay in seconds that is a little longer that the startup duration of your CAD system.
Example:
set PLM_RIESS_ENABLE_EXTERNAL_START_AND_DELAY_TIME_FOR_CAD_SYSTEM=10

48
SAP ECTR interface to PTC Creo - Advanced Configuration

Environment variables
Use the same environment variables as those specified in the SAP ECTR interface to PTC Creo
configuration dialog. Examples:
• PTC Creo Start File
Set PTC_CREO_PARAMETRIC_START_FILE=
C:\Program Files\PTC\Creo 4.0\M010\Parametric\bin\parametric_en.bat
• Execute in
Set PTC_CREO_PARAMETRIC_EXECUTE_IN=
C:\CAD Environment\ Creo4_M010_English

49
SAP ECTR interface to PTC Creo - Advanced Configuration

5.3 Refreshing attributes and SAP fields

There are two ways to synchronize, i.e. refresh) values in user-defined CAD parameters and CAD
system parameters (attributes) with values in document data, additional document data, and material
master data (SAP fields):
• Refreshing attributes by using values from SAP fields
• Refreshing SAP fields using attribute values
The following files define how and when attributes will be refreshed using SAP fields:
Configuration of SAP ECTR
• DTypes.xml
 In the attributes-from-sap.xml and attributes-to-sap.xml files, you need to
specify the required attributes sections. The attributes sections are used, depending on the
DType, when refreshing attributes and SAP fields.
 In addition, you need to specify the events upon which the attributes will be refreshed
automatically.
• attributes-from-sap.xml
 Make sure that the attributes sections have been defined.
 Make sure to specify the attributes to be refreshed using SAP fields, grouped by attributes
sections.
• attributes-to-sap.xml
 Make sure that the attributes sections have been defined.
 Make sure to specify the SAP fields to be refreshed using attributes, grouped by attributes
sections.

For further reference

For further details on the configuration of SAP ECTR, please refer to the SAP ECTR documentation.

50
SAP ECTR interface to PTC Creo - Advanced Configuration

5.3.1 Refreshing attributes by using values from SAP fields

There are multiple ways to refresh attributes by using values from SAP fields:
• Manually
 Refreshing by selecting Refresh Attributes
• Automatically
 Adding a format from within SAP by selecting Add Format
• Automatically/optionally
 Checking in CAD originals with Save or Save and Display
 Loading CAD originals from SAP

Prerequisites
In order to refresh attributes by using values from SAP fields, the following prerequisites must be met:
Configuration of SAP ECTR interface to PTC Creo
• The Refresh Attributes command must be available.
• The Add Format command must be available.
• Optionally: The Refresh attributes of original before Save in SAP option must be enabled.
Configuration of SAP ECTR
• DTypes.xml
 When defining the DType, you need to specify the corresponding attributes section in the
attributes-from-sap.xml file.
 Optionally:
When defining the DType, you must specify the events upon which the attributes will be
refreshed automatically.
• attributes-from-sap.xml
 Make sure that the attributes section has been defined.
 Make sure to specify the attributes to be refreshed using SAP fields in the attributes section.

Configuring the SAP PLM menu and context menu

For further details on how to configure the SAP PLM menu and the context menu, please refer to section
4.6.4.1 , SAP PLM menu and context menu.
For information on how to configure the Add Format function, please refer to section 4.6.5.3, Including
formats in the document structure.

Refreshing the attributes of originals before saving

For information on how to configure the Refresh attributes of original before Save in SAP function,
please refer to section 4.6.5.2, Refreshing the attributes of originals before saving.

Syntax of the attributes-from-sap.xml configuration file

Attributes (user-defined CAD parameters) must have the PROPARAM: prefix.

Examples
For examples, see the attributes-from-sap.xml file in the
%PLM_INSTDIR%\applications\pro\template-customize\config directory.

51
SAP ECTR interface to PTC Creo - Advanced Configuration

5.3.2 Refreshing values in SAP fields by using attributes

The values in SAP fields will be refreshed automatically using attribute values when you select one of the
following save commands in SAP:
• Save
• Save and Display
• Save as New Version
• Save as New Document

Prerequisites
In order to refresh values in SAP fields by using attributes, the following prerequisites must be met:
Configuration of SAP ECTR
• DTypes.xml
 When defining the DType, you need to specify the corresponding attributes section in the
attributes-to-sap.xml file.
• attributes-to-sap.xml
 Make sure that the attributes section has been defined.
 Make sure to specify the SAP fields that will be refreshed using attributes in the attributes
section.

Syntax of the attributes-to-sap.xml configuration file

Attributes (user-defined CAD parameters) must have the PROPARAM: prefix.
System attributes (system parameters) must have the PROPROP: prefix. System attributes can only be
transferred from PTC Creo Parametric to the SAP system, not vice-versa.

Examples
For lists with system attributes and examples, please refer to the attributes-to-sap.xml file in the
%PLM_INSTDIR%\applications\pro\template-customize\config directory.

52
SAP ECTR interface to PTC Creo - Advanced Configuration

5.4 Managing formats in SAP

In SAP, you can manage formats and even add a drawing frame to a drawing directly from SAP. The title
block of the format can show drawing parameters and model parameters (attributes) that are refreshed
using values from SAP.

Prerequisites
In order to manage drawing formats in SAP, the following prerequisites must be met:
Configuration of SAP ECTR
• dtype.xml
 The DType for formats must have been defined.
 When defining the DType for drawings and, if applicable for drawing models, you need to
specify the corresponding attributes section in the attributes-to-sap.xml file.
• default.txt
 The selection filter for formats must have been defined.
• attributes-from-sap.xml
 Make sure that the attributes section for drawings has been defined.
 Make sure to specify the attributes to be refreshed using SAP fields in the attributes section.
Configuration of SAP ECTR interface to PTC Creo
• The Add Format command must have been enabled.
• The attributes that will be created and initialized with the Add Format command must have been
defined.
• The Include Formats in Document Structure function must have been enabled.
Documents for formats
• For the formats, you need to create the associated documents.
• The document status of these documents must match the selection filter.

DType for formats

As for all other types of PTC Creo Parametric objects to be managed with SAP ECTR in SAP, a
corresponding DType needs to be defined for formats as well.

Example
In the %PLM_INSTDIR%\applications\pro\template-customize\config directory, please refer
to the file named dtype.xml that contains a sample DType definition called PROFR.

Refreshing attributes
With Add Format, you can add formats. The parameters represented in the title block are refreshed by
values from the document and the additional document data.
See also: 4.6.6.1 Initialize Parameters

SAP PLM menu and context menu

Configure the SAP PLM menu and the context menu. Enable the Add Format checkbox.
See also: 4.6.4.1 SAP PLM menu and context menu

53
SAP ECTR interface to PTC Creo - Advanced Configuration

Including formats in the document structure

Formats added with Add Format must be included in the drawing document structure.
Specify that formats added from within SAP will be included in the drawing document structure.
See also: 4.6.5.3 Including formats in the document structure

Documents for formats

You can only use Add Format to add formats to a drawing if the drawing frames have been checked into
SAP. The document type, document part, and status must match the selection filters defined in the
default.txt file.

Defining a selection filter for formats

In the %PLM_INSTDIR%\applications\pro\customize\config\default.txt file, the selection
of the formats available with Originals  Add Format is restricted based on the following criteria:
• Document type
plm.document.search.drawingFormatDocType.PRO = <DocType>
• Document status
plm.document.search.drawingFormatDocStatus.PRO = <DocStatus>
• Document part
plm.document.search.drawingFormatDocPart.PRO = <DocPart>

Excluding filters
If you want to exclude one or multiple filters, you can comment out the corresponding line(s) in the
default.txt file using the # character.

54
SAP ECTR interface to PTC Creo - Advanced Configuration

5.5 Using smart containers for drawings

In SAP ECTR, user-defined smart containers can be displayed and populated with content.

Displaying the smart container for drawings

Display the Drawings smart container for documents associated with parts or assemblies. Automatically
populate the Drawings smart container with part or assembly drawings using a macro.

Prerequisite
In order to use the Drawings smart container, the following prerequisites must be met:
Configuration of SAP ECTR
• default.txt
 You need to define the name of the smart container, the macro to be executed, and the icon to
be displayed for the smart container.
 In addition, specify the document types for which you want to display the smart container.
• <macro>.txt
 The macro specified in the default.txt file must be contained in a file named
<macro>.txt.
• dictionary.txt
 The language-specific dictionary.txt file must contain a translation of the smart container
name.

Defining a smart container

You can define the smart container in the
%PLM_INSTDIR%\applications\pro\customize\config\default.txt file:
• Smart Container Name
plm.smart.container.<DEF. SMART CONTAINER>.name = <SMART CONTAINER>
• Smart Container Macro
plm.smart.container.<DEF. SMART CONTAINER>.macro = PRO:<macro>.txt
• Smart Container Icon
plm.smart.container.<DEF. SMART CONTAINER>.icon = <.../Icon>

Example
The %PLM_INSTDIR%\applications\pro\template-customize\config\default.txt file
contains the sample macro called MACRO_DRW_PRO for the Drawings smart container:
• plm.smart.container.MACRO_DRW_PRO.name = MACRO_DRW_PRO
• plm.smart.container.MACRO_DRW_PRO.macro = PRO:drawings.txt
• plm.smart.container.MACRO_DRW_PRO.icon = {0}/sap/drawing

Displaying a smart container depending on the document type

In the %PLm_INSTDIR%\applications\pro\customize\config\default.txt file, you can
specify the document type for which the smart container will be displayed:
• Defining the document type
plm.om.DOC.containers.<DocType> =
SMART_CONT(<NAME>);@plm.om.DOC.containers@

55
SAP ECTR interface to PTC Creo - Advanced Configuration

Example
The %PLM_INSTDIR%\applications\pro\template-customize\config\default.txt file
contains samples for the PPR (parts) and PAS (assemblies) document types.
• PPR document type
plm.om.DOC.containers.PPR =
SMART_CONT(MACRO_DRW_PRO);@plm.om.DOC.containers@
• PAS document type
plm.om.DOC.containers.PAS =
SMART_CONT(MACRO_DRW_PRO);@plm.om.DOC.containers@

Preparing the macro

The %PLM_INSTDIR%\applications\pro\customize\scripts\macros folder contains the macro
referenced in the default.txt file using the plm.smart.container.MACRO_DRW_PRO.macro =
PRO:<macro>.txt preference.

Example
The %ECTR_INSTDIR%\applications\pro\template-customize\config\scripts\macros
directory contains the drawings.txt sample macro.

Specifying the smart container name

In the %PLM_INSTDIR%\applications\pro\basis\dictionary\<language
abbreviation>\dictionary.txt file, you can specify the language-specific names of the smart
container:
• Name smart container
plm.smart.container.dic.<DEF. SMART CONTAINER> = <Display Name>

Example
The %PLM_INSTDIR%\applications\pro\basis\dictionary\en\dictionary.txt file contains
a sample:
• plm.smart.container.dic.MACRO_DRW_PRO = drawings

56
SAP ECTR interface to PTC Creo - Advanced Configuration

5.6 Displaying dependent drawings in the Where Referenced

container

In SAP ECTR, the Dependent Documents container displays drawings that depend on the master
document. In addition, dependent drawings can be displayed in the Where Referenced container.

Displaying dependent drawings in the Where Referenced container

Display dependent drawings in the Where Referenced container.

Prerequisite
In order to display dependent drawings in the Where Referenced container, you need to define a
corresponding preference in the default.txt file.

Defining the preference

In the %PLM_INSTDIR%\applications\pro\customize\config\default.txt file, you can
specify that dependent documents will be displayed in the Where Referenced container.
• Defining the preference:
plm.om.docContainer.showAdditionalGeometry = true

57
SAP ECTR interface to PTC Creo - Advanced Configuration

5.7 Defining a Dtype for family tables

Family tables—for parts or assemblies—consist of a generic file and the associated instances. PTC Creo
Parametric creates the family table instances at runtime from the generic file. For all family table
members, including the generic file, a document info record is created. The documents can be linked to
material master records, etc.
For the configuration, the following files are used:
• %PLM_INSTDIR%\customize\config\dtype.xml
• %PLM_INSTDIR%\customize\config\default.txt

Prerequisite
In order to create documents for family tables, the following prerequisites must be met:
• dtype.xml
 The DType for generic files must have been defined.
 The DType for family table instances must have been defined.
• default.txt
 The DType for generic parts and the DType for generic assemblies must have been specified.
 The relations between the DType for generic files and the DType for the associated instances
must have been specified.

5.7.1 DType for generic files

A DType for generic files and for instances must have been defined in the
%PLM_INSTDIR%\customize\config\dtype.xml file.

DType for generic files

The DType for generic files of part family tables must contain the following attribute:
• application_role="PG"
The DType for instances of part family tables must contain the following attribute:
• application_role="PI"
The DType for generic assemblies of assembly family tables must contain the following attribute:
• application_role="AG"
The DType for instances of assembly family tables must contain the following attribute:
• application_role="AI"

Example
For examples, see the dtype.xml file in the %PLM_INSTDIR%\applications\pro\template-
customize\config directory.

58
SAP ECTR interface to PTC Creo - Advanced Configuration

5.7.2 Relation between the DType for generic file and the DType for instances

Define the DType for generic parts and the DType for generic assemblies in the
%PLM_INSTDIR%\customize\config\default.txt file. In addition, define the relation between the
DType for the generic files and the DType for the instances.

DType for generic files

Set the following preference in the default.txt file:
• plm.document.genericDTypes.PRO = <DType Gen. Parts>;<DType Gen. Assembl.>

Preference for generic files

• plm.document.genericDTypes.PRO = PROPG;PROAG

DType relations
In the default.txt file, specify which DType for instances is associated with which DType for generic
files. Set the following preference:
• plm.document.variantDType.<DType Generic File> = <DType Instances>

Examples
A sample file is stored in the following directory:
%PLM_INSTDIR%\applications\pro\template-customize\config (filename: default.txt).
• plm.document.variantDType.PROPG = PROPI
• plm.document.variantDType.PROAG = PROAI

59
SAP ECTR interface to PTC Creo - Advanced Configuration

5.8 Setting the Initial Expansion Level of the Application Structure

With the SAP PLM  ECTR  Show CAD Structure command, you can display CAD structures, e.g.
assemblies, in the SAP ECTR application structure. You can set the initial expansion level in the
default.txt file.

Setting the initial expansion level of the application structure

Do the following to set the initial expansion level of the application structure:
1) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\applications\pro\customize\config\default.txt file.
2) Search for plm.structure.application.init.strategy.levels.pro.
3) Enter the desired initial expansion level as an integer value, e.g.
plm.structure.application.init.strategy.levels.pro = 1.
The CAD structures will be displayed in the application structure using the initial expansion level.

Expanding all levels of the CAD structure

With plm.structure.application.init.strategy.levels.pro = all, you can expand all
levels of the CAD structure.

Expanding more levels of CAD structures

You can expand more levels of CAD structures for which an initial resolution level of 1 or more was
specified.

60
SAP ECTR interface to PTC Creo - Advanced Configuration

5.9 Using Ballooning Functions

SAP ECTR interface to PTC Creo supports you with the creation of BOM balloons in drawings.
The typical procedure includes the following steps:
• Creating an assembly drawing
• Refreshing component parameters using information from the bill of materials
• Adding a table with repeat region to the drawing
• Creating balloons
• Changing the parameters of BOM balloons
The following commands are available in SAP ECTR interface to PTC Creo:
• Refresh Component Parameters
• Add Table

Prerequisite
In order to benefit from the ballooning functions, the following prerequisites must be met:
Configuration of SAP ECTR
• default.txt
 In the default.txt file, the ballooning preferences must have been set.
Configuration of SAP ECTR interface to PTC Creo
• The Refresh Component Parameters and Add Table commands must be available.
• Component parameters
 The names of the component parameters must have been defined.
 The component parameters must have been assigned to the corresponding data type.
Tables
• Table with repeat region
 A table with repeat region must be have been created.
 The repeat region of the table must contain the component parameters.

Ballooning preferences in the default.txt file

Set the following preferences in the %PLM_INSTDIR%\customize\config\default.txt file:
• plm.bom.ballooning.application
• plm.bom.ballooning.alternative
• plm.bom.ballooning.plant
• plm.bom.ballooning.useChangeNoFromDoc
• plm.bom.ballooning.usage

Using values from other preferences

It is possible to use the values of other preferences for your ballooning preferences. See the following
example.

61
SAP ECTR interface to PTC Creo - Advanced Configuration

Ballooning preferences
• plm.bom.ballooning.application = @plm.bom.application@
• plm.bom.ballooning.alternative = @plm.bom.alternative@
• plm.bom.ballooning.plant = @plm.bom.plant@
• plm.bom.ballooning.useChangeNoFromDoc = @plm.bom.useChangeNoFromDoc@
• plm.bom.ballooning.usage = @plm.bom.usage@

Enabling commands
See also: 4.6.4.1 SAP PLM menu and context menu

Defining component parameters

See also: 4.6.7.1 Refresh Component Parameter

Preparing the tables

Save the tables you want to add to a drawing with Add Table in the
%PLM_INSTDIR%\applications\pro\templates directory.

Sample table
The %PLM_INSTDIR%\applications\pro\template_templates directory contains a sample table
named riess_sap_bill_of_material.tbl.

62
SAP ECTR interface to PTC Creo - Advanced Configuration

5.10 Managing User-Defined Features in SAP

The CAD systems from the Pro/ENGINEER family are based on features. Users can build complex
geometry based on multiple features.
If you often need the same combinations of features or features based on complex sketches, you can
create user defined features (UDF) from them. These UDFs are then available as additional features.

5.10.1 UDF in PTC Creo Parametric

UDF file name

For UDF files, the following naming pattern is used: <UDFName>.gph.

Opening a UDF
It is not possible to open a UDF directly from your CAD system. Thus, it is neither possible to directly
import UDFs with the standard import procedure.

Creating UDFs
There are two ways to create a UDF:
• Subordinate option:
Changes made to a UDF source model will affect the UDF and thus all parts using it.
• Stand Alone option:
The UDF is no longer dependent on the UDF source part. However, you can include a copy of the
UDF source model in the definition of the UDF as a reference part and then use the reference
when placing the UDF model.

Reference model file name

The name of the UDF reference model will be assigned by the CAD system. For the file names of UDF
reference models, the following naming pattern is used: <UDFName_gp>.prt.

Using UDFs
There are two ways to use a UDF:
• As a dependent item, with the
Make feature dependent on dimensions of UDF command
• As an independent item, with the
Advanced reference configuration command

63
SAP ECTR interface to PTC Creo - Advanced Configuration

5.10.2 Using UDFs in SAP PLM

UDF document type

It is recommended to assign a separate document type to UDFs. This way, you can define UDF-specific
permissions, status networks, and classifications.

UDF document structures

The following document structures apply to UDFs:
• Stand-alone UDFs, i.e. UDFs defined independently without a UDF reference model do not have a
document structure.
• For UDFs defined as Stand-alone, i.e. that have a UDF reference model, the UDF reference
model is included in the document structure.
• For UDFs defined as Subordinate, the UDF source model is included in the document structure.

Using UDFs in document structures

UDFs used as stand-alone items with the Make feature dependent on dimensions of UDF command
will not be added to the document structure.
In contrast, UDFs used as dependent items with the Advanced reference configuration command will
be added to the document structure.

5.10.3 DType for UDFs and UDF reference models

You need to create DType definitions for UDF files and the associated UDF reference models.

Constraint
A UDF file and the associated UDF reference models or UDF source models form a whole. Once a UDF
file has been created, you may neither rename the UDF file nor its UDF reference model nor its UDF
source model. If you rename the UDF file anyway, the UDF becomes unusable.

Defining a DType for UDFs

Define a DType for the UDF files that specifies that original files will not be renamed.
For this purpose, use the rename_template_filename="no" attribute in the document_create
element.

Defining a DType for UDF reference models

Define a DType for the UDF reference models that specifies that original files will not be renamed.
For this purpose, use the rename_template_filename="no" attribute in the document_create
element.

Defining a DType for the function_group of UDFs

If you want to make UDFs available in the working directory via user-defined options and macros, we
recommend that you use a UDF-specific functional group, such as function_group="PROUF”, in the
function_group attribute of the program_options element in the DType definition for UDF files.

Note
The following instructions describe how you can integrate a user-defined command into the context
menu, based on the function_group within the DType definition. The user-defined command will only
be visible for documents whose DType definition contains the function_group.

Defining a DType for UDF source models

UDF source models of UDFs defined as subordinate do not require a separate DType definition. The UDF
source model, however, must be known as a document in SAP before you can derive a UDF from it.

64
SAP ECTR interface to PTC Creo - Advanced Configuration

Examples
You can find sample DType definitions in the following file:
%PLM_INSTDIR%\applications\pro\template-customize\config\dtype.xml.
• Sample DType definition for UDFs  PROUF DType
• Sample DType definition for UDF reference model  PROPH DType

5.10.4 Adding UDFs to the document structure

Enable the UDF functionality in SAP ECTR interface to PTC Creo as described in section 4.6.5.5, Include
User-Defined Features in Document Structure.

5.10.5 Making UDFs available in the working directory

Before you can use UDFs as features in parts of your design, make sure that the UDF files and the
corresponding reference or source parts have been made available in the working directory. UDFs can
also be made available using a user-defined command in the SAP ECTR context menu.

Prerequisites
Before you can add a user-defined command to the SAP ECTR context menu, the following prerequisites
must be met:
Configuration of SAP ECTR
• dtype.xml
 The DType definition for UDF files, e.g. the definition for PROUF, must contain its own
function_group.
• menu.guidef
 In the menu.guidef file, the + om.popup.menu.DOC.PROUF popup menu must have been
defined for the function_group.
• dictionary.txt
 The language-dependent dictionary.txt files must contain the corresponding descriptions
of the user-defined command.
• standard_icons.txt
 In the standard_icons.txt file, you can assign an icon to the user-defined command.
• pro_udf_fnc_doc_checkout_view.txt
 You must have defined a macro that will be executed via the popup menu.

65
SAP ECTR interface to PTC Creo - Advanced Configuration

Editing the function_group in the UDF DType definition

Do the following to edit the function_group in the UDF DType definition e.g. in PROUF:
1) Open the file %PLM_INSTDIR%\applications\pro\customize\dtype.xml.
2) Add the program_options element with the function_group attribute to the DType definition
for UDF files, e.g. PROUF.
Result: The DType definition for UDF files now has its own function_group.

Example
For examples, see the dtype.xml file in the DType definition PROUF in the
%PLM_INSTDIR%\applications\pro\template-customize\config directory.

Defining a context menu for UDF files

Do the following to define the + om.popup.menu.DOC.PROUF context menu for UDF files in the
menu.guidef file:
1) Open the file %PLM_INSTDIR%\applications\pro\customize\menu.guidef.
2) Add the following entry:
fnc.execute.macro(pro_udf_fnc_doc_checkout_view.txt)
Result: The context menu for UDF files has been defined based on the function_group. The popup
menu shows the pro_udf_fnc_doc_checkout_view.txt function.

Example
For examples, see the menu.guidef file in the %PLM_INSTDIR%\applications\pro\template-
customize\config directory.

Adding descriptions of the user-defined command to the dictionary

Do the following to add descriptions of the user-defined command to the language-dependent
dictionary.txt files:
1) Open the file
%PLM_INSTDIR%\applications\pro\basis\dictionary\en\dictionary.txt.
2) Add the following entry:
fnc.execute.macro(pro_udf_fnc_doc_checkout_view.txt)=Transfer UDF
3) Repeat the above steps for all other desired languages. For example, add the following entry
fnc.execute.macro(pro_udf_fnc_doc_checkout_view.txt)=UDF bereitstellen to
the %PLM_INSTDIR%\applications\pro\basis\dictionary\de\dictionary.txt file for
German.
Result: Language-dependent descriptions are now assigned to the
fnc.execute.macro(pro_udf_fnc_doc_checkout_view.txt) function. The context menu shows
the language-dependent description of the pro_udf_fnc_doc_checkout_view.txt function.

Example
For examples, see the dictionary.txt file
%PLM_INSTDIR%\applications\pro\basis\dictionary\en.

Assigning an icon to the user-defined command

Do the following to assign an icon to the user-defined command:
1) Open the file
%PLM_INSTDIR%\applications\pro\basis\aux-files\standard_icons.txt.
2) Add the following line:
fnc.execute.macro(pro_udf_fnc_doc_checkout_view.txt) =
{0}/sap/download.png
Result: In the context menu, the icon is displayed in front of the language-dependent description of the
pro_udf_fnc_doc_checkout_view.txt function.

66
SAP ECTR interface to PTC Creo - Advanced Configuration

Example
For examples, see the standard_icons.txt file
in the %PLM_INSTDIR%\applications\pro\basis\aux-files directory.

Defining macros
Do the following to define a macro that makes the UDF file, including its reference or source part,
available in the working directory:
1) Create a new macro, e.g. named pro_udf_fnc_doc_checkout_view.txt, and add the
following contents:
k= KEYLIST_FROM_CONTEXT("active","selected")
set1 = CREATE_SET(k)
p = PARAMETER_MAP("doc_filter_fields")
p.DTYPE = "PROPH"
set2 = TRANSFORM_SET_WITH_PARAMETERS( set1, "expand_structure" ,p )
kx = KEYLIST_FROM_SET( set2 )
CALL_OMF("fnc.doc.checkout(view)",kx)
2) Save the pro_udf_fnc_doc_checkout_view.txt file in the
%PLM_INSTDIR%\customize\scripts\macros directory.
Result: The pro_udf_fnc_doc_checkout_view.txt macro can be executed from the context menu
using the Transfer UDF command.

Example
For examples, see the standard_icons.txt file in the
%PLM_INSTDIR%\applications\pro\template-customize\scripts\macros directory.

67
SAP ECTR interface to PTC Creo - Advanced Configuration

5.11 Loading CAD structures—without referenced objects

In some cases, PTC Creo Parametric structures can contain references that are not required to open it in
the CAD system. For example, "external shrink wrap" might represent complex assemblies. Here, the
shrink wrap references the assembly. When loading a structure from SAP, all referenced objects from
SAP will be loaded and loaded into the CAD session in PTC Creo Parametric. If the assembly is large,
this may take a very long time!
In the SAP ECTR, you can define explosion scenarios with explosion rules, allowing you to load
assemblies without external references. You can configure commands for the context menu that use the
explosion scenarios, e.g. when loading files from SAP and opening them in the CAD application.

The config.pro file

In the config.pro configuration file, it is possible to specify how PTC Creo Parametric will handle external
references that are not written to the working directory when you load them from SAP. For this purpose,
you can use the following options:
• retrieve_data_sharing_ref_parts [no* | yes | ignore_missing]
• retrieve_merge_ref_parts [no* | yes | ignore_missing]

Missing references
If you want to use explosion scenarios for a quick loading of CAD structures without external references,
set the retrieve_data_sharing_ref_parts and retrieve_merge_ref_parts options to
ignore_missing or no.

Prerequisite
Before you can add a user-defined command to the SAP ECTR context menu, the following prerequisites
must be met:
Table maintenance
Make sure that the following tables in the SAP system have been maintained properly:
• CDESK_C_EXPLCF
• CDESK_C_EXPLFA
Configuration of the explosion scenario
• The explosion scenario must have been configured in the CAD services.
Configuration of SAP ECTR
• load_scenarios.xml
 The explosion scenario must be combined with the application-specific check-out option.
• menu.guidef and menu_macro.txt
 The application-specific check-out option must have been configured for documents of the PRO
application type.
• customer.txt
 The language-dependent description of the check-out option must have been specified.
• standard_icons.txt
 You can assign an icon to the check-out option.

Procedures
The following instructions apply to the FAST_LOAD explosion scenario. Feel free to define and use other
scenarios, if required.

68
SAP ECTR interface to PTC Creo - Advanced Configuration

Maintaining the CDESK_C_EXPLCF tables

Do the following to maintain the CDESK_C_EXPLCF tables:
1) Use the SM30 transaction to open the Maintain Table Views screen.
2) Maintain the V_CDESK_C_EXPLCF table view.
3) Create entries for the following CAD fields:
 RES4
 SORTF
Result: The CAD fields RES4 for the object type and SORTF for the sort string are maintained and can
be used for the definition of an explosion scenario with explosion rules.

Maintaining the CDESK_C_EXPLFA tables

Do the following to maintain the CDESK_C_EXPLFA tables:
1) Use the SM30 transaction to open the Maintain Table Views screen.
2) Maintain the V_CDESK_C_EXPLFA table view.
3) For example, create entries for the following sort strings:
CAD Field CAD Field Abbreviation Short Description
SORTF PRO:C PTC Creo – Component
SORTF PRO:CA PTC Creo – Interchange Assembly
SORTF PRO:CV PTC Creo - Envelope
SORTF PRO:CS PTC Creo – Component – Suppressed
SORTF PRO:CY PTC Creo – Reference
SORTF PRO:L PTC Creo – Layout –
SORTF PRO:G PTC Creo – Family Table
SORTF PRO:D PTC Creo – Drawing - Model
SORTF PRO:DM PTC Creo – Drawing – Model Main

Table : Sort strings in the CDESK_C_EXPLFA table

Result: The CDESK_C_EXPLFA table is now maintained properly and can be used to define the
explosion scenario with explosion rules.

69
SAP ECTR interface to PTC Creo - Advanced Configuration

Configuring the explosion scenario

Do the following to configure the explosion scenario:
1) Use the CDESK_CUS (ECC) or CAD_SRV_CUS (S4/Hana) transaction to configure the customizing
dialog structure.
2) Under Group Maintenance, create the DEFAULT group for your PROE CAD system.
3) Specify the group users or roles.
4) Under Explosion Scenario, create the FAST_LOAD explosion scenario for the DEFAULT group and
add a short description.
5) Under Explosion Rules, specify the explosion rules for the FAST_LOAD explosion scenario.
CAD Field CAD Field Abbreviation Expl. Bhr.
SORTF PRO:C NA: …
SORTF PRO:CA ST: …
SORTF PRO:CV NA: …
SORTF PRO:CS ST: …
SORTF PRO:CZ NA: …
SORTF PRO:CY ST: …
SORTF PRO:CE ST: …
SORTF PRO:CN NA: …
SORTF PRO:L NA: …
SORTF PRO:G NA: …
SORTF PRO:D NA: …
SORTF PRO:DM NA: …

Table: Explosion rules for the FAST_LOAD explosion scenario

Result: The FAST_LOAD explosion scenario is defined and ready for use.

70
SAP ECTR interface to PTC Creo - Advanced Configuration

Combining the explosion scenario with the application-specific check-out option

Do the following to combine the explosion scenario with the application-specific check-out option:
1) Use a text editor, e.g. Notepad++, to create
the%PLM_INSTDIR%\applications\pro\customize\config\load_scenarios.xml file.
2) Add the following lines:
<document_load_scenarios
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
xsi:noNamespaceSchemaLocation="../../../../basis/aux-files/load-
scenarios.xsd">
<document_load_scenario>
<name>PRO_FAST_LOAD</name>
<description>FAST_LOAD_Without_References</description>
<application_type>PRO</application_type>
<bod_explosion
<explosion_scenario>FAST_LOAD</explosion_scenario>
<explosion_rule>
<active/>
</explosion_rule>
</bod_explosion>
</document_load_scenario>
</document_load_scenarios>

Result: The FAST_LOAD explosion scenario is now combined with the PRO_FAST_LOAD check-out
option. The check-out option can be integrated into the context menu of the SAP ECTR.

Example
For examples, see the load_scenarios.xml file in the
%PLM_INSTDIR%\applications\pro\template-customize\config directory.

Configuring an application-specific check-out option for the PRO application type

Do the following to add the PRO_FAST_LOAD check-out option, e.g., to the context menu (flyout) for
documents of the PRO application type:
1) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\applications\pro\customize\config\menu.guidef file.
2) Add the
= ? DOC_DOC_PRORIESS
entry under + om.popup.menu.DOC.PROFG.
3) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\applications\pro\customize\config\menu_macros.txt file.
4) Add the entry
? DOC_DOC_PRORIESS = mnu.flyout.doc_doc_riess.
5) At ? DOC_DOC_PRORIESS, add the entry
= fnc.doc.open.by.load.scenario(PRO_FAST_LOAD).
Result: The fnc.doc.open.by.load.scenario(PRO_FAST_LOAD) check-out option is now
displayed in the context menu.

Example
For examples, see the files menu.guidef and menu_macros.txt in the
%PLM_INSTDIR%\applications\pro\template-customize\config directory.

71
SAP ECTR interface to PTC Creo - Advanced Configuration

Specifying language-dependent descriptions of the check-out option

Do the following to specify language-dependent descriptions of the check-out option:
1) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\customize\dictionary\en\customer.txt file.
2) Add the following line:
mnu.flyout.doc_doc_riess=PTC Creo Parametric Originals
3) Add the following line:
fnc.doc.open.by.load.scenario(PRO_FAST_LOAD)= Open original without
references
4) Repeat these steps for other CAD environments.
Result: Instead of the fnc.doc.open.by.load.scenario(PRO_FAST_LOAD) check-out option, the
context menu displays the language-dependent description.

Assigning an icon to the check-out option

Do the following to assign an icon to the check-out option:
1) Use a text editor, e.g. Notepad++, to open the
%PLM_INSTDIR%\applications\pro\basis\aux-files\standard_icons.txt file.
2) Add the following line:
fnc.doc.open.by.load.scenario(PRO_FAST_LOAD) = {0}/sap/parts_partial.png.
Result: The language-dependent description of the check-out option is displayed together with the
icon.

Example
For examples, see the standard_icons.txt file
in the %PLM_INSTDIR%\applications\pro\basis\aux-files directory.

72
SAP ECTR interface to PTC Creo - Using the Menu and Commands

This section describes how to display the SAP PLM menu in PTC
Creo Parametric and explains which commands can be executed
from the SAP PLM menu.

6 Using the Menu and Commands

There are several places in PTC Creo Parametric where the SAP PLM menu for SAP ECTR interface to
PTC Creo is displayed:
• In the TOOLKIT group on the Tools tab of the ribbon
• In the Model tree context menu
• In the application structure of the SAP ECTR
Optionally, the SAP PLM menu can be displayed in the following user-defined locations:
• On the quick access toolbar
• On a user-defined tab of the ribbon
• On the Common tab of the ribbon

Command Scope
Commands can be selected from the TOOLKIT group on the Tools tab of the SAP PLM menu or from
the model tree context menu. Depending on where the command was selected, the scope of the
command is different: it either applies to files or to originals.

73
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.1 Displaying the SAP PLM Menu

6.1.1 SAP PLM Menu as a TOOLKIT Tool

The SAP PLM menu is accessible from the TOOLKIT group on the Tools tab of the ribbon.

Figure: SAP PLM Menu as a TOOLKIT Tool

Modules without ribbon

The SAP PLM menu is available on the Tools tab in nearly all PTC Creo Parametric modes.
In some PTC Creo Parametric modules, there is no ribbon (e.g. REPORT, DIAGRAM). Here, the SAP
PLM menu is directly integrated with the menu bar.

Obsolete modules
By default, modules that do not have a ribbon (e.g. REPORT, DIAGRAM) are no longer available in PTC
Creo Parametric 4.0. To re-enable them for PTC Creo Parametric 4.0, edit the config.pro file and set
the enable_obsolete_modes option to yes.

74
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.1.2 SAP PLM menu in the model tree context menu

In each mode, the SAP PLM menu is embedded automatically into the model tree context menu (right
mouse button).

Figure: SAP PLM menu in the model tree context menu

6.1.3 SAP PLM menu in the application structure

A selection of commands from the SAP PLM menu is also accessible from the context menu of the SAP
ECTR Application Structure.

75
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.1.4 SAP PLM menu on the quick access toolbar

You can customize the SAP PLM menu to add it to the quick access toolbar.

Figure: SAP PLM menu on the quick access toolbar

6.1.5 User-defined tab with the SAP PLM menu

The commands from the SAP PLM menu can be displayed on a user-defined tab of the ribbon.

Figure: Commands from the SAP PLM menu in a user-defined tab

Configuring a user-defined tab

You can configure a user-defined SAP PLM tab. For each PTC Creo Parametric mode, you can create
individual user-defined tabs. On the user-defined tab, the commands may be arranged in a different order
than in the SAP PLM menu.

6.1.6 SAP PLM menu in the Common tab

In PTC Creo Parametric 4.0 or higher, it is possible to display the commands from the SAP PLM menu in
the Common tab of the ribbon.

Figure: Commands from the SAP PLM menu in the Common tab

76
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.2 Scope of Commands Selected from the SAP PLM Menu

Depending on whether you select a command from the SAP PLM menu or from the SAP PLM context
menu, it applies to different files or originals.
Commands selected from the SAP PLM menu apply to the current or active files or originals.
Commands selected from the SAP PLM context menu apply to the files or originals selected in the model
tree.

6.2.1 Scope of commands: current or active original

You can activate assembly components in the model tree. The active component is highlighted in the
model tree by a special icon. The commands you select from the SAP PLM menu on the Tools tab or
from the quick access toolbar always apply to the active component. If no component is active, the
command applies to the file currently open in the graphics window.

6.2.2 Scope of commands: model tree context menu

You can select components in the PTC Creo Parametric model tree. The commands selected from the
SAP PLM model tree context menu apply to the components you selected in the model tree.

6.2.3 Scope of commands: application structure context menu

In the application structure, you can select files without a document or originals with a document.
Commands selected from the context menu of the application structure apply to the files or originals
selected in the application structure.

6.2.4 Scope of commands: user-defined tab

The user-defined tabs may contain commands from the SAP PLM menu and from the SAP PLM context
menu. Depending on its origin, the command will either apply to the current or active file or original or to
the selected component.

Creating a user-defined tab

Only add commands from the SAP PLM menu to user-defined tabs. This way, you can make sure that
the commands from the user-defined tab apply to the same scope as the commands from the SAP PLM
menu on the Tools tab.

Context menu
Commands selected from the SAP PLM menu always apply to the current or active file or original. The
SAP PLM context menu only applies to the components selected in the model tree.

77
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.2.5 Files without document or material

Files without a document can only be displayed in the application structure or imported to SAP.
If a command cannot be executed because there is no document yet, a corresponding message is
displayed for the selected command.
File without document! Action can not be executed

If a document exists for an original, but there is no material assignment, you can assign materials to it.
Commands that affect assigned materials or bills of materials cannot be executed if no material has been
assigned.
If a command cannot be executed because no material has been assigned yet, a corresponding message
is displayed for the that command.
Document without material assignment! Action can not be executed

6.2.6 Including originals in the document structure of the scope

The scope of some commands can be extended to include further originals in the document structure.
If there are further originals in the document structure that can be included in the command scope, a
corresponding option ( checkbox) is displayed when you select the command.
 Include all <…> in the document structure

6.2.7 Removing originals in memory from the scope

The scope of some commands could affect other originals that are in memory, but this is not intended and
could lead to data inconsistencies.
If a command affects other originals in memory and this is not intended, remove all other originals from
memory.
A corresponding message is displayed for the selected command.
All originals will be removed from memory

6.2.8 Alternative effects on the scope

Some commands can have alternative effects on the files or originals in the scope.
If a command has alternative effects on the files or originals in its scope, the alternatives are suggested
with  radio buttons when you execute the command.

78
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3 SAP PLM Menu Commands

The SAP PLM menu contains the following submenus:

• ECTR
• Original
• Document
• Additional Functions

6.3.1 ECTR menu commands

The ECTR menu contains commands related to SAP ECTR.

• Open ECTR
• Show CAD Structure

6.3.1.1 Open ECTR

When to use
Use this command when, while working in PTC Creo Parametric, you want to bring SAP ECTR to the
front and display information about the various documents, materials, etc.

Tool tip
Open SAP Engineering Control Center.

How to use
Do the following to open SAP ECTR from within the CAD system:
1) Click SAP PLM  ECTR  Open ECTR.
Result: SAP ECTR is launched and its window is brought to the front. The PTC Creo Parametric CAD
system remains active.

6.3.1.2 Show CAD Structure

When to use
Use this command when, while working in PTC Creo Parametric, you want to display the CAD file from
the active graphics window in the SAP ECTR application structure. A selection of commands from the
SAP PLM menu is also accessible from the context menu of SAP ECTR Application Structure, such as
Import, Save, and Edit.

Tool tip
Show CAD structure.

How to use
Do the following to display the CAD structure, for example of an assembly, in the SAP ECTR application
structure.
1) Click SAP PLM ECTR  Show CAD Structure.
Result: The CAD structure, for example of an assembly, is displayed in the SAP ECTR application
structure.

79
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2 Original menu commands

The Original menu groups commands related to files or originals (files with document info records).
• New
• Open
• Save
• Edit
• Save and Display
• Save as 
 Save as New Version
 Save as New Document
• Refresh 
 Refresh Originals
 Refresh Attributes
• Cancel
• Import
• Add Component
• Add Format
• Replace Version

80
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.1 New

When to use
Use this command when, while working in PTC Creo Parametric, you want to create a new document
(document info record and original) and then edit the new original.

Tool tip
Create a new original and document in SAP PLM and Open the original in CAD.

How to use
Do the following to create a new original and its associated document info record:
1) Click SAP PLM  Original  New.
2) In the SAP ECTR dialog, select the desired DType and the desired template.
3) Specify all required settings in the SAP ECTR dialog.
4) Click OK to create a new original and document info record.
Result: A new document (original and associated document info record) is created. The document is
displayed in SAP ECTR in the active folder. The new original is opened in PTC Creo Parametric where
you can edit it ( ).

Document type and start model

By selecting the desired DType and template, you can define properties such as the document type of the
new original and the CAD start model, e.g. a start part or a start assembly.

Active folder
In SAP ECTR, the new document will be displayed in the active folder and flagged with a dirty flag (
) because e.g. its attributes have not been refreshed yet.

6.3.2.2 Open

When to use
Use this command when, while working in PTC Creo Parametric, you want to search for an existing
document (document info record and original) in SAP PLM and then open the original directly from within
PTC Creo Parametric. As an alternative, you can run the document search from the SAP GUI.

Tool tip
Load an original from SAP PLM and open it in CAD.

How to use
Do the following to search for an original in SAP and open it in the CAD system:
1) Click SAP PLM  Original  Open.
2) Specify your search criteria in the SAP ECTR dialog.
3) In the SAP ECTR dialog, click OK.
4) From the results displayed in the SAP ECTR dialog, select the desired documents.
5) In the SAP ECTR dialog, click OK.
Result: The originals of the selected documents are available in the session directory and are opened in
the CAD system.

81
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.3 Save

When to use
Use this command when, while working in PTC Creo Parametric, you want to save an intermediate state
of an original in SAP PLM and then continue your work on the original in PTC Creo Parametric.

Tool tip
Save original to SAP PLM and continue editing the original in CAD.

How to use
Do the following to save an original to SAP and continue working in edit mode:
1) Click SAP PLM  Original  Save.
2) Add locally changed originals to the Save list using the Save dialog or ignore originals that have
been changed locally.
3) Click Save to save your originals.
Result: The new original is saved in SAP where you can edit it ( ).

Dirty flag
If the document has been flagged with a dirty flag ( ), the dirty flag will be removed.

Prerequisite for saving

You can only save originals to SAP that are currently being edited in SAP ( ).

Saving locally changed originals

Locally changed originals are originals that have only been edited in the CAD system but not in SAP ( ).
If the document structure of the original to be saved includes originals that are being edited in SAP ( ),
they will also be saved automatically. Originals that have only been changed locally cannot be saved.
The Save dialog opens.
You can add locally changed originals to the Save list by clicking Edit or exclude them from saving by
clicking in the  Ignore <x> modified originals column. Ignored originals are not checked in to SAP
when saving.
The Save button is only available after you have edited or ignored all locally changed originals.

Saving originals with files without a document in the structure

Originals cannot be saved if they reference a file without a document. In this case, the Save dialog
displays a conflict message.

File without document in structure

To solve the conflict, click Import.

82
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.4 Edit

When to use
Use this command when, while working in PTC Creo Parametric, you want to edit a displayed original in
SAP PLM.

Tool tip
Request an exclusive lock in order to edit the original in CAD.

How to use
Do the following to edit an original in SAP:
1) Click SAP PLM  Original  Edit.
Result: The original is in SAP edit mode ( ).

Dirty flag
If the document has been flagged with a dirty flag ( ), the dirty flag will be removed.

6.3.2.5 Save and Display

When to use
Use this command when, while working in PTC Creo Parametric, you want to save an original in SAP
PLM and then stop working on that original in PTC Creo Parametric.

Tool tip
Save and unlock original in SAP PLM. Enables other users to edit the original in CAD.

How to use
Do the following to save an original to SAP and change from edit mode to display mode:
1) Click SAP PLM  Original  Save and Display.
2) Add locally changed originals to the Save list using the Save dialog or ignore originals that have
been changed locally.
3) Click Save and Display to save the originals.
Result: This saves the original to SAP, which is no longer in edit mode ( ). The saved originals in the
structure are no longer in edit mode either ( ).

Dirty flag
If the document has been flagged with a dirty flag ( ), the dirty flag will be removed.

Locally changed originals and files without a document

For locally changed originals, originals with files without a document in the structure, and for files without
a document, the Save and Display behaves like the Save command.

83
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.6 Save as New Version

When to use
Use this command when, while working in PTC Creo Parametric, you want to create a new document
version for an original.
If the document for which you want to create the new version has been edited ( ), the changes will be
applied to the new version of the original. The original of the initial version will be reset to the version last
checked in ( ). This means that the initial original remains in SAP PLM as checked in the last time.
If dependent documents exist for the document, new versions will be created for the dependent
documents as well, provided the system has been configured accordingly.

Tool tip
Save original as new document version in SAP PLM.

How to use
Do the following to save an original as a new version in SAP:
1) Click SAP PLM  Original  Save as New Version.
2) In the SAP ECTR dialog, click Yes.
Result: A new document version of the original is created. The original of the new document version is
checked in to SAP ( ) and is loaded in PTC Creo Parametric.

6.3.2.7 Save as New Document

When to use
Use this command when, while working in PTC Creo Parametric, you want to create a new document and
a new original. The initial original is copied and then renamed according to the applicable rules.
If the original for which you want to create the new document has been edited ( ), the changes will be
applied to the new original. The original of the initial document will be reset to the one last checked in ( ).
This means that the initial original remains in SAP PLM as checked in the last time.

Tool tip
Save original as new document in SAP PLM.

How to use
Do the following to save a document (original and document info record) as a new document in SAP:
1) Click SAP PLM  Original  Save as New Document.
2) Edit the settings in the SAP ECTR dialog, if required.
3) In the SAP ECTR dialog, click OK.
Result: The new document is saved. The new original is checked in to SAP ( ) and is loaded in PTC
Creo Parametric.

84
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.8 Refresh Originals

When to use
Use this command when, while working in PTC Creo Parametric, you want to load the current state of an
original from SAP PLM. This command is e.g. helpful in cases where your assembly uses components
which are obsolete because another user changed them. With this command, you can only replace
originals of the same document version.

Tool tip
Retrieve originals modified by other users from SAP PLM and replace in CAD session.

How to use
Replace originals changed by other users in the CAD system.
1) Click SAP PLM  Original  Refresh Originals.
2) Click Remove to remove all originals from memory.
Result: The original changed by another user is now open in the CAD system.

6.3.2.9 Refresh Attributes

When to use
Use this command when, while working in PTC Creo Parametric, you want to refresh the attributes of an
original from SAP PLM.

Tool tip
Refresh attributes of original in CAD from SAP PLM.

How to use
Do the following to refresh the attributes:
1) Click SAP PLM  Original  Refresh Attributes.
2) Add all originals in the document structure to the scope of this command ( checkbox), if
applicable.
3) Click Continue.
Result: The parameters in the original and in the SAP object fields (e.g. document, material) are
refreshed.

Detailed information
For further details on how to configure SAP ECTR, please refer to the SAP ECTR documentation.

Configuration
Depending on the configuration specified in the attributes-from-sap.xml and attributes-to-
sap.xml files, the attributes from SAP fields are transferred to the CAD parameters or vice versa.

Syntax of the configuration files

In the APPL_ATTRIBUTE element, identify system parameters by the PROPROP: prefix and user-defined
parameters by the PROPARAM: prefix.

Examples
Examples can be found in the files named attributes-from-sap.xml and attributes-to-
sap.xml under the %PLM_INSTDIR%\applications\pro\template-customize\config
directory.

System parameters
System parameters can only be transferred from PTC Creo Parametric to the SAP system.

85
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.10 Cancel

When to use
Use this command when, while working in PTC Creo Parametric, you want to discard edits made to an
original from the memory and the working directory and then retrieve the state last checked in to SAP
PLM.

Tool tip
Cancel edit and discard work.

How to use
Do the following to cancel editing the original and reload the original from SAP:
1) Click SAP PLM  Original  Cancel.
2) Select the desired effect of the command (option with  radio button).
3) Add all originals in the document structure to the scope of this command ( checkbox), if
applicable.
4) Click Continue.
5) Click Remove to remove all originals from memory.
6) Open the closed originals that use the original directly in PTC Creo Parametric by selecting File 
Open.
Result: Edit mode in SAP PLM has been canceled. The original has been replaced by the state last saved
for this version in SAP.

Options
The  Close original in CAD option loads the original from SAP PLM without opening it in the CAD
system.
The  Reload original from SAP system option loads the original from SAP PLM and opens it in the
CAD system.

86
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.11 Import

When to use
Use this command when, while working in PTC Creo Parametric, you want to import existing CAD files to
SAP PLM.

Tool tip
Import CAD files from session into new documents in SAP PLM.

How to use
Do the following to create documents and import the associated originals from the CAD system to SAP:
1) Create a new file or open a file.
2) Click SAP PLM  Original  Import.
3) Note the import scope in the Import dialog.
4) Use Identify Relations and Identify References to identify other files that also need to be
imported.
5) Add the files you determined to the import scope.
6) Import the files listed in the import scope by clicking Import.
7) In the SAP ECTR dialog, confirm the import by clicking OK.
Result: The files are imported to SAP and the originals are displayed in the CAD system ( ).

Identifying relations and references

Usually, files are renamed when they are imported to SAP, provided the system has been configured
accordingly. Files and originals that use renamed files must have been loaded into the CAD system
memory. This is the only way to ensure that these originals know the new names of the referenced files.
For this reason, make sure to identify the relations and references before performing the import. Add the
files you determined to the import scope.
Click Identify Relations to load the files into memory and to determine their relations to the files in the
import scope. Click Identify References to identify the files that reference files in the import scope.

Using help information

For this dialog, help information is available.
Click Help to display explanations of the icons in the Identify further files for Import dialog.

87
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.12 Add Component

When to use
Use this command when, while working in PTC Creo Parametric, you want to add components from SAP
PLM to your assembly.

Tool tip
Load an original from SAP PLM and add it to the current CAD assembly.

How to use
Do the following to search for a component in SAP and insert it into an assembly:
1) Open an assembly.
2) Click SAP PLM  Original  Add Component.
3) Use the SAP ECTR dialog to search for the component via its document or material or using the
search options displayed there.
4) Place the component in the assembly.
Result: The component is now included in the assembly.

6.3.2.13 Add Format

When to use
Use this command when, while working in PTC Creo Parametricyou want to add a drawing format from
SAP PLM to your drawing.

Tool tip
Select drawing format in SAP and add to drawing.

How to use
Do the following to select a drawing format in SAP and add it to the drawing:
1) Open a drawing.
2) Click SAP PLM  Original  Add Format.
3) Select the desired format from the SAP ECTR dialog.
Result: This adds the format to the drawing and updates the associated attributes.

Drawing and/or represented model without a document

If no document exists for a drawing and/or represented model, the attributes will not or only partly be
refreshed.

88
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.2.14 Replace Version

When to use
Use this command when, while working in PTC Creo Parametric, you want to load the current version of
an original from SAP PLM. For example, this command can be used if you use components in your
assembly for which newer versions ( | ) exist. This command can only be used to replace originals of
other document versions.

Tool tip
Replace original in CAD with original of a different document version from SAP PLM.

How to use
Do the following to replace an original in the CAD system with an original of another document version
from SAP.
1) Click SAP PLM  Original  Replace version.
2) Click Remove to remove all originals from memory.
3) Select the desired version in the SAP ECTR dialog.
4) Confirm your selection by clicking OK.
Result: The original in the CAD system has been replaced with an original of another document version.

89
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.3 Document menu commands

The Document menu groups commands related to documents.

• Display Document
• Add to Object List
• Dependent Document 
 Open Original of Dependent Document
 Create Dependent Document

6.3.3.1 Display Document

When to use
Use this command when, while working in PTC Creo Parametric, you want to display and, possibly edit,
the document of the current original in the Object Browser of SAP ECTR.

Tool tip
Display document of current original.

How to use
Do the following to display the document associated with an original:
1) Click SAP PLM  Document  Display Document.
Result: The document associated with the original is displayed in the Object Browser of SAP ECTR.

6.3.3.2 Add to Object List

When to use
Use this command when, while working in PTC Creo Parametric, you want to add the document
associated with the current original to an existing or new object list. Object lists are helpful if you want to
collect and edit several documents jointly, e.g. to change their document status.

Tool tip
Add document of current original to an object list of SAP Engineering Control Center.

How to use
Do the following to add the document associated with the current original to an object list of SAP ECTR.
1) Click SAP PLM  Document  Add to Object List.
2) In the SAP ECTR dialog, select an object list or create a new one.
3) Select the desired option in the SAP ECTR dialog.
Result: The document has been added to the object list.

Temporary object lists

When you exit SAP ECTR, all object lists created during the session will be deleted. They will no longer
be available in a new session.

90
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.3.3 Open Original of Dependent Document

When to use
Use this command when, while working in PTC Creo Parametric, you want to open the original of a
dependent document. If a dependent drawing document exists for the document associated with the
current original, e.g. a part, you can open the dependent drawing directly from SAP PLM in PTC Creo
Parametric.

Tool tip
Open original of dependent document from SAP PLM (e.g. open a drawing for a part).

How to use
Do the following to open the original of the dependent document from SAP PLM:
1) Open a part or an assembly for which a dependent document exists.
2) Click SAP PLM  Document  Open Original of Dependent Document.
Result: The original of the dependent document is loaded from SAP PLM and is opened in the CAD
system.

6.3.3.4 Create Dependent Document

When to use
Use this command when, while working in PTC Creo Parametric, you want to create a drawing document
that depends on the document associated with the current original. Depending on the configuration of
your system, dependent documents follow the master document and can only be versioned together with
their master document.

Tool tip
Create a new original and document as dependent document of the current original (e.g. create a drawing
with document for a part) in SAP PLM.

How to use
Do the following to create a new original and a document as a dependent document of the current
original:
1) Open a part or assembly for which a dependent document exists.
2) Click SAP PLM  Document  Dependent Document  Create Dependent Document.
3) Specify all required settings in the SAP ECTR dialog.
4) In the SAP ECTR dialog, select the desired DType and the desired template.
5) Click OK to create a new original with its document info record.
Result: A new dependent document (original with its document info record) has been created. In SAP
ECTR, the document is displayed in the active folder in the Dependent Documents container. The new
original is opened in PTC Creo Parametric where you can edit it ( ). In the SAP ECTR, the indicates
that dependent documents of this document exist.

91
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4 Commands in the Additional Functions menu

The Additional Functions menu groups commands related to material master records, bills of materials,
settings, and some extra features.
• Bill of Material 
 Create Bill of Material
 Display Bill of Material
 Edit Bill of Material
• Material 
 Assign Material
 Display Material
• Settings 
 Settings
 Trace Level
• Extras 
 Cancel Edit
 Import UDF
 Initialize Parameters
 Open Log Directory
 Open Working Directory
 Delete old versions
• Info

• Ballooning
 Add Table

 Refresh Component Parameters

Flagging a material as exclusive

You can flag a material link as exclusive. If the document associated with the original is linked to multiple
materials, the commands from the Bill of Material and Material menus apply to the material flagged in
SAP ECTR as exclusive. If no material was flagged, the commands will apply to the first material listed in
the material links list of the document.

92
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.1 Create Bill of Material

When to use
Use this command when, while working in PTC Creo Parametric, you want to create a bill of materials for
the current original.

Tool tip
Create a new bill of material in SAP PLM according to the structure of the current CAD assembly.

How to use
Do the following to create a bill of materials for the material associated with the original:
1) Click SAP PLM  Additional Functions  Bill of Material  Create Bill of Material.
2) Create the bill of materials.
Result: This creates the bill of materials for the material associated with the original.

Document structure and bill of materials

The bill of materials is derived from the document structure.

Saving a document before creating the bill of materials

Before creating or editing a bill of materials, save the originals with Save or Save & Display. The
document structure will be updated when you save the document.

6.3.4.2 Display Bill of Material

When to use
Use this command when, while working in PTC Creo Parametric, you want to display the bill of materials
for the current original in the Bills of Material window of SAP ECTR.

Tool tip
Display the bill of material that is assigned to the document of the current original.

How to use
Do the following to display a bill of materials for the material associated with the original:
1) Click SAP PLM  Additional Functions  Bill of Material  Display Bill of Material.
Result: The bill of materials is displayed in SAP ECTR.

93
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.3 Edit Bill of Material

When to use
Use this command when, while working in PTC Creo Parametric, you want to edit a bill of materials for
the current original, e.g. in case the document structure was changed and you want to update the existing
bill of materials. The bill of materials, e.g. the quantities specified, will be updated based on the document
structure.

Tool tip
Edit the bill of material that is assigned to the document of the current original.

How to use
Do the following to edit a bill of materials for the material associated with the original:
1) Click SAP PLM  Additional Functions  Bill of Material  Edit Bill of Material.
Result: This completes the editing of the bill of materials for the material associated with the original.

6.3.4.4 Assign Material

When to use
Use this command when, while working in PTC Creo Parametric, you want to assign a material existing in
SAP PLM to the document associated with the current original. SAP ECTR indicates that the document is
linked to one or more materials. If multiple materials are linked, you can flag one of the material links as
the exclusive material link.
Existing material links
Icon / Overlay Meaning
A material link exists.

Multiple material links exist.

No material link has been flagged as exclusive yet.

Table: Icon and overlays for material links

Tool tip
Assign an existing material from SAP PLM to the document of the current original.

How to use
Do the following to assign a material to the document associated with the original:
1) Click SAP PLM  Additional Functions  Material  Assign Material.
2) Search for the desired material in the SAP ECTR dialog.
3) Confirm your selection by clicking OK.
Result: This links the material to the document associated with the original.

Assigning multiple materials

Using Assign Material, it is possible to link multiple materials to the document associated with the
original one after the other.

94
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.5 Display Material

When to use
Use this command when, while working in PTC Creo Parametric, you want to display or edit the material
associated with the current original.

Tool tip
Display the material that is assigned to the document of the current original.

How to use
Do the following to display the material linked to an original:
1) Click SAP PLM  Additional Functions  Material  Display Material.
Result: The material is displayed in the Object Browser of SAP ECTR.

6.3.4.6 Settings

When to use
Use this command when, while working in PTC Creo Parametric, you want to change the SAP ECTR
interface to PTC Creo settings.

Tool tip
Settings for SAP ECTR interface to PTC Creo.

How to use
Configure SAP ECTR interface to PTC Creo.
1) Click SAP PLM  Additional Functions  Settings  Settings.
2) Make the desired settings.
3) Click Next or Back to go to the next or previous page and specify other missing settings.
4) Click Save to complete the configuration.
Result: The SAP ECTR interface to PTC Creo is now fully configured and the settings are saved.

Closing the configuration dialog without saving

Click to close the configuration dialog without saving your edits.

95
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.7 Trace Level

When to use
Use this command when, while working in PTC Creo Parametric, you want to change the trace level of
the log files for SAP ECTR interface to PTC Creo at runtime.

Tool tip
Set Trace Level of SAP ECTR interface to PTC Creo.

How to use
Set the trace level of SAP ECTR interface to PTC Creo.
1) Click SAP PLM  Additional Functions  Settings  Trace Level.
2) Select the desired trace level ( radio button).
3) Confirm your selection by clicking OK.
Result: The trace level of SAP ECTR interface to PTC Creo has been set.

6.3.4.8 Cancel Edit

When to use
Use this command when, while working in PTC Creo Parametric, you want to cancel editing a CAD
original without discarding the local changes.

Tool tip
Release exclusive lock without discarding local changes of the original.

How to use
Do the following to cancel editing the original without discarding local changes made to the original:
1) Click SAP PLM  Additional Functions  Extras  Cancel Edit.
2) Add all locked originals in the document structure to the scope of this command ( checkbox), if
applicable.
3) Click Continue.
Result: Editing in SAP has been canceled, but local changes made to the original have not been
discarded.

96
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.9 Import UDF

It is not possible to open UDF files (*.gph) directly in PTC Creo Parametric. This means that you cannot
import UDF files from PTC Creo Parametric to SAP. However, UDF files from the working directory can
be imported.

When to use
Use this command when you want to import existing CAD files to SAP PLM from the working directory.

Tool tip
Import UDF files into new documents in SAP PLM.

How to use
Do the following to create documents for the UDF files and import the associated originals from the CAD
system to SAP:
1) Click SAP PLM  Additional Functions  Extras  Import UDF.
2) In the Import UDF dialog, select the UDF files to be imported.
3) Click Continue.
4) Import the files listed in the import scope by clicking Import.
5) In the SAP ECTR dialog, confirm the import by clicking OK.
Result: The UDF files are imported to SAP and the originals are displayed in the CAD system ( ).

Using UDFs
UDFs checked in to SAP an only be used if they have been saved to the working directory before. Define
a search query for the UDFs in the SAP ECTR. Select the desired UDFs including their associated
reference or source parts and then click Document  Transfer Original(s) from the context menu.

Making UDFs available in the working directory via a user-defined command

UDFs can also be made available via a user-defined command that has been added to the SAP ECTR
context menu. For more details, please refer to section 5.10.5, Making UDFs available in the working
directory.

UDF source parts

The UDF geometry is defined in the UDF source part. UDFs that have been created with the
Subordinate option depend on their UDF source part. If you rename the UDF source part after defining
the UDF, the latter can no longer be used. For this reason, SAP ECTR interface to PTC Creo will check
whether SAP already knows the UDF source part. Originals known in SAP are usually not renamed.
File without document! Action can not be executed

UDF reference parts

The UDF geometry is defined in the UDF source part. UDFs that have been created with the Stand
Alone option do not depend on their UDF source part. However, you can include a copy of the UDF
source model in the definition of the UDF as a reference part and then use the reference when placing
the UDF model. Just like the UDF source part, the UDF reference part may no longer be renamed after
creation of the UDF. For this reason, SAP ECTR interface to PTC Creo uses a DType for UDF reference
parts that will not rename originals when creating documents.

UDF reference model file name

The name of the UDF reference model will be assigned by the CAD system. For the file names of UDF
reference models, the following naming pattern is used: <UDFName_gp>.prt.

97
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.10 Initialize Parameters

When to use
Use this command when, while working in PTC Creo Parametric, you want to add and initialize missing
parameters of an original. Using this command, you can e.g. add new parameters to CAD originals that
have been migrated from legacy systems. The new parameters can be initialized using the specified initial
value.

Tool tip
Create missing parameters with initial value.

How to use
Do the following to create missing parameters in CAD files and initialize the parameters using predefined
values:
1) Click SAP PLM  Additional Functions  Extras  Initialize Parameters.
2) Add all originals in the document structure to the scope of this command ( checkbox), if
applicable.
3) Click Continue.
Result: The parameters have been created and initialized in the CAD file.

Configuration
You can configure the command Initialize Parameters by selecting SAP PLM  Additional Functions
 Settings  Settings. You can configure whether missing parameters in the model or drawing will be
initialized using the specified initial value.

6.3.4.11 Open Log Directory

When to use
Use this command when, while working in PTC Creo Parametric, you want to open the log directory of
SAP ECTR interface to PTC Creo.
The log files for SAP ECTR interface to PTC Creo are stored in the
C:\Users\<USERNAME>\.riess\SAPInterface log directory. These files might be required when
you request support.

Tool tip
Open log directory of SAP ECTR interface to PTC Creo.

How to use
Open the SAP ECTR interface to PTC Creo log directory in the Explorer.
1) Click SAP PLM  Additional Functions  Extras  Open Log Directory.
Result: This opens the SAP ECTR interface to PTC Creo log directory in the Explorer.

98
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.12 Open Working Directory

When to use
Use this command when, while working in PTC Creo Parametric, you want to open the working directory
of SAP ECTR interface to PTC Creo.

Tool tip
Open working directory of SAP ECTR.

How to use
Open the SAP ECTR interface to PTC Creo working directory in the Explorer.
1) Click SAP PLM  Additional Functions  Extras  Open Working Directory.
Result: This opens the SAP ECTR interface to PTC Creo working directory in the Explorer.

6.3.4.13 Delete old versions

When to use
Use this command when, while working in PTC Creo Parametric, you want to delete the saved versions
from the SAP ECTR interface to PTC Creo working directory. Each time you save a version in PTC Creo
Parametric the saved version is incremented in the working directory, e.g. prt0001.prt.1 
prt0001.prt.2.

Tool tip
Delete old versions (e.g. *.prt.1 - *.prt.n) from working directory.

How to use
Do the following to delete old versions (e.g. *.prt.1 - *.prt.n) from the working directory. These are created
each time you save a part in PTC Creo Parametric.
1) Click SAP PLM  Extras  Delete old versions.
Result: The old versions that were created when saving in PTC Creo Parametric are deleted.

Automatically deleting versions that were created by saving

You can automatically delete versions that were created by saving in PTC Creo Parametric. To do so,
use the Save command in SAP. Enable this functionality on the Save page of the SAP ECTR interface to
PTC Creo configuration dialog.

6.3.4.14 About

When to use
Use this command when, while working in PTC Creo Parametric, you want to display information on SAP
ECTR interface to PTC Creo.

Tool tip
About SAP ECTR interface to PTC Creo.

How to use
Do the following to display information on SAP ECTR interface to PTC Creo:
1) Click SAP PLM  Additional Functions  Extras  About.
Result: The system displays information on SAP ECTR interface to PTC Creo.

99
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.15 Add Table

When to use
Use this command when, while working in PTC Creo Parametric, you want to add a table with repeat
region to your drawing. Then, you can create BOM balloons.

Tool tip
Add Table for BOM Balloons.

Creating BOM balloons based on data from the bill of materials

Do the following to create BOM balloons from the bill of materials:
Step Application
1 Add Table SAP ECTR interface to PTC Creo
3 Create balloons PTC Creo Parametric
3 Display component parameters in the balloons PTC Creo Parametric

Table: Steps for BOM balloons

How to use
Do the following to add a table with repeat region for component parameters to a drawing:
1) Click SAP PLM  Additional Functions  Ballooning  Add Table.
2) Place the table in the drawing.
3) Update the table in PTC Creo Parametric, if required.
Result: The table has been added to the drawing and shows the bills of materials. Using the PTC Creo
Parametric ballooning functions, you can now create BOM balloons. The balloons can show component
parameters such as the item number from the repeat region.

Figure: Table with repeat region

Refreshing component parameters

When you add a table, the required data is automatically transferred from SAP PLM to the component
parameters. This has the same effect as the Refresh Component Parameters command.

100
SAP ECTR interface to PTC Creo - Using the Menu and Commands

Create balloons
Do the following to create BOM balloons in the drawing:
1) Create all required balloons by using the corresponding table and balloon commands in PTC Creo
Parametric.
Result: The balloons are displayed in the drawing. The balloons show the internal numbers assigned by
PTC Creo Parametric.

Figure: Balloons with internal numbering

Displaying component parameters in the balloons

Do the following to display the item numbers from the BOM in the balloons:
1) Select the table.
2) Right-click to change the table properties.
3) Change the BOM balloon parameters.
4) Click the table column that contains the item numbers from the bill of materials.
Result: The balloons now show the item numbers from the bill of materials.

Figure: Balloons with BOM item numbers

101
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.3.4.16 Refresh Component Parameter

When to use
Use this command when, while working in PTC Creo Parametric, you want to create or refresh
component parameters in the active assembly. The component parameters are populated with data from
the bill of materials, such as the item number and material number.

Tool tip
Refresh Component Parameters for BOM Balloons.

How to use
Do the following to populate the component parameters with data from the bills of materials:
1) Click SAP PLM  Additional Functions  Ballooning  Refresh Component Parameters.
Result: The component parameters are populated with data from the document BOM.

Command scope
The Refresh Component Parameters command can only be used for assemblies. For material linked to
the assembly document must exist a material BOM. If you select the command from within a drawing, it is
executed for the assembly represented in the drawing.

Refreshing BOM balloons based on data from the bill of materials

If your drawing already contains a table with repeat region, you can use the Refresh Component
Parameters command to refresh the component parameters explicitly based on the data from the bill of
materials.

102
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.4 SAP PLM Context Menu Commands in the Model Tree

The SAP PLM context menu in the PTC Creo Parametric model tree contains a number of commands
that are also available in the SAP PLM menu. Context menu commands can be used in the same way as
their counterparts from the SAP PLM menu. Please note that the scope of the context menu commands
is different from the scope of the commands available in the SAP PLM menu.

6.5 Commands in the Application Structure Context Menu

The application structure context menu contains a number of commands that are also available in the
SAP PLM menu.
The contents of the application structure context menu depends on whether you selected a file without a
document or an original with a document.
The application structure context menu contains some exclusive commands that are not included in the
SAP PLM menu.

6.5.1 Application structure commands

Depending on the context, the application structure context menu contains the following commands from
the SAP PLM menu:
• Import
• Edit
• Save
• Save and Display
• Save as New Version
• Save as New Document
• Cancel
• Cancel Edit

6.5.2 Additional application structure commands

Depending on the context, the application structure context menu additionally includes the following
commands:
• Display
• Select

103
SAP ECTR interface to PTC Creo - Using the Menu and Commands

6.5.2.1 Display

When to use
Use this command to display a file or an original in the CAD system when working in the application
structure.

How to use
Do the following to display a file or an original in the CAD system while working in the application
structure:
1) Select the desired file or the document of an original in the application structure.
2) Click Display from the context menu.
Result: The CAD file or the original is opened and displayed in a PTC Creo Parametric window.

6.5.2.2 Select

When to use
Use this command to select a component of an assembly in the PTC Creo Parametric model tree while
working in the application structure.

How to use
Do the following to select a component from the PTC Creo Parametric model tree while working in the
application structure:
1) Select the desired file or document of an original in the application structure.
2) Click Select from the context menu.
Result: The component is highlighted and selected in the PTC Creo Parametric model tree. The selected
component can directly be edited in PTC Creo Parametric.

104
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

This section contains procedures that will help you customize the
PTC Creo Parametric ribbon.

7 Tabs and Groups in PTC Creo Parametric

7.1 Customizing the Ribbon

The following procedures show how to perform an application-specific customization of the PTC Creo
Parametric ribbon and save the associated settings.

Figure: SAP PLM tab

Always perform the steps in the order indicated below:

• Configure the ribbon in English.
• Create tabs and groups for each PTC Creo Parametric mode (Drawing, Parts, Assemblies, …).
• Add TOOLKIT commands from the SAP PLM menu to the groups.
• Use large buttons for your favorite commands.
• Move commands you do not need very often to the group overflow menu.
• If you need more room, cascade the commands.
• Save the configuration in the toolkitribbon.rbn file.
• Translate the names of the tabs, groups, and cascades in the ribbonui.txt localization file.

PTC Creo Parametric 4.0 – Common tab

In PTC Creo Parametric 4.0 or higher, the Common tab is available in all PTC Creo Parametric modes.
In contrast to the SAP PLM tab, there is no need to configure the Common tab individually for each
mode.

Figure: Commands from the SAP PLM menu in the Common tab

The config.pro file

In the config.pro file, set the tk_enable_ribbon_custom_save option to yes. Only after this has
been done, it is possible to save an application-specific ribbon configuration in the toolkitribbon.rbn
file.

105
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

Alternative creo_parametric_customization.ui file

As an alternative to the application-specific toolkitribbon.rbn file, you can also save your
customizations globally in the creo_parametric_customization.ui file.

English as the source language

If you want to use the ribbon customization settings in other languages as well and like to translate the
tab and group names, select English as the user interface language. Start PTC Creo Parametric in
English and create the tabs and groups in English first. Then, translate the names of tabs and groups in
the ribbonui.txt localization file.

Creating tabs and groups

Do the following to create the desired tabs and groups:
1) Start PTC Creo Parametric with the English user interface.
2) From the ribbon context menu, select Customize the Ribbon.
3) Click New Tab.
4) Select the new tab.
5) Click Rename….
6) Rename the tab as desired.
7) Select the new group.
8) Click Rename….
9) Rename the group as desired.
10) Create more groups.
11) Use the arrow keys to move the tab to the desired location and then click OK.
Result: The tab is displayed in the ribbon.

Adding TOOLKIT commands

Do the following to add commands to the TOOLKIT group of the tab:
1) From the ribbon context menu, select Customize the Ribbon.
2) Click the desired group in the main tab.
3) In the Choose commands from list box, click the TOOLKIT commands option.
4) Select the desired command.
5) Click Add >>.
6) Add more commands to the groups.
7) Use the arrow keys to move each TOOLKIT command to the desired location.
8) Click OK.
Result: The TOOLKIT commands are displayed in the groups.

Selecting TOOLKIT commands

When customizing the ribbon, only use TOOLKIT commands from the SAP PLM menu, rather than
commands from the model tree SAP PLM context menu. If commands with the same name are listed
more than once, use the lower one in the list.

TOOLKIT commands from the ribbon context menu

If you accidentally selected TOOLKIT commands from the model tree SAP PLM context menu for display
in the ribbon, these TOOLKIT commands are disabled and cannot be used.

106
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

Using large buttons

Do the following to use large buttons for your favorite TOOLKIT commands in the group:
1) From the ribbon context menu, select Customize the Ribbon.
2) Expand the desired group on the tab.
3) Select the desired TOOLKIT command.
4) Click Modify.
5) Select  Large Button.
6) Edit other TOOLKIT commands by selecting  Large Button.
7) Use the arrow keys to move each TOOLKIT command to the desired location.
8) Click OK.
Result: Your favorite TOOLKIT commands are displayed with large buttons.

Moving commands to the overflow menu

Do the following to move TOOLKIT commands you do not need very often to the group overflow menu:
1) Move the mouse pointer to the desired command.
2) From the context menu, select Move to Overflow.
3) Move other TOOLKIT commands to the overflow menu.
4) From the ribbon context menu, select Customize the Ribbon.
5) On the tab, click the desired group.
6) Click <Group Name> Overflow.
7) Use the arrow keys to move each TOOLKIT command to the desired location in the overflow menu.
8) Click OK.
Result: The TOOLKIT commands that you do not use very often are now located in the overflow menu of
the group.

Cascading commands
The TOOLKIT commands in a group or in a group overflow menu can be cascaded.
1) From the ribbon context menu, select Customize the Ribbon.
2) Expand the desired group.
3) Click the location where you want to create a new cascade.
4) Click New Cascade.
5) Rename the cascade.
6) Use the arrow keys to move the cascade to the desired location.
7) Use Drag & Drop to move the desired TOOLKIT commands to the cascade.
8) If required, use separators to group the TOOLKIT commands.
9) Use the arrow keys to move each TOOLKIT command to the desired location in the cascade.
10) Click OK.
Result: The TOOLKIT commands are now grouped in cascades and structured by separators.

107
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

7.2 Saving Customizations in the toolkitribbon.rbn and ribbonui.txt

Files

The toolkitribbon.rbn customization file is only intended for saving application-specific configuration
settings related to the ribbon.
When you start a TOOLKIT tool for which a toolkitribbonui.rbn file exists, the functions configured
in the toolkitribbonui.rbn customization file are added to the ribbon. Customizations specified in
the creo_parametric_customization.ui file are not affected.

Loading the application-specific *.rbn file

Loading the application-specific *.rbn file
If an application-specific toolkitribbonui.rbn customization file exists in the text folder of the
TOOLKIT tool, the application-specific toolkitribbonui.rbn file will be loaded when the TOOLKIT
tool is launched. The application-specific toolkitribbonui.rbn customization file adds new features
to the existing PTC Creo Parametric ribbon.

Exporting the application-specific toolkitribbonui.rbn customization file

Do the following to export the ribbon customizations:
1) Use a text editor to open the config.pro file.
2) Set the tk_enable_ribbon_custom_save option to yes.
3) Launch PTC Creo Parametric together with SAP ECTR interface to PTC Creo.
4) From the ribbon context menu, select Customize the Ribbon.
5) Click Import/Export.
6) Select Save the Auxiliary Application User interface.
Result: The toolkitribbonui.rbn customization file is saved in the text folder of the auxiliary
application, e.g. %PLM_INSTDIR%\applications\pro\appdata\lib\text.

Translating tab and group names

The commands added to the ribbon tabs and groups are displayed automatically in the language selected
for the user interface.
The names of tabs, groups, and cascades, however, need to be translated manually using the
ribbonui.txt localization file.

The ribbonui.txt file

The ribbonui.txt localization file must be stored in the appropriate language directory of the
TOOLKIT application, e.g. %PLM_INSTDIR%\applications\pro\appdata\lib\text\german.

English as original language

Please note that using the ribbonui.txt file, you cannot change the English names of tabs and
groups. So if you need to change them, first define the tabs and groups in English and then create the
language-specific ribbonui.txt file.

108
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

Creating the ribbonui.txt file

Do the following to create a ribbonui.txt file for each desired language:
1) Open a text editor.
2) Create a file named ribbonui.txt.
3) Edit the ribbonui.txt file for each label (i.e. tab and group name) by entering the following 4
lines for each of them:
1. Line:
# character, followed by the label name as defined in the toolkitribbonui.rbn file.
2. Line:
Name of the label as defined in the toolkitribbonui.rbn file.
3. Line:
Desired translation of the label.
4. Line:
Blank line (no content).
4) Save the ribbonui.txt file in the desired language directory, e.g.
%PLM_INSTDIR%\applications\pro\appdata\lib\text\german.
When you start PTC Creo Parametric, the file will be loaded and the tabs and group names will be
displayed in the desired language.

Sample ribbonui.txt file

The ribbonui.txt file containing the German translations of an English toolkitribbonui.rbn file might
look like this:
#SAP PLM¶
SAP PLM¶
SAP PLM¶
¶
#Originals¶
Originals¶
Originale¶
¶
#Addidional Functions¶
Additional Functions¶
Zusätzliche Funktionen¶
¶

UTF-8
If you use UTF encoding in your editor, make sure to save the ribbonui.txt file with UTF-8 (with
BOM) encoding.

Blank lines
Make sure to separate the data for each label in the ribbonui.txt file by inserting blank lines.
Also add a blank line at the end of the ribbonui.txt file.

109
SAP ECTR interface to PTC Creo - Tabs and Groups in PTC Creo Parametric

7.3 Saving Customizations in the creo_parametric_customization.ui

File

The customization file named creo_parametric_customization.ui contains the overall

configuration of your ribbon, including application-specific ribbon buttons. The customization file
creo_parametric_customization.ui will be read when you launch PTC Creo Parametric,
independently of the application you are using.

Loading the generic *.ui customization file

At startup, PTC Creo Parametric reads the customization files in the following order:
1. <loadpoint>\text\creo_Parametric_admin_customization.ui
2. <user_profile>\AppData\...\creo_parametric_customization.ui
3. <working_dir>\creo_parametric_customization.ui
System default: <user_profile>\AppData\...\creo_parametric_customization.ui

Exporting the generic *.ui file

Do the following to export the ribbon customizations:
1) From the ribbon context menu, select Customize the Ribbon.
2) Click Import/Export.
3) Select Export all Ribbon and Quick access Toolbar Customizations.
4) Specify the desired location.
5) Confirm the creo_parametric_customization.ui file name in the File Name entry field.
6) Click Save to save the creo_parametric_customization.ui customization file.
Result: The customization file is saved in the specified location.

Importing a *.ui customization file

Do the following to import ribbon customizations:
1) From the ribbon context menu, select Customize the Ribbon.
2) Click Import/Export.
3) Select Import customization file.
4) Specify the file path.
5) Click the desired customization file.
6) Click Open to open the customization file.
7) Click Import All Customizations.
8) Click OK.
Result: The customizations specified in the customization file are now visible in the ribbon.

The config.pro file

In the config.pro file, set the load_ui_customization_run_dir option to yes. This causes PTC
Creo Parametric to read the creo_parametric_customization.ui file from the working directory or
from the startup directory.

110