0% found this document useful (0 votes)
337 views131 pages

CIDEON ECTR Interface To Inventor Configuration Manual

Uploaded by

Bilal Kara
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
337 views131 pages

CIDEON ECTR Interface To Inventor Configuration Manual

Uploaded by

Bilal Kara
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 131

Configuration Manual

Management of CAD data and documents in SAP

SAP Engineering Control Center Interface to


Inventor

SAP Engineering Control Center Interface to Inventor manages design data in SAP.

Given by the SAP Engineering Control Center Interface, tight integration of the CAD system to the SAP PLM
data available to the company at an early stage in the design process are available. Product lifecycle
management thus already begins with the start of design work and not through an interface at the end of it.
The coupling between the CAD system and the SAP Engineering Control Center allows you to manage the
components designed in the CAD system.

You can configure the SAP Engineering Control Center Interface to Inventor in many different ways and adapt it
to your own requirements and working methods. This configuration manual presents the possible
configurations and describes the procedures and configuration parameters in detail.

© 2023 CIDEON Software & Services GmbH & Co. KG. Germany. All Rights Reserved.

Contents of this document may not be (totally or partly) reproduced, used or published without previous
written agreement by the CIDEON Software & Services GmbH & Co. KG.
Copyright applies to all forms of storage and reproduction, in those the available information flowed in
particular on magnetic storage, computer expressions or visual announcements.

CIDEON Software & Services GmbH & Co. KG Page 1 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Folder structure and directories .................................................................................................................. 4
Icons for CAD originals in SAP ECTR ............................................................................................................... 6
Registrationless integration of add-ins in the CAD system ............................................................................. 7
Starting Inventor from ECTR in the SAP logon language ................................................................................ 8
The configuration files ................................................................................................................................... 9
Menu definitions ............................................................................................................................................. 9
menu.guidef ................................................................................................................................................ 9
menu_macros.txt ...................................................................................................................................... 13
The files "attributes-from-sap.xml" and "attributes-to-sap.xml" ................................................................... 13
attributes-from-sap.xml ............................................................................................................................ 14
attributes-to-sap.xml ................................................................................................................................. 17
Inventor Properties .................................................................................................................................... 20
default.txt ..................................................................................................................................................... 31
Parameter description - Part 1 .................................................................................................................. 31
Parameter description - Part 2 .................................................................................................................. 40
Use Excel files as parameter files ............................................................................................................. 49
Creating mold assemblies with "ECTR New" ............................................................................................. 50
dtype.xml ..................................................................................................................................................... 50
DType definitions for Inventor ................................................................................................................... 51
Generic DType definitions ..................................................................................................................... 52
The DType definition for master documents ......................................................................................... 75
The DType definitions for nonmaster documents ................................................................................ 111
options.xml ................................................................................................................................................. 117
plm_setenv.bat ........................................................................................................................................... 121
rfc-tunnel-whitelist.txt ................................................................................................................................ 121
Loading rules for opening documents (load_scenarios.xml) ....................................................................... 122
Version information .................................................................................................................................... 125
Final Remark ............................................................................................................................................... 131

CIDEON Software & Services GmbH & Co. KG Page 2 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
CIDEON Software & Services GmbH & Co. KG Page 3 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Folder structure and directories
The SAP Engineering Control Center requires a certain folder structure that is established during the
installation process.

The system-wide environment variable "%PLM_INSTDIR%" contains the installation directory of


the SAP Engineering Control Center and is set up during installation.

Under "%PLM_INSTDIR%\applications\" the individual Add-ons are stored during their installation in separate
subdirectories.

"%PLM_INSTDIR%\applications\inv" is the installation directory of the SAP Engineering Control Center Interface
to Inventor. It contains the following subdirectories which are significant for configuration:

%PLM_INSTDIR%\applications\inv\appdata
%PLM_INSTDIR%\applications\inv\basis
%PLM_INSTDIR%\applications\inv\documentation
%PLM_INSTDIR%\applications\inv\templates
%PLM_INSTDIR%\applications\inv\template-templates
%PLM_INSTDIR%\applications\inv\customize\config
%PLM_INSTDIR%\applications\inv\customize\scripts\macros
%PLM_INSTDIR%\applications\inv\template-customize\config

The directory "appdata"

Two subdirectories are included here:

Additional Files:
This subdirectory contains the template file "CdnECTRInterfaceInv.addin". This file contains the
necessary information for the integration to be loaded in Inventor. If the integration is installed by
means of Installer, the file is already copied into the Add-in directory of Inventor under
"%ProgramData%\Autodesk\Inventor 20xx\Addins" and the path to the ECTR installation is adapted in
the file.
The file "readme.txt" contains a short instruction of the procedure for this.
icons:
This subdirectory contains the images used in the Inventor Ribbon of the SAP Engineering Control
Center Interface to Inventor. The symbols are available as 16x16, 24x24, 32x32 and 48x48 pixel PNG
files. The name of the file corresponds to the command to be called, plus the size. The images can be
replaced by your own images if necessary.
ATTENTION: The installer always resets them to the original state!

The directory "basis"

Here, the following directories are included:

aux-files: Contains the data "standard_icons.txt". This determines which symbols are to be used for
commands and document information. See also the ECTR documentation "SAP Implementation Guide
Icons_EN.pdf".
classes: Contains Java classes that are necessary for interface operation.
dictionary: Contains subdirectories with a "dictionary.txt" file with display texts in the supported
languages (DE, EN, ES, FR, IT, JA, PT, RU, ZH and ZF).

CIDEON Software & Services GmbH & Co. KG Page 4 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
sys: In "sys\win\bin" the individual interface modules can be found. These are loaded via the add-in in
Inventor (see "Registrationless integration of add-ins in the CAD system").

The directory "documentation"

In this directory, the user manuals can be found in both German and English as PDF files.

The directories "templates" and "template-templates"

If a new document is created via the SAP Engineering Control Center, you can choose from a list of document
templates. These submissions can be found in the directory "templates". A pool of various document
submissions can be found in the "template-templates" directory. After re-installation, the contents of both
directories are identical. Should new or changed templates be delivered with a patch or an update, they will be
stored in "template-templates". Should these appear in the above-mentioned lists, the appropriate data must
be copied into the "templates" directory. Furthermore, the templates must be registered in the "dtype.xml"
file.

The directory "customize\config"

Here, files can be found that are necessary for the configuration of the SAP Engineering Control Center
Interface to Inventor. These are:

default.txt
dtype.xml
options.xml
menu.guidef
menu_macros.txt
plm_setenv.bat
attributes-from-sap.xml
attributes-to-sap.xml
rfc-tunnel-whitelist.txt

At the start of Inventor, these files are evaluated and override the basic installation of the SAP Engineering
Control Center that is filed under "%PLM_INSTDIR%\customize\config" and add additional CAD-specific
configurations that are not included in the basic configuration, i.e. specific types of documents, workstation
applications and menu items.

The directory "customize\scripts"

This directory contains additional batch scripts that extend the check-in and check-out process.

The directory "customize\scripts\macros"

This directory contains files that define Inventor macros. The files shipped with the installation in this directory:

inv_idw.txt
inv_ipn.txt
get_related_drawings.txt
get_related_presentations.txt

The files "inv_idw.txt" and "inv_ipn.txt" contain sample implementations for macros.

The directory "template-customize\config"

CIDEON Software & Services GmbH & Co. KG Page 5 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The standard settings are filed as copies in the "template-customize\config" special directory, which contains
homonymous files to those in "customize\config" for that reason.

After a software update, i.e. patch, the bundled configuration files are only stored in the
"template-customize\config" directory. Thus, the user settings remain in the directory
"customize\config".
However, this also means that changes and extensions to the configuration are not
customized automatically during updates. These must be carried out manually as
needed!

Icons for CAD originals in SAP ECTR


In the SAP Engineering Control Center, information on documents is displayed in the form of icons. In addition
to general icons, which are valid for all documents, there are icons especially for the <CAD> object types
defined in the configuration file "dtype.xml". Depending on the document status, the background of the object
type icons can be colored. Further information about the <CAD> object is placed in the form of overlays over
the object type icon.
A set of standard icons is delivered in the file "%PLM_INSTDIR%\applications\inv\base\classes\images.jar".

For detailed information on icons in the SAP Engineering Control Center, see the help file "SAP
Implementation Guide Icons_EN.pdf", which can be found in the directory
"%PLM_INSTDIR%\documentation\Manuals\en" or in the ECTR menu under "Help->Display
Documentation" in the section "SAP Engineering Control Center".

The configuration file "dtype.xml" defines which icons are displayed and in which order the icons are displayed
for each DType. The status-dependent background color of the object type icons is defined in the global
configuration file "default.txt" of the SAP Engineering Control Center.

Displayed icons can be supplemented with overlay icons to visualize certain states in which the
displayed objects are located. For the meaning of these symbols, refer to SAP's ECTR
documentation.

The following table provides an overview of the standard symbols for Inventor:

Icons for Inventor supplied as standard


Symbol Description File name in "images.jar"
Inventor single part document
DType: Document symbol position 1
tree\inv\inventor_part_16.png
tree/inv/inventor_part_$(FAMILY)16 with
$(FAMILY) = <empty>
Inventor iPart part family document
DType: Document symbol position 1
tree\inv\inventor_part_g16.png
tree/inv/inventor_part_$(FAMILY)16 with
$(FAMILY) = g
Inventor iPart variants document
DType: Document symbol position 1
tree\inv\inventor_part_i16.png
tree/inv/inventor_part_$(FAMILY)16 with
$(FAMILY) = i

CIDEON Software & Services GmbH & Co. KG Page 6 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Inventor Assembly document
DType: Document symbol position 1
tree\inv\inventor_assembly_16.png
tree/inv/inventor_assembly_$(FAMILY)16
with $(FAMILY) = <empty>
Inventor iAssembly parts family document
DType: Document symbol position 1
tree\inv\inventor_assembly_g16.png
tree/inv/inventor_assembly_$(FAMILY)16
with $(FAMILY) = g
Inventor iAssembly variants document
DType: Document symbol position 1
tree\inv\inventor_assembly_i16.png
tree/inv/inventor_assembly_$(FAMILY)16
with $(FAMILY) = i
Inventor presentation document
DType: Document symbol position 1 tree\inv\inventor_presentation_16.png
tree/inv/inventor_presentation_16
Inventor drawing master document
DType: Document symbol position 1 tree\inv\inventor_drawing_16.png
tree/inv/inventor_drawing_16
Inventor drawing dependent document
Replacement is done in file "standard_icons. txt"
(document is up-to-date compared to the
tree/inv/inventor_drawing_160 =
master)
tree/inv/inventor_drawing_16
DType: Document symbol position 1
Thus, the tree\inv\inventor_drawing_16.png from file
tree/inv/inventor_drawing_16$(NM_OLD)
"images.jar" is used.
with $(NM_OLD)= 0
Replacement is done in file "standard_icons. txt"
Inventor drawing dependent document
tree/inv/inventor_drawing_161 =
(document is outdated compared to the
tree/inv/inventor_drawing_16<<{0}/sap/o_outdated
master)
tree\inv\inventor_drawing_16.png will be overlaid with
DType: Document symbol position 1
{0}\sap\o_outdated.
tree/inv/inventor_drawing_16$(NM_OLD)
{0} stands for size. Possible values are small,
with $(NM_OLD)= 1
medium, large.
Inventor document
tree\file\obr_tree_file_inv.png
Workstation Application INV
Inventor application
small\app_inventor.png
Menu: System\Start application\Inventor

Registrationless integration of add-ins in the CAD system


The integration of the SAP Engineering Control Center Interface to Inventor in the CAD system takes place
during installation, without the necessity of a registration of the add-in. To this end, from the installer, the
directory "%PLM_INSTDIR%\applications\inv\appdata\Additional Files\" is created with the files
"CdnECTRInterfaceInv.addin" and "Readme.txt". The file "CdnECTRInterfaceInv.addin" is copied to the
directory "%ProgramData%\Autodesk\<Inventor Version>\Addins\", where "<Inventor Version>" denotes the
currently used inventor version:

The directory Addins

%ProgramData%\Autodesk\<Inventor Version>\
|__ \Addins\
|__ CdnECTRInterfaceInv.addin

CIDEON Software & Services GmbH & Co. KG Page 7 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The path contained in the file "CdnECTRInterfaceInv.addin" under the XML tag <Assembly> for the interface
module "CdnECTRInterfaceInv64.dll" is adjusted to the current conditions:

Example of an adjusted path in the file "CdnECTRInterfaceInv.addin"

<Assembly>D:\CIDEON\ECTR\ECTR50_02\applications\inv\basis\sys\win\bin\CdnECTRInterfaceInv64.dll</Assembly>

During startup, the inventor evaluates this file and the path contained therein and integrates the found module
"CdnECTRInterfaceInv64.dll" as an add-in.

The file "Readme.txt" contains an explanation of the methods described here for future reference.

Starting Inventor from ECTR in the SAP logon language


If Inventor is started from within the SAP Engineering Control Center, i.e. using the context menu command
"Open original" or by double-clicking on an Inventor document, the CAD system is automatically executed in
the SAP logon language of the ECTR. The environment variable "%PLM_LANGUAGE%" is responsible for this
behavior. This is set by the ECTR to the SAP logon language and evaluated accordingly when Inventor is
started.

Whether the environment variable "%PLM_LANGUAGE%" is evaluated depends on the


configuration of the parameter "plm.appl.language.INV" in the configuration file "default.txt"
(available from patch level 14).

If the SAP logon language for Inventor is not available or unknown, the CAD system is started in
the language in which it was last started!

CIDEON Software & Services GmbH & Co. KG Page 8 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The configuration files
The files contained in the %PLM_INSTDIR%\applications\inv\customize\config directory serve the CAD-specific
configurations of the SAP Engineering Control Center. These files are also marked as preference files and are
simple text files that can be edited with a simple ANSI-text editor, i.e. the Windows-specific text editor
"Notepad.exe". They are filed there during the installation of the SAP Engineering Control Center Interface to
Inventor, with standard settings for this interface.

The standard settings are chosen so that typical usage scenarios are covered. Should this not be enough, the
reaction of the interface and the SAP Engineering Control Center should adapt appropriately. Next to the
central configuration files in %PLM_INSTDIR%\customize\config, each application has its own configuration files
in directory %PLM_INSTDIR%\applications\<<name of application>>\customize\config. The individual files
differ from homonymous files in the configuration directory of the SAP Engineering Control Center in that only
the respective CAD specificity are controlled through them.

During the start of the SAP Engineering Control Center, the standard configuration is read and then overridden
with the content of the CAD-specific configuration files. Each interface, if multiple interfaces are installed, has
its own set of CAD-specific configuration files.

For a detailed clarification of purpose, structure and handling of the configuration files, please
refer to the SAP Engineering Control Center documentation, specifically the configuration
handbook (file "Configuration Guide_EN.pdf") and the operations guide (file "Operations
Guide_EN.pdf"), which can be found under %PLM_INSTDIR%\documentation\Manuals\en!

Menu definitions
Menu items that should be available along with the SAP Engineering Control Center Interface to Inventor in the
user interface of the SAP Engineering Control Center are defined in the file "menu.guidef".
Recurring function sequences in menus and sub-menus can be defined as macros in the file
"menu_macros.txt". These macros will then only be referenced in the menu definitions in the file
"menu.guidef". In addition to the global files with the same name under %PLM_INSTDIR%\customize\config
there are the CAD-specific counterparts, which additionally define appropriate menus for the SAP Engineering
Control Center.

menu.guidef

The file "menu.guidef" contains menu items that are available in connection with the SAP Engineering Control
Center Interface to AutoCAD in the user interface of the SAP Engineering Control Center.

Construction of a menu definition

Each individual menu definition begins with a plus sign ('+') in the first column of the line, followed by
the menu identification.
The individual functions that appear in the menu are arranged one after the other, in which each menu
function is preceded by an equal sign ('=').
In each menu definition, macros, which are defined in the file "menu_macros.txt" or in the general
macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt", are referenced by their
names which are preceded by a question mark ('?').
Sub-menus in the menu are designated by indentation of the associated menu entries, for which only
blank spaces may be used.

CIDEON Software & Services GmbH & Co. KG Page 9 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Tabs are not allowed!
Separators within the menu are represented by a line consisting of dashes ('-').
Commentaries can be inserted. These are preceded by a '#' at the beginning of the line.

Unlock menu for interoperability between Inventor and AutoCAD

As the document type "dwg" can be opened in Inventor as well as in both AutoCAD and AutoCAD Mechanical, a
special menu for the user interface of the SAP Engineering Control Center can be offered:

Interoperability menu for Inventor

This is already included and unlocked in the supplied CAD-specific file "menu.guidef" (menu definition
"om.popup.menu.DOC.DOC_INVDWG", see red mark):

CIDEON Software & Services GmbH & Co. KG Page 10 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Menus with interoperability with AutoCAD unlocked

This menu definition may be deactivated. It requires two steps:

Comment out the menu definition "om.popup.menu.DOC.DOC_INVDWG" marked as "Interop".


In the configuration file "dtype.xml" the function_group of DType "IDWGT" in the program_options must
be changed to "DOC_GENERAL".

Definition of the context menu for cloning

A context menu is provided for the "Clone" functionality of the SAP Engineering Control Center. Its range of
functions are defined using the parameters "om.popup. menu.CLONEPOS.DOC_INVxxx":

CIDEON Software & Services GmbH & Co. KG Page 11 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Definition of the context menu for "Cloning"

# ----- Cloning Options

+ om.popup.menu.CLONEPOS.DOC_INVDRW = ? DOCUMENT_INV_GENERAL_CLONING

+ om.popup.menu.CLONEPOS.DOC_INVDWG = ? DOCUMENT_INV_GENERAL_CLONING

+ om.popup.menu.CLONEPOS.DOC_INVMDL = ? DOCUMENT_INV_GENERAL_CLONING

+ om.popup.menu.CLONEPOS.DOC_INVCC = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.REPLACE_OPTION
= fnc.doc.clone.option.DELETE_OPTION
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload

+ om.popup.menu.CLONEPOS.DOC_INVNR = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.INSERT_OPTION
= fnc.doc.clone.option.REPLACE_OPTION
= fnc.doc.clone.option.DELETE_OPTION
= fnc.doc.clone.option.NEWVERS_OPTION
= fnc.doc.clone.option.CHANGE_OPTION
= -----------------------------
= fnc.doc.clone.select.dependent
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload

The macro "DOCUMENT_INV_GENERAL_CLONING" defined in the file "menu_macros.txt" is used, which defines
the scope of functions:

Definition of the functions of the context menu for "Cloning" in file "menu_macros.txt"

# global cloning functions

? DOCUMENT_INV_GENERAL_CLONING = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.NEWINTNR_OPTION
= fnc.doc.clone.option.NEWEXTNR_OPTION
= fnc.doc.clone.option.INSERT_OPTION
= fnc.doc.clone.option.REPLACE_OPTION
= fnc.doc.clone.option.DELETE_OPTION
= fnc.doc.clone.option.NEWVERS_OPTION
= fnc.doc.clone.option.CHANGE_OPTION
= -----------------------------
= fnc.doc.clone.select.dependent
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload

The following functions are possible:

Possible functions in the context menu for "Cloning"


Parameter Function
fnc.doc.clone.option.NO_ACTION "No Action"
fnc.doc.clone.option.NEWINTNR_OPTION "New internal Number"
fnc.doc.clone.option.NEWEXTNR_OPTION "Extended Clon Options"
fnc.doc.clone.option.INSERT_OPTION "Add Component"

CIDEON Software & Services GmbH & Co. KG Page 12 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
fnc.doc.clone.option.REPLACE_OPTION "Replace Component"
fnc.doc.clone.option.DELETE_OPTION "Delete Component"
fnc.doc.clone.option.NEWVERS_OPTION "New Version"
fnc.doc.clone.option.CHANGE_OPTION "Change Details"
If this function is set, the menu allows you to select dependent
fnc.doc.clone.select.dependent
documents individually.
fnc.clpbrd.delete "Remove"
fnc.doc.reload "Reload"

NOTE:
The "cloning" function is universally designed for various CAD systems. Therefore, not every
possible function is necessarily useful for every CAD system and document type. Before adding a
function to the context menu, this should be checked carefully! It can be useful to configure
different context menus for different document types.
Detailed information on configuring menus can be found in the ECTR manual "Operations
Guide_EN.pdf".

menu_macros.txt

Recurring function sequences in menus and sub-menus are defined as macros in the file "menu_macros.txt."
These can then be referenced using their names in the file "menu.guidef."

Structure of a macro definition

Each individual macro definition begins with a question mark at the beginning of the line, followed by
the macro name. This should be typed using capital letters, to designate it as a macro name.
The individual menu functions belonging to a macro are arranged one after the other, with each menu
function being preceded by an equal sign ('=').
Other macros can also be referenced by name within a macro definition, and names should be
preceded by a question mark ('?'). These macros can either come from this file itself or from the
general macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt".
Sub-menus in the menu are designated by indentation of the associated menu entries, for which only
blank spaces may be used.
Tabs are not allowed!
Separators within the menu are represented by a line consisting of dashes ('-').
Commentaries can be inserted. These are preceded by a '#' at the beginning of the line.

The defined macros "LAUNCH_APPL_INV" is required, so that the SAP Engineering Control Center can start the
Inventor application as needed.

The files "attributes-from-sap.xml" and "attributes-to-sap.xml"


For each document type (DType), one can define which attributes are transmitted or stored in which manner.
This is also referred to as an attribute mapping. In this process, a distinction is made between the transfer of
attributes from SAP to the document and from the document to SAP. For defining the former, use the file
"attributes-from-sap.xml". For defining the latter, use file "attributes-to-sap.xml". Document attributes and
material attributes can be passed.

CIDEON Software & Services GmbH & Co. KG Page 13 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
For more information on this topic, see the file "Operations Guide_EN.pdf", chapter: "Attribute
Transfer Between the SAP System and an Application", which is part of the ECTR documentation.

Diverse attribute mappings are included in the general configuration files

"%PLM_INSTDIR%\customize\config\attributes-from-sap.xml"

and

"%PLM_INSTDIR%\customize\config\attributes-to-sap.xml".

The following Inventor-specific attribute mapping files exist for this purpose:

​ "%PLM_INSTDIR%\applications\inv\customize\config\attributes-from-sap.xml"

and

​ "%PLM_INSTDIR%\applications\inv\customize\config\attributes-to-sap.xml".

These files are described in the chapters "attributes-from-sap.xml" and "attributes-to-sap.xml".

attributes-from-sap.xml

The file "attributes-from-sap.xml" is responsible for defining the transfer of attributes from SAP to the
document.

Please note:
With version 5.1.7 of the ECTR, the inclusion of the standard section will be adapted in the file
"attributes-from-sap.xml".
Before:
<section name="GENERIC" default_section="true" description="Attribute mapping">
With ECTR version 5.1.7:
<section name="GENERIC" include_section="STANDARD" description="Attribute mapping">
The name of the included standard section comes from the global file "attributes-from-sap.xml"
file.
By changing it to "include_section" it is possible to use any defined "section" and extend it as
desired.

Various sections can be defined in the CAD-specific attribute mapping file


"%PLM_INSTDIR%\applications\inv\customize\config\attributes-from-sap.xml", each of which represents an
attribute section that contains defined mappable attributes and their precise treatment. The attribute "name"
gives the relationship to the DType description in the file "dtype.xml". An attribute section (attribute
"attribute_section") can be assigned to each DType for creating (element "document_create") and saving
(element "primary_application").

CIDEON Software & Services GmbH & Co. KG Page 14 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Example for attribute mapping sections in the file "attributes-from-sap.xml"

<mapping>
<section name="GENERIC" include_section="STANDARD" description="Attribute mapping">
<APPL_ATTRIBUTE name="Name" hidden="false">
<XFORMAT outputFormat="{0}/{1}">
<CUTLEADING character="0">
<DIR field="DOCUMENTNUMBER"/>
</CUTLEADING>
<DIR field="DOCUMENTVERSION"/>
</XFORMAT>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_DESCRIPTION" hidden="false"> <DIR field="DESCRIPTION"/>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_USER" hidden="false"> <DIR field="USERNAME"/>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_LASTSAVED" hidden="false"> <DIR field="CHECKIN_DATE"/>
</APPL_ATTRIBUTE>
</section>
<section name="STDMOD" description="Attributes for material">
<APPL_ATTRIBUTE name="SAP_MATERIAL_NO" hidden="false"> <MA field="MATERIAL"/>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_MATERIAL_DESC" hidden="false"> <MA field="MATL_DESC"/>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_MATERIAL" hidden="false"> <MA field="BASIC_MATL_NEW"/>
</APPL_ATTRIBUTE>
<APPL_ATTRIBUTE name="SAP_MATERIAL_WEIGHT" hidden="false"> <MA field="NET_WEIGHT"/>
</APPL_ATTRIBUTE>
</section>
</mapping>

The element <section> defines a section which represents an attribute segment.

Attribute of element <section>


Attribute Values Description
DTypes are referenced to this attribute segment with
name="..." Name of attribute division
this name in the file "dtypes.xml".
Name of section:
"STANDARD", Specifies which section is to be included in the section
include_section="..."
"STDMOD", defined here.
"default, etc.
Description of attribute This is a comprehensive description of an attribute
description="..."
sections section.

Within a section, attributes belonging to this attribute section are defined with the sub-element
<APPL_ATTRIBUTE>.

Attributes of the sub-element <APPL_ATTRIBUTE>


Attribute Values Description
Name of the property in the document, possible values are listed in chapter
name="..." Attribute name
"Inventor Properties".
Determines whether this is a helper attribute ("true") or a regular document
hidden="..." true, false
attribute ("false").

Within the attribute definition, the subelement <DIR> addresses document attributes, and the subelement
<MA> addresses material attributes.

CIDEON Software & Services GmbH & Co. KG Page 15 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of subelements <DIR> and <MA>
Attribute Values Description
Name of a field in SAP from which the value for the attribute should be read
out.

field="..." Field Name


Only specific SAP fields are allowed here! A list of allowed SAP fields is
available in the Operations Guide (File "Operations Guide_DE.pdf") in SAP
Engineering Control Center.
(Optional) There may be a line of SAP long text to be transferred together.
row="…" Number 0 - x The value indicates the row, starting with 0. If the specified line is not
present, an error message is generated.
SAP language Identifier of the language in which the long text is stored in SAP, for
language="…"
code example, "EN" = English, "DE" = German.

It is also possible to modify and combine string values read from SAP.

The subelement <CUTLEADING> deletes, for example, leading characters:

Example for subelement <CUTLEADING>

<CUTLEADING character="0">
<DIR field="DOCUMENTNUMBER"/>
</CUTLEADING>

If character="0", "000000004711" will be modified to "4711".

The subelement <XFORMAT> combines the values "DOCUMENTNUMBER" and "DOCUMENTTYPE" read out
from SAP fields into one string:

Example for subelement <XFORMAT>

<XFORMAT outputFormat="{0}/{1}">
<DIR field="DOCUMENTNUMBER"/>
<DIR field="DOCUMENTVERSION"/>
</XFORMAT>

If DOCUMENTNUMBER = "000000004711" and DOCUMENTVERSION = "02", the result is "000000004711/02".

Both subelements can be combined:

Example for combination of subelements <CUTLEADING> and <XFORMAT>

<XFORMAT outputFormat="{0}/{1}">
<CUTLEADING character="0">
<DIR field="DOCUMENTNUMBER"/>
</CUTLEADING>
<DIR field="DOCUMENTVERSION"/>
</XFORMAT>

In this case, the result is "4711/02".

CIDEON Software & Services GmbH & Co. KG Page 16 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Information regarding further possibilities for attribute mapping and construction of file structure
"attributes-from-sap.xml" can be found in the help file "Operations Guide_EN.pdf" in the SAP
Engineering Control Center, which can be found in folder
"%PLM_INSTDIR%\documentation\Manuals\en"

attributes-to-sap.xml

The attribute transfer from the CAD application to the SAP system is defined in the attribute mapping file
"%PLM_INSTDIR%\applications\inv\customize\config\attributes-to-sap.xml". Upon saving a CAD document, all
attributes will be saved in an XML file in the folder "Additional".

The SAP Engineering Control Center reads the attribute from this file depending on the configurations in the
attribute mapping file "attributes-to-sap.xml" and places the values into the SAP system.

For attribute transfer, the sections defined in the file "attributes-to-sap.xml" are used. Here, the name of the
section of the given name in the element <primary_application attribute_section="%Name of section%"...>
must agree with a DType definition in the file "dtype.xml". Within this section, attributes to be transferred can
now be defined.

Example for attribute mapping sections in the file "attributes-to-sap.xml"

<mapping>
<section name="GENERIC" description="Document attribs from CAD to SAP"
include_section="STANDARD">
<DIR field="LONGTEXT" language="EN"> <APPL_ATTRIBUTE name="DESCRIPTION_EN"/> </DIR>
</section>
<section name="STDMOD" description="Material attribs from CAD to SAP"
include_section="STDMOD">
<MA field="MATL_DESC"> <APPL_ATTRIBUTE name="SAP_DESCRIPTION"/> </MA>
</section>
</mapping>

Here too, the element <section> defines a section which represents an attribute section.

Attribute of element <section>


Attribute Values Description
DTypes are referenced to this attribute section with this
name="..." Name of attribute section
name in the file "dtype.xml".
Name of the section:
"STANDARD", Specifies which section is to be included in the section
include_section="..."
"STDMOD", defined here.
"default", etc.
Description of attribute This is a comprehensive description of an attribute
description="..."
sections section.

Within a section, the subelement <DIR> and the subelement <MA> addresses fields of the document or
material, respectively, which can be changed in SAP.

Attributes of subelements <DIR> and <MA>


Attribute Values Description

CIDEON Software & Services GmbH & Co. KG Page 17 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Name of the document or material field which can be changed in SAP.

field="..." Field Name ATTENTION:


Only specific SAP fields are allowed here! A list of allowed SAP fields is
available in the Operations Guide (File "Operations Guide_EN.pdf") in SAP
Engineering Control Center.
(Optional) If field="LONGTEXT", the identifier of the language will be given
SAP language
language="…" in long text to be stored in SAP. Example "EN" = English, "DE" = German,
code
etc.

Within a section, attributes belonging to this attribute section are defined with the sub-element
<APPL_ATTRIBUTE>.

Attributes of the sub-element <APPL_ATTRIBUTE>


Attribute Values Description
name="..." Field Name SAP into which it will be written.

Configuration possibilities for drawings

To configure the creation of drawings, various attributes can be mapped in the "attributes-to-sap.xml" file.

Example of attribute mapping for drawings in the "attributes-to-sap.xml" file

<mapping>
<section name="INVMDL" description="Mapping from INVENTOR 3D to SAP">
</section>
<section name="INVDRW" description="Mapping from INVENTOR 2D to SAP">
<DIR_CLS transfer_empty_value="false" neutral="true" characteristic="ZDMS_SHEETS"
classtype="017"
class="ZDMS_CAD_DOC_CLASS">
<APPL_ATTRIBUTE name="DP-Sheets" hidden="false"/>
</DIR_CLS>
<DIR_CLS transfer_empty_value="false" neutral="true" characteristic="ZDMS_SHEETS"
classtype="017"
class="ZDMS_CAD_DOC_CLASS">
<APPL_ATTRIBUTE name="DP-Sizes" hidden="false"/>
</DIR_CLS>
<DIR_CLS transfer_empty_value="false" neutral="true" characteristic="ZDMS_SHEETS"
classtype="017"
class="ZDMS_CAD_DOC_CLASS">
<APPL_ATTRIBUTE name="DP-SheetSize" hidden="false"/>
</DIR_CLS>
<DIR_CLS transfer_empty_value="false" neutral="true" characteristic="ZDMS_SHEETS"
classtype="017"
class="ZDMS_CAD_DOC_CLASS">
<APPL_ATTRIBUTE name="DP-SheetNumber" hidden="false"/>
</DIR_CLS>
<DIR_CLS transfer_empty_value="false" neutral="true" characteristic="ZDMS_SHEETS"
classtype="017"
class="ZDMS_CAD_DOC_CLASS">
<APPL_ATTRIBUTE name="DP-ViewScales" hidden="false"/>
</DIR_CLS>
</section>
</mapping>

Again, the <section> element defines a section that represents an attribute section. Within the section, the
subelement <DIR_CLS> defines the attribute class.

CIDEON Software & Services GmbH & Co. KG Page 18 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the sub-element <DIR_CLS>
Attribute Values Description
Defines whether empty attribute values can be
transfer_empty_value="..." true, false
transferred ("true") or not ("false").
Defines whether the neutral attribute value is used
neutral="..." true, false
("true") or not ("false").
characteristic="..." "ZDMS_SHEETS" Name of the attribute class.
classtype="..." "017" SAP class type (here: "017" = document class).
class="..." "ZDMS_CAD_DOC_CLASS" Name of the class in which the attribute occurs.

The attribute belonging to this attribute section is defined by the sub-element <APPL_ATTRIBUTE>. The name
of the attribute is defined here and whether the attribute is transferred to the application or is only used as a
temporary auxiliary attribute.

Attributes of the sub-element <APPL_ATTRIBUTE>


Attribute Values Description
name="..." Name Name of the attribute.
hidden="..." true, false Determines whether this attribute is an auxiliary attribute ("true") or not ("false").

The attributes that can be transferred are listed in the chapter "Inventor Properties".

NOTE:
Determining attributes that are not file properties (virtual properties) can have a negative effect
on performance. The configuration switch "plm.options.deliverOnlyRequestedAttributesToSAP.INV
= true" can be used to specify that only the configured properties are to be read! This
influences the use of properties when creating a document! Please see description of the
configuration switch!

Mapping of CAD properties to language-dependent description fields for Import on Demand

If the CAD files contain attributes (properties) that contain the description of a part in different languages
(short text) and if these CAD file properties are to be mapped to the language-dependent description of the
document info record (DIS) during Import on Demand (IoD), the mapping must be done using the attribute
"_DOCDESCR":

Example for the mapping of short texts in the file "attributes-to-sap.xml"

<mapping>
<section name="my_attrib_section" description="mapping during IoD">
<DIR field="SAP_DESCRIPTION" language="DE" >
<APPL_ATTRIBUTE name="SAP_DOCTEXT_DE" />
</DIR>
<DIR field="SAP_DESCRIPTION" language="EN" >
<APPL_ATTRIBUTE name="SAP_DOCTEXT_EN" />
</DIR>
<APPL_ATTRIBUTE name="_DOCDESCR" >
<APPL_ATTRIBUTE name="SAP_DOCTEXT_EN" />
</APPL_ATTRIBUTE >
</section>
...
</mapping>

CIDEON Software & Services GmbH & Co. KG Page 19 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Information regarding further possibilities for attribute mapping and construction of file structure
"attributes-to-sap.xml" can be found in the help file "Operations Guide_EN.pdf" in the SAP
Engineering Control Center, which can be found in folder
"%PLM_INSTDIR%\documentation\Manuals\en".

Inventor Properties

General information

The following describes the Inventor properties provided by the SAP Engineering Control Center Interface to
Inventor. The properties can be used in the files "attributes-to-sap.xml" and "attributes-from-sap.xml" for
matching with SAP data.

The properties consist of a prefix and the property name. The prefix indicates the property page in which the
property is located. This allows you to distinguish between the property "Description" on the property page
"Project" and the property page "Custom".

The SAP Engineering Control Center Interface to Inventor also provides virtual property sets that do not exist in
Inventor, such as the "Drawing Properties" (prefix "DP-"). These cannot be obtained using Inventor's property
sets.

Further information on the individual Inventor properties can also be found in the Inventor API Help:

Inventor help menu

The respective API topics are listed in the following description of the property categories under "API-Help
Topic".

NOTE:
Depending on the language package installed in Inventor, the transfer of number values may
differ in decimal form. Please refer to the file "plm_metainf-cad.xml" in the folder of the respective
document in the working directory. This contains the real transferred values.

CIDEON Software & Services GmbH & Co. KG Page 20 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Property Categories

There are the following categories of properties:

Summary Information
Document Summary Information
Design Tracking Properties
Userdefined Properties
Content Library Component Properties
Drawing Properties
Environment Properties
Physical Properties
SheetMetal Properties
Version Properties

Overview of Inventor properties

Real Inventor properties

Category: Summary Information


Prefix: SI-
API-Help Topic: PropertiesForSummaryInformationEnum Enumerator

Inventor Summary Information Properties


Name ReadOnly User Interface Comment
SI-Title Summary Page
SI-Subject Summary Page
SI-Author Summary Page
SI-Keyword Summary Page
SI-Comments Summary Page
SI-Last Saved By Summary Page
SI-Revision Number Summary Page
SI-Thumbnail X Project Page Not available

Category: Document Summary Information


Prefix: DSI-
API-Help Topic: PropertiesForDocSummaryInformationEnum Enumerator

Inventor Document Summary Information Properties


Name ReadOnly User Interface Comment
DSI-Category Summary Page
DSI-Company Summary Page
DSI-Manager Summary Page

Category: Design Tracking Properties


Prefix: DTP-
API-Help Topic: PropertiesForDesignTrackingPropertiesEnum Enumerator

Inventor Design Tracking Properties

CIDEON Software & Services GmbH & Co. KG Page 21 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Name ReadOnly User Interface Comment
DTP-Appearance X
DTP-Authority Project Page
DTP-Catalog Web Link Project Page
DTP-Categories X XML-String
DTP-Checked By Status Page
DTP-Cost Center Project Page
DTP-Cost Project Page
DTP-Creation Time X Project Page
DTP-Date Checked Status Page
DTP-Density X
DTP-Description Project Page
DTP-Designer Project Page
Numbers will be delivered:
'0' = Not set
DTP-Design Status Status Page '1' = Work in Progress
'2' = Pending
'3' = Released
DTP-Display Name Model Tab Display name of document
DTP-Document SubType X CLSID of the document
DTP-Document SubType Name X
DTP-Defer Updates
DTP-Engineer Project Page
DTP-Engr Approved By Status Page
DTP-Engr Date Approved Status Page
DTP-External Property Revision Id
DTP-Flat Pattern Defer Update
DTP-Flat Pattern Area X
DTP-Flat Pattern Length X
DTP-Flat Pattern Width X
DTP-Language X language specified in ISO 639-2 alpha-3
DTP-Last Updated With X Detail Page
DTP-Manufacturer
DTP-Mass X
DTP-Material X Material Page
DTP-Material Identifier X
DTP-Mfg Approved By Status Page
DTP-Mfg Date Approved Status Page
DTP-Parameterized Template X
DTP-Part Icon X Not available

CIDEON Software & Services GmbH & Co. KG Page 22 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
DTP-Part Number X Project Page
DTP-Part Property Revision Id
DTP-Project Project Page
DTP-Proxy Refresh Date X
DTP-Sheet Metal Area X
DTP-Sheet Metal Length X
DTP-Sheet Metal Rule X
DTP-Sheet Metal Width X
DTP-Size Designation
DTP-Standard
DTP-Standard Revision
DTP-Standards Organization
DTP-Stock Number Project Page
DTP-SurfaceArea X
DTP-Template Row X
DTP-User Status Status Page
DTP-Valid MassProps X Bit flags
DTP-Vendor Status Page
DTP-Volume X
DTP-Weld Material X

Category: User-defined Properties


Prefix: None or UDP-
API-Help Topic: PropertiesForUserDefinedPropertiesEnum Enumerator

Inventor User-defined Properties


Name ReadOnly User Interface Comment
Property with prefix
UDP-[name] Custom Page
[name] = User-defined property name
Property without prefix
[name] Custom Page
[name] = User-defined property name

User-defined properties can be used with or without a prefix. It is recommended that you always
use the prefix (UDP-). If you use the Interop scenario with AutoCAD, this is also mandatory. To
activate the prefix, the preference "plm.options.updateAttributes.useInteropPrefix.INV" must be
set to "true".

Category: Content Library Component Properties


Prefix: CLCP-
API-Help Topic: PropertiesForContentLibraryEnum Enumerator

Inventor Content Library Component Properties


Name ReadOnly User Interface Comment
CLCP-Component Type X Not valid

CIDEON Software & Services GmbH & Co. KG Page 23 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
CLCP-Family X
CLCP-Family Folder X
CLCP-FamilyId X
CLCP-Family Revision X
CLCP-Family Revision Time X
CLCP-Member X Not valid
CLCP-Member FileName X
CLCP-MemberId X
CLCP-Member Revision X

Virtual Properties

Category: Drawing Properties


Prefix: DP-
API-Help Topic: Not available

Drawing Properties
Name ReadOnly User Interface Comment
DP-SheetNumber X Number of the active sheet (empty if the active sheet is excluded).
DP-Sheets X Number of sheets not excluded from counting.
Size of the active sheet of the drawing as DIN or ISO symbol (e.g., "A2", "A4",
DP-SheetSize X
etc.).
Comma separated list of the different sheet sizes in the drawing as DIN or ISO
DP-Sizes X
symbol (e.g., "A2", "A4" etc.).
Standards of the views on the individual sheets in the following format:
DP-Sheet <sheetNumber>-<Viewname>-Scale

ATTENTION:
The characters'<' and '>' are special symbols within the XML syntax; therefore
DP-Sheet X they must be marked here as part of the name! This is done by the usual HTML
marking:
'<' corresponds to "&lt;", '>' corresponds to "&gt;".

Examples:
"DP-Sheet &lt;1&gt;-&lt;VIEW1&gt;-Scale" --> "5 : 1"
"DP-Sheet &lt;1&gt;-&lt;VIEW2&gt;-Scale" --> "1 : 1"

Category: Environment Properties


Prefix: EP-
API-Help Topic: EnvironmentManager Object

Environment Properties
Name ReadOnly User Interface Comment
EP-Base Display Name X
EP-Base Internal Name X
EP-iCopyDefinition X
EP-IsSubstitutePart X
EP-Override Display Name X
EP-Override Internal Name X

CIDEON Software & Services GmbH & Co. KG Page 24 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Possible values (1):
• SolveAssemblyDoc
EP-Frame Generator X • FrameDoc
• SkeletonDoc
• FrameMemberDoc
Possible values (2):
• Piping Assembly Environment
• Piping Runs Environment
EP-Routed Systems: Tube & Pipe X
• Piping Run Environment
• Piping Route Environment
• Piping Segment

(1): SolveAssemblyDoc: Assembly containing the Frame Generator Assembly


FrameDoc: Frame Generator Assembly
SkeletonDoc: Frame Generator Skeleton Part document
FrameMemberDoc: Frame Generator Frame Part Document

(2): Piping Assembly Environment: Assembly containing the Tube&Pipe Assembly


Piping Runs Environment: Tube&Pipe Assembly
Piping Run Environment: Tube&Pipe Run Assembly
Piping Route Environment: Tube&Pipe Route Part
Piping Segment: Tube&Pipe Pipe Segment

Category: Physical Properties


Prefix: PP-
API-Help Topic: MassProperties Object

Physical Properties
Name ReadOnly User Interface Comment
PP-AreaUnit X Physical Page
PP-AreaValue X Physical Page
PP-CenterOfMassUnit X Physical Page
PP-CenterOfMassXValue X Physical Page
PP-CenterOfMassYValue X Physical Page
PP-CenterOfMassZValue X Physical Page
PP-MassUnit X Physical Page
PP-MassValue Physical Page
PP-PrincipalMomentsOfInertiaI1 X Physical Page
PP-PrincipalMomentsOfInertiaI2 X Physical Page
PP-PrincipalMomentsOfInertiaI3 X Physical Page
PP-RadiusOfGyrationKx X
PP-RadiusOfGyrationKy X
PP-RadiusOfGyrationKz X
PP-RotationToPrincipalRx X Physical Page
PP-RotationToPrincipalRy X Physical Page
PP-RotationToPrincipalRz X Physical Page
PP-VolumeUnit X Physical Page
PP-VolumeValue Physical Page
PP-XYZMomentsOfInertiaIxx X Physical Page
PP-XYZMomentsOfInertiaIyy X Physical Page

CIDEON Software & Services GmbH & Co. KG Page 25 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
PP-XYZMomentsOfInertiaIzz X Physical Page
PP-XYZMomentsOfInertiaIxy X Physical Page
PP-XYZMomentsOfInertiaIyz X Physical Page
PP-XYZMomentsOfInertiaIxz X Physical Page
PP-BoundingBoxX X
PP-BoundingBoxY X
PP-BoundingBoxZ X
PP-BoundingBoxUnit X
Vector that defines the first direction of
PP-BoundingBoxOrientedDirectionOneLength
the OrientedBox object (1).
Vector that defines the second direction
PP-BoundingBoxOrientedDirectionTwoLength
of the OrientedBox object (1).
Vector that defines the third direction of
PP-BoundingBoxOrientedDirectionThreeLength
the OrientedBox object (1).
Corner point X for the OrientedBox object
PP-BoundingBoxOrientedCornerPointX
(1).
Corner point Y for the OrientedBox object
PP-BoundingBoxOrientedCornerPointY
(1).
Corner point Z for the OrientedBox object
PP-BoundingBoxOrientedCornerPointZ
(1).
PP-BoundingBoxOrientedUnit Unit of the OrientedBox object (1).

(1): These properties are only available from Inventor 2024!

Category: SheetMetal Properties


Prefix: SMP-
API-Help Topic: SheetMetalComponentDefinition Object

SheetMetal Properties
Name ReadOnly User Interface Comment
SMP-BendRadiusUnit X
SMP-BendRadiusValue X
SMP-BendReliefDepthUnit X
SMP-BendReliefDepthValue X
SMP-BendReliefWidthUnit X
SMP-BendReliefWidthValue X
SMP-CornerReliefSizeUnit X
SMP-CornerReliefSizeValue X
SMP-LengthUnit X
SMP-LengthValue X
SMP-MinimumRemnantUnit X
SMP-MinimumRemnantValue X
SMP-Thickness X
SMP-ThicknessValue X
SMP-WidthUnit X
SMP-WidthValue X

CIDEON Software & Services GmbH & Co. KG Page 26 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Category: Version Properties
Prefix: VP-
API-Help Topic: SoftwareVersionSaved Property

Version Properties
Name ReadOnly User Interface Comment
VP-DisplayName X
VP-DisplayVersion X
VP-Major X
VP-Minor X
Possible values:
• Inventor LT
• Inventor Suite
• Inventor Professional
• Inventor Routed Systems
VP-ProductEdition X • Inventor Simulation
• Inventor Tooling
• Inventor
• Inventor Factory Premium
• Inventor Factory Ultimate
• Inventor OEM
VP-ProductName X
VP-ServicePack X
Format:
VP-VersionName X
Major.Minor SPServicePack

Inventor Properties in the user interface

Inventor Properties can be viewed for a specific document in the "iProperties" dialog in Inventor, or in the
Properties dialog of the document file in Windows Explorer. Some subpages are only visible in Inventor or
Windows Explorer, others in both dialogs:

CIDEON Software & Services GmbH & Co. KG Page 27 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Summary Page in Inventor and Windows-Explorer

Project Page in Inventor and Windows-Explorer

CIDEON Software & Services GmbH & Co. KG Page 28 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Status Page in Inventor and Windows-Explorer

Custom Page in Inventor and Windows-Explorer

CIDEON Software & Services GmbH & Co. KG Page 29 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Physical Page in Inventor

CIDEON Software & Services GmbH & Co. KG Page 30 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Details Page in Windows-Explorer

default.txt
The file "default.txt" contains basic settings that influence the interaction between the SAP Engineering Control
Center, SAP Engineering Control Center to Inventor and the SAP system.

Further explanations as to the purpose of the file and the individual configuration parameters can
be found in the file "default.txt".

ATTENTION:
• After all changes of options in the file "default.txt" the ECTR must be restarted!
• To be able to use logging with an older ECTR version prior to 5.2 or 5.1.15, the preference
"ECTR-LOG-DIR = @PLM_LOGDIR@" must be set here in the file "default.txt"! From ECTR version
5.2 or 5.1.15 this is no longer necessary and the preference is then obsolete. Further information
about this topic can be found in the user manual in the chapter "Logging".

The following pages "Parameter description - Part 1" and "Parameter description - Part 2" contain the
description of all parameters contained in the "default.txt" file in the delivery state as well as their default
values.

Parameter description - Part 1

The following table contains the first part of the description of all parameters, which are contained in the file
"default.txt" in the delivery state.
The second part follows on the next page, "Parameter description - Part 2"!

CIDEON Software & Services GmbH & Co. KG Page 31 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameters of the file "default.txt" for Inventor - Part 1
Parameter: plm.appl.qat.INV
The ECTR interface commands can also be added to Inventor's Quick Start Toolbar (QAT) as icons for easier access. But when Inventor is closed,
these entries will be removed and will not be in the QAT at the next start. Therefore, the commands which should appear in the QAT can be selected
here. These are set automatically when Inventor is started from the ECTR.
Description:

NOTE:
This only works if Inventor is started from the ECTR!
";"-separated list of command IDs.

The following command IDs are possible:


Values:
CMD_ABOUT, CMD_BALLOONING, CMD_BOM_POPUP, CMD_DEPDIR_POPUP, CMD_DIRCANCELEDIT, CMD_DIRCHECKIN, CMD_DIRCHECKOUT,
CMD_DIRCREATE, CMD_DIRDISPLAY, CMD_DIRIMPORT, CMD_DIRREFRESH_POPUP, CMD_DIRREPLACE, CMD_DIRSAVE, CMD_DIRSAVEAS_POPUP,
CMD_DIRSEARCH, CMD_ECTR, CMD_EXTRAS_POPUP, CMD_OBJECTLISTSET, CMD_SHOW_STRUCTURE_VIEW
Default value: --
Parameter: plm.appl.startViewerCommand.INV
Necessary preference for viewing Inventor files with Inventor Read-Only.

Description: HINTS:
• Requires Inventor 2020 or above!
• This only works if Inventor has been started manually at least once before in ReadOnly mode!
Values: Command line to execute "start_application_inv.exe".
Default value: @PLM_BINDIR_INV@\\start_application_inv.exe -View $(filename)
Parameter: plm.options.ReadOnly.DisabledCommandTypes.INV
Description: Command types can be deactivated for read-only opened documents.
";"-separated list of command types.
Possible values are:
ShapeEdit, QueryOnly, FileOperations, FilePropertyEdit, UpdateWithReferences, NonShapeEdit, ReferencesChange, EditMask, SchemaChange.
Values:

NOTE:
For more information on the command types, please refer to the Inventor API documentation!
Default value: --
Parameter: plm.options.ReadOnly.DisabledCommandList.INV
For read-only opened documents, individual Inventor commands can be deactivated.

Description:
NOTE:
For more information on the internal names of Inventor commands, please refer to the Inventor API documentation!
Values: ";"-separated list of internal names of commands.
Default value: --
Parameter: plm.options.DisableDirtyHandlingForWritingComponentIDs.INV
Description: Determines whether the default handling for documents marked as dirty should be disabled when writing component IDs.
'0' = Dirty handling will be active for writing component IDs
Values: '1' = Dirty handling will be disabled for writing component IDs
'2' = Component IDs will not be written for read only documents
Default value: 0
Parameter: plm.options.checkIn.UpdateAttributesFromSAP.INV
Description: During Save, update attributes of documents to check in from SAP before transferring them to SAP.
"true" = Update attributes before save
Values:
"false" = Do not update attributes beforehand
Default value: false
Parameter: plm.options.OpenInsert.UseLastActiveLevelOfDetail.INV
Decides whether the "Master" level or the active level of detail when checking in to SAP should be used when opening a model via the ECTR.

Description: HINTS:
• This setting is also used when opening via the "Open" dialog.
• The same values can be used here as for the parameter plm.options.OpenInsert.ViewRepresentation.INV.
'0', "true" = Use last active level of detail
Values: '1', "false" = Use "Master" detail level
'2' = Use inventor defined setting
Default value: 0
Parameter: plm.options.OpenInsert.ViewRepresentation.INV
Decides whether the "Master" design view or the active design view when checking in to SAP should be used when opening an assembly via the
ECTR.

Description:
HINTS:
• This setting is also used when opening via the "Open" dialog.
• The same values can be used here as for the parameter plm.options.OpenInsert.UseLastActiveLevelOfDetail.INV.
'0' = Use last active design view
Values: '1' = Use "Master" design view
'2' = Use inventor defined setting

CIDEON Software & Services GmbH & Co. KG Page 32 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Default value: 0
Parameter: plm.options.DeferUpdateOnCheckin.INV
Description: Automatically defer updates of drawings during check in.
"true" = Defer updates during check in
Values:
"false" = Do not defer updates during check in
Default value: false
Parameter: plm.appl.popwin.name.INV
Name (caption text), which the main window of the workstation application identifies to bring it to the foreground. The wild card '*' can be used to
Description:
output a substring.
Values: Name of main window of the workstation application and substring, which is a component of the window name (driven by the wild card '*').
Default value: *Inventor*
Parameter: plm.control.waitForSessionInMs.INV
Description: Defines the time until the application starts and the communication via interface will be established.
Values: Time in ms.
Default value: 15000
Parameter: plm.structure.application.CollectEntries.INV
Description: Determines whether multiple built-up components in the structure overview of the ECTR will be displayed individually or summarily.
"collectNone" = No summary. Every instance will be shown individually
Values:
"collectAll" = Summarize all instances. Only depict and summarize a node with the total
Default value: collectNone
Parameter: plm.structure.application.sendInstancesForGeneric.INV
Description: Determines whether CAD Integration should send all known instances for generics or not.
"true" = CAD Integration should send all known instances for generics
Values:
"false" = CAD Integration must not send instances
Default value: true
Parameter: plm.structure.application.DisplayPosItem.INV
Description: Determines whether virtual components should be shown in structure tree.
"true" = Show virtual components under the corresponding node in the tree
Values:
"false" = Do not show virtual components in the tree
Default value: true
Parameter: plm.structure.application.init.strategy.levels.INV
Description: Number of levels which should be submitted to application structure.
<Number> 1-n = Number of levels
Values:
"all" = Complete structure
Default value: 1
Parameter: plm.structure.application.DisplayExternalReferences.INV
Description: Determines whether external references (i.e. images, parameter files, etc.) are to be displayed in the application structure.
"true" = Display external references
Values:
"false" = Do not display external references
Default value: false
Parameter: plm.structure.application.DisplaySuppressedComponents.INV
Description: Determines whether suppressed components are to be displayed in the application structure.
"true" = Display suppressed components
Values:
"false" = Do not display suppressed components
Default value: false
Parameter: plm.structure.application.show.drawing.INV
Specifies whether referenced drawings are to be displayed in the ECTR application structure.

Description:
NOTE:
This parameter replaces the parameter "plm.structure.application.loadDrawings.INV" which was removed because it is obsolete!
"true" = Show drawings
Values:
"false" = Do not display drawings
Default value: false
Parameter: plm.structure.application.show.drawing.container.INV
Description: Specifies whether referenced drawings in the ECTR application structure are to be displayed in a separate folder within the structure.
"true" = Display referenced drawings from the session directory in a separate folder
Values:
"false" = Added referenced drawings from the session directory below the document node
Default value: false
Parameter: plm.structure.application.show.drawing.container.ontop.INV
Description: Determines at which position referenced drawings in the ECTR application structure should be displayed within the structure.
"true" = The container with the referenced drawing will be shown above the subcomponents
Values:
"false" = The container with the referenced drawing will be shown below the subcomponents
Default value: false
Parameter: plm.structure.application.DisplayAdditionalAttributes.INV

CIDEON Software & Services GmbH & Co. KG Page 33 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether additional file properties should be displayed in the application structure.

Description:
NOTE:
This parameter is optional.
"true" = Show additional file properties
Values:
"false" = Do not show additional file properties
Default value: false
Parameter: plm.structure.application.ExpandDocumentsOnlyOnce.INV
Determines whether the first occurrence of a document node in the application structure should be expanded.
Other occurrences of this document would then not be expanded automatically.
Description:
NOTE:
This parameter is optional.
"true" = Expand the same document only once
Values:
"false" = Expand each occurrence of the same document
Default value: false
Parameter: plm.structure.application.displaysubstitutestructure.INV
Determines whether the substructure of Substitutes should be displayed.

Description:
NOTE:
This parameter is optional.
"true" = Display the substructure of Substitutes
Values:
"false" = Do not show the substructure of Substitutes
Default value: true
Parameter: plm.structure.application.AdditionalAttributes.INV
Defines which file properties should be displayed in the application structure.

Description: NOTES:
• This parameter is optional.
• Component properties can be used to overwrite the file property value.
List of file properties to display, separated by semicolon.
Values:
Example: Prop1;Prop2;Display Name;SAP_CC_NAME
Default value: --
plm.bom.create.IDW
plm.bom.createAtCheckin.IDW
plm.bom.updateAtCheckin.IDW
plm.bom.update.IDW
plm.bom.create.IPN
plm.bom.createAtCheckin.IPN
plm.bom.updateAtCheckin.IPN
plm.bom.update.IPN
plm.bom.create.IAM
Parameters: plm.bom.createAtCheckin.IAM
plm.bom.updateAtCheckin.IAM
plm.bom.create.IPT
plm.bom.createAtCheckin.IPT
plm.bom.updateAtCheckin.IPT
plm.bom.update.IPT
plm.bom.create.INM
plm.bom.createAtCheckin.INM
plm.bom.updateAtCheckin.INM
plm.bom.update.INM
Description: Defines to which time frame and for which document type a bill of materials should be created or an existing bill of materials should be updated.
"true" = carry out action
Values:
"false" = do not carry out action
Default value: false (for all above-mentioned parameters)
Parameter: plm.document.ExcelAsAdditionalFile.INV
Description: Indicates whether an Excel file (Excel parameter file) should be created as an additional file or as a separate DIR.
"true" = Create Excel file as additional file
Values:
"false" = Create Excel file as separate DIR
Default value: true
Parameter: plm.document.PictureAsAdditionalFile.INV
Description: Indicates whether an image file should be created as an additional file packed inside ecf or as a separate DIR.
"true" = Create image file as additional file
Values:
"false" = Create image file as separate DIR
Default value: true
Parameter: plm.docstructure.deleteBeforeMaintain
Indicates whether the document structure will be reset before maintain.

Description:
ATTENTION:
This is a global setting which applies to all applications! For Inventor, this must be set to "true"!

CIDEON Software & Services GmbH & Co. KG Page 34 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Reset document structure before maintain
Values:
"false" = Do not reset document structure
Default value: true
Parameter: plm.ignore.dtype.use.relative.path.flag
Use or ignore "relative path" flag so cloning is possible for this DTypes if ignored.

Description: ATTENTION:
• Starting with ECTR version 5.2.6 this preference is no longer needed!
• This is a global setting which applies to all applications!
"true" = Use "relative path" flag
Values:
"false" = Ignore "relative path" flag
Default value: true
Parameter: plm.adv.clone.renamerProgram.INV
Description: Defines the path to the program "renamer3inv.exe", which is accountable for cloning.
Values: Path to the program "renamer3inv.exe".
Default value: @PLM_BINDIR_INV@\\renamer3inv.exe
Parameter: plm.document.SaveAsNewDocument.CheckOutTop.INV
Description: Determines whether the "Save as new document" and "Save as new version" functions should automatically check out the superior open document.
'0' = do not check out
Values: '1' = check out
'2' = check out and save (intermediate)
Default value: 1
Parameter: plm.options.ReplaceVersion.CheckoutParents.INV
Description: Determines whether all parent documents should be automatically checked out when the version of a document is replaced.
"true" = Check-out of all parent documents
Values:
"false" = Do not check out parent documents
Default value: false
Parameter: plm.options.SaveAsNewDocument.Replace.INV
Description: Defines the method for replacing references in the "Save as new document" function.
'0' = Replace in all open views without a warning dialog
'1' = Replace only in active view without a warning dialog
'2' = Replace in all open views after displaying a warning dialog
Values: '3' = Replace only in active view with a warning dialog
'4' = Do not replace references
'5' = Replace only in copied drawings
'6' = Replace only in copied documents
Default value: 0
plm.control.extension.WsAppl.ipt
plm.control.extension.WsAppl.iam
Parameters: plm.control.extension.WsAppl.ipn
plm.control.extension.WsAppl.idw
plm.control.extension.WsAppl.ide
Every document type of application must be assigned a workstation application. If this is missing here, the current file extension will be used as a
Description:
workstation application.
Values: Abbreviation of the workstation application.
Default value: INV
plm.document.dtype.iPartMember.INV = IPTNR
plm.document.dtype.iPartFactory.INV = IPT
plm.document.dtype.iAssemblyMember.INV = IAMNR
plm.document.dtype.iAssemblyFactory.INV = IAMNR
plm.document.dtype.ContentMember.INV = IPTCC
plm.document.dtype.SheetMetal.INV = IPTSM
plm.document.dtype.Weldment.INV = IAMWM
plm.document.dtype.Mold.INV = IAMMO
Parameters: plm.document.dtype.FrameGenerator.Assembly.INV = IAM
plm.document.dtype.FrameGenerator.Sketch.INV = IPT
plm.document.dtype.FrameGenerator.Member.INV = IPT
plm.document.dtype.FactoryDesign.Asset.IPT.INV = IPTNR
plm.document.dtype.FactoryDesign.Asset.IAM.INV = IAMNR
plm.document.dtype.FactoryDesign.LayoutTemplate.INV = IAM
plm.document.dtype.AIP.IPT.INV = IPT
plm.document.dtype.AIP.IAM.INV = IAM
plm.document.dtype.<LibName>.<type>.INV = <DTYPE>
Optional assignment of DTypes to individual Inventor document types.
Special DTypes can be assigned for individual libraries. The <LibName> and <type> - IAM / IPT must be specified.
If these DTypes are preconfigured here, they cannot be changed by the user!

Description:
IMPORTANT:
• When using mold assemblies, note the notes under "Creating mold assemblies with "ECTR New""!
• For iPartMember, iAssemblyMember, iAssemblyFactory, ContentMember it is imperative that the DType attribute "rename_template_filename" in
"document_create" is set to "false"!
Values: Identifiers of assigned DType as defined in file "dtypes.xml".
Default value: See under Parameters

CIDEON Software & Services GmbH & Co. KG Page 35 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
plm.document.dtype.Default.IPT.INV = IPT
plm.document.dtype.Default.IAM.INV = IAM
Parameters:
plm.document.dtype.Default.IDW.INV = IDW
plm.document.dtype.Default.IPN.INV = IPN
Description: Defines default dtype assignments.
Identifiers of assigned DType as defined in "dtypes.xml".

Values:
ATTENTION:
"IPT", "IAM", "IDW" and "IPN" are not the SAP document types!
Default value: See under Parameters
Parameter: plm.document.createMulti.cad.dtype.searchAlso.INV
Description: Specifies non Inventor DTypes that should be considered for import.
Values: A list of DTypes, separated by ';'
Default value: CPA;PICP;PICG;PICT;PICJ
Parameter: plm.document.genericDTypes.INV
Description: Assignment of a DType to a generic type.
Values: A list of identifiers of assigned DType as defined in "dtypes.xml", separated by ';'.
Default value: IPTNR;IAMNR;IPT
plm.document.variantDType.IPTNR = IPTNR
Parameters: plm.document.variantDType.IAMNR = IAMNR
plm.document.variantDType.IPT = IPTNR
Description: Assignment of variant DTypes to a generic types.
Values: Identifiers of assigned DType as defined in file "dtypes.xml".
Default value: See under Parameters
Parameter: plm.options.importOnDemand.TransferAttributesToSAP.INV
Description: Specifies whether the CAD attributes should be updated during import (ImportOnDemand function) or not.
"true" = update
Values:
"false" = no update
Default value: true
Parameter: plm.options.StructureAnalysis.MinimumErrorLevel.INV
Description: Defines the minimum error level for problems to be displayed in the error dialog box during structural analysis.
'0' = Never show error dialog (not recommended!)
'1' = Show error dialog only if errors found
Values:
'2' = Show error dialog if errors or warnings found
'3' = Always show dialog
Default value: 3
Parameter: plm.options.importOnDemand.loadDrawings.INV
Description: Specifies whether drawings should be loaded during import (ImportOnDemand function) or not.
"true" = Load drawings
Values:
"false" = Do not load drawings
Default value: false
Parameter: plm.options.importOnDemand.resetOccurrenceName.INV
Description: Determines whether overwritten names of individual occurrences in the imported structure are to be reset to the component name.
"0" = Do not reset occurrence names
Values: "1" = Reset all occurrence names
"2" = Only reset occurrence names of new imported occurrences
Default value: 1
Parameter: plm.options.save.loadDrawings.INV
Description: Defines whether drawings should be loaded on save or not.
"true" = Load drawings
Values:
"false" = Do not load drawings
Default value: false
Parameter: plm.options.openAllReferencesToReadInstanceIDs.INV
Description: Specifies whether all references in a document are to be opened to compare the instance IDs with SAP.
"true" = Open all references
Values:
"false" = Do not open all references
Default value: false
Parameter: plm.options.Open.CopyFeaFiles.INV
Description: Use internal interface logic or script to copy stress analysis files from the Additional directory to the FEM directory when opened.
"true" = Copy files
Values:
"false" = Do not copy files
Default value: false
Parameter: com.cideon.file.handler.copy.<DTYPE>

CIDEON Software & Services GmbH & Co. KG Page 36 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Enables the CIDEON FileHandler Add-on to process additional files when an original of a specific DType is provided in the session.

These parameters specify copy tasks:

1. Set copy tasks (freely chosen names) when an original is provided in the session:
com.cideon.file.handler.copy.<DTYPE>.tasks = <TASK1>;<TASK2>
Example: bak-file

2. Set source directory for the copy operation:


com.cideon.file.handler.copy.<DTYPE>.<TASKx>.source = <SOURCE>
Supported token: "$(AddFileDir)" (default).
Description:
3. Target directory for the copy operation:
com.cideon.file.handler.copy.<DTYPE>.<TASKx>.target = <TARGET>
Supported token: "$(MasterOriginalDir)"

4. Filename pattern in glob syntax for the copy task:


com.cideon.file.handler.copy.<DTYPE>.<TASKx>.content = <GLOB>
Example: glob:**\\\\$(MasterOriginalName).bak

5. Remove write-protect flags from copied files:


com.cideon.file.handler.copy.<DTYPE>.<TASKx>.removeReadOnly
Optionen: "true" = Remove the write protection flags
"false" = Do not remove write-protect flags (default)
Values: See under Description!
com.cideon.file.handler.copy.IPT.tasks = fea-files
Default value: com.cideon.file.handler.copy.IPT.fea-files.content= glob:**\\\\$(MasterOriginalName)\\\\**
com.cideon.file.handler.copy.IPT.fea-files.target = $(MasterOriginalDir)
Parameter: com.cideon.file.handler.delete.<DTYPE>
Enables the CIDEON FileHandler Add-on to process additional files when an original of a specific DType is provided in the session.
These parameters specify delete tasks when an original is removed from the session:

1. Set deletion tasks (freely chosen names) when an original is removed from the session:
com.cideon.file.handler.delete.<DTYPE>.tasks = <TASK1>;<TASK2>
Example: bak-file
Description:
2. Target directory for the delete operation:
com.cideon.file.handler.delete.<DTYPE>.<TASKx>.target = <TARGET>
Supported Token: "$(MasterOriginalDir)"

3. Filename pattern in glob syntax for the delete operation:


com.cideon.file.handler.delete.<DTYPE>.<TASKx>.content = <GLOB>
Example: glob:**\\\\$(MasterOriginalName).bak
Values: See under Description!
com.cideon.file.handler.delete.IPT.tasks = fea-files
Default value: com.cideon.file.handler.delete.IPT.fea-files.content= glob:**\\\\$(MasterOriginalName)\\\\**
com.cideon.file.handler.delete.IPT.fea-files.target = $(MasterOriginalDir)
Parameter: plm.options.deliverOnlyRequestedAttributesToSAP.INV
Description: Deliver only requested or all available attributes to SAP.
"true" = Deliver only requested attributes
Values:
"false" = Deliver all attributes
Default value: true
Parameter: plm.options.updateAttributes.useInteropPrefix.INV
Description: Specifies whether to use the prefix "UDP-" for user-defined properties for the interop scenario with AutoCAD.
"true" = Use prefix "UDP-"
Values:
"false" = Do not use prefix "UDP-"
Default value: false
Parameter: plm.options.createDIRForNewDocument.INV
Description: Determines how the interface should react when the user calls the CAD function "New".
'0' = A new unmanaged file is created and opened with the CAD function
Values: '1' = A new file is created and opened in SAP
'2' = The user is asked each time whether he wants to create and open a file via SAP or locally
Default value: 2
Parameter: plm.options.SapOpenForCadOpenDocument.INV
Description: Determines how the interface should react when the user calls the CAD function "Open".
'0' = Open file with CAD standard function
Values: '1' = One or more files can be opened from SAP
'2' = The user is asked each time whether he wants to open from SAP or locally
Default value: 2
Parameter: plm.options.SapOpenForCadPlaceDocument.INV
Description: Indicates which "Place Document" dialog should be used..
'0' = use the Inventor standard dialog
Values: '1' = use the ECTR dialog
'2' = ask the user
Default value: 2

CIDEON Software & Services GmbH & Co. KG Page 37 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameter: plm.options.SapOpenForLoadDrawing.INV
Description: Indicates which dialog will be used for loading document from SAP when load a drawing.
'0' = use the Inventor standard dialog
Values: '1' = use the ECTR dialog
'2' = ask the user
Default value: 2
Parameter: plm.options.SapSaveAsNewDocumentForCadSaveAs.INV
Description: Specifies whether it is possible to save as a new document in SAP during the execution of the Inventor function "Save As".
'0' = Do not save as a new document in SAP
Values: '1' = Always save as a new document in SAP
'2' = The user is asked each time whether to save as a new document in SAP
Default value: 0
Parameter: plm.options.SapSaveAsNewDocumentForCadSaveCopyAs.INV
Description: Specifies whether a save as a copy can be performed in SAP during the execution of the Inventor function "Save copy as".
'0' = Do not save as copy in SAP
Values: '1' = Always save as copy in SAP
'2' = The user is asked each time whether to save as a copy in SAP
Default value: 0
Parameter: plm.options.SaveAsNewDocument.SubstitutePartHandling.INV
Description: Selects the procedure for handling Substitute Level Of Detail (LOD) parts in assemblies in SaveAsNewDocument.
'0' = Keep as is
Values '1' = Delete substitute LOD
'2' = Copy substitute LOD
Default value: 0
Parameter: plm.options.open.UseMultiSearchForSapOpen.INV
Choose which ECTR open dialog should be used when opening a document from SAP. Enabling this option will let you open multiple documents at
Description:
once. Otherwise, the single search dialog will be used, which allows exactly one document to be opened.
"true" = Use multi search dialog
Values:
"false" = Use single search dialog
Default value: false
Parameter: plm.options.OpenInsert.ShowLoadOptionsDialog.INV
Description: Defines whether the dialog "File Open Options" should be displayed when opening or inserting files from ECTR.
"true" = Show dialog
Values:
"false" = Do not show dialog
Default value: true
Parameter: plm.options.EmbedExcelOnInsert.INV
Description: Defines if Excel files loaded from SAP should be embedded or not.
'0' = Do not embed
Values: '1' = Embed
'2' = ask the user
Default value: 0
Parameter: plm.document.addcomponent.allowed.dTypeList.INV
Determines which DTypes are available when inserting.

Description:
ATTENTION:
If this preference is set, the preference plm.document.addComponent.notAllowed.documentTypeList is ignored.
Values: List of DTypes, separated by ';'.
Default value: IPTML;IAMLT;SWPRT;ACAD
Parameter: plm.options.Ballooning.BalloonContent.INV
Description: Sets the content of balloons.
'0' = Material and SAP balloon content
'1' = Material number
Values:
'2' = BOM item number
'3' = SAP balloon content
Default value: 2
Parameter: plm.options.Ballooning.BalloonContent.Override.INV
Description: Balloon content value.
"true" = Set override value
Values:
"false" = Set value (partslist)
Default value: true
Parameter: plm.options.Ballooning.InitializeBalloonWith.INV
Description: Initialization of balloons with the specified string for balloons that could not be supplied with data from SAP.
Values: String for initialization.
Default value: "--"
Parameter: plm.options.MissingReferenceReloadOption.INV
Description: Define behavior if CAD notices a missing component file when loading an assembly.

CIDEON Software & Services GmbH & Co. KG Page 38 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
'0' = Use CAD behavior
Values: '1' = Load component from SAP automatically
'2' = Ask user for loading the missing component from SAP
Default value: 0
Parameter: plm.options.checkForUpdates.before.CheckoutEdit.MultiLevel.INV
Determines whether the complete structure or only the directly referenced documents should be checked using CheckForUpdates before a
Description:
CheckoutEdit action.
"true" = The complete structure will be checked
Values:
"false" = Only the directly referenced documents are checked
Default value: true
Parameter: plm.options.checkForUpdates.before.CheckoutEdit.ExplosionScenario.INV
Description: When using the MultiLevel-CheckForUpdate, this preference can be used to specify a explosion scenario that can be customized using CDESK_CUS.
Values: Explosion scenario according to the values possible in CDESK_CUS.
Default value: CAD_LOAD
Parameter: plm.loadoptions.versionConflictResolveMode.INV
Resolves version conflicts when multiple versions of the same DIR are required.
Use this parameter when the filename includes version numbers and the load option "As last saved" is being used.
Description:
NOTE:
This parameter Is commented out by default!
"highest_in_structure" = Only highest versions are loaded
Values: "all" = Always load all versions for all documents
"auto" = Load only necessary versions
Default value: --
Parameter: plm.options.ContentCenterPrimaryLanguage.INV
Sets the primary language of the content center library.

Description: NOTES:
• If no value configured, there will be no restriction on generating new content center parts.
• This parameter Is commented out by default!
Values: Language ID (e.g. "en-us")
Default value: --
Parameter: plm.options.ChangeDtype.INV
Allows you to change a DType when checking in. This only changes the DType in the database and no further checks are performed.

Parameter construction:
plm. options. ChangeDtype. INV.[OLD_DTYPE] = <List of new document categories>

Description: Example: "plm.options.ChangeDtype.INV.IPT = IPTSM"

ATTENTION:
• Use this option with extreme caution!
• The use of this option is at your own risk!
• Do not use this option to switch to generic DTypes!
Values: List of DTypes, separated by ';'.
Default value: --
Parameter: plm.options.TemplateProject.INV
Here, it is possible to specify the path to a project file, which is used as a template for the ECTR project file. The directories for "Working directory"
and "Template directory" are adapted to the current settings in the ECTR at runtime.
Description:
IMPORTANT:
The path has to be written with '\\' as separator, e.g.: "C:\\Templates\\InventorTmp.ipj"!
Values: Template file name with path.
Default value: --
Parameter: plm.options.TemplateFiles.INV
Path to Inventor templates that should be used in the ECTR Inventor project file

Description:
IMPORTANT:
The path has to be written with '\\' as separator, e.g.: "@PLM_INSTDIR_CONF@\\applications\\inv\\templates\\2019"!
Value: Path to Inventor templates
Default value: @PLM_INSTDIR_CONF@\\applications\\inv\\templates\\2019
plm.options.PresetsPath.INV
Parameter: plm.options.DesignDataPath.INV
plm.options.ContentCenterPath.INV
Sets paths that are used as Inventor folder options in the ECTR Inventor project file.

Description: IMPORTANT:
• These paths are also set when a template project is used.
• The path must be written with '\\' as separator, e.g.: "@PLM_FILESPACE@\\sess\\@PLM_USER@\\ContentCenter"!
Value: Paths to Inventor folder options

CIDEON Software & Services GmbH & Co. KG Page 39 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Default value: --

Parameter description - Part 2

The following table contains the second part of the description of all parameters contained in the "default.txt"
file in the delivery state.
The first part is included on the previous page "Parameter description - Part 1"!

Parameters of the file "default.txt" for Inventor - Part 2


Parameter: plm.options.Thumbnail.ViewOrientation.INV
Description: Defines the view orientation for generating thumbnail images.
'0' = Top
'1' = Right
'2' = Back
'3' = Bottom
'4' = Left
Values: '5' = Front
'6' = IsoTopRight
'7' = IsoTopLeft
'8' = IsoBottomRight
'9' = IsoBottomLeft
'11' = Current
Default value: 6
Parameter: plm.options.Thumbnail.Size.INV
Description: Sets the size of thumbnails for the ECTR preview.
Value: Size of the thumbnails in pixels. Applies to height and width.
Default value: 180
Parameter: plm.options.Thumbnail.INV.jpg.<preference>

CIDEON Software & Services GmbH & Co. KG Page 40 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
It is possible to configure the creation of thumbnails.

ATTENTION:
Currently, only the JPEG format "jpg" is allowed!

Several settings are possible for the selected file format. These are selected via <preference>.

Possible options for <preference> are:

1.) "size": This is the resolution (height and width) used for the preview image. If "size" is not set, the value of the parameter
"plm.options.Thumbnail.Size.INV" is used.

Example:
plm.options.Thumbnail.INV.jpg.size = 180

2.) "fileformat": Specifies a rule how the file name of the thumbnail file is to be formed. There are different placeholders (tokens) available, which
are replaced by corresponding values:
$(DOCNUMBER)
$(DOCTYPE)
$(DOCVERSION)
$(DOCPART)
$(ORIGINALFILENAME)
$(ORIGINALEXTENSION)

Example:
plm.options.Thumbnail.INV.jpg.fileformat = $(ORIGINALFILENAME).preview

Description:
IMPORTANT:
If the file name is configured in such a way that the ".preview" extension is no longer contained or otherwise named, the "filename_pattern"
parameter in the "<save_direct>" and "<delete_in_session>" areas of the configuration file "dtype.xml" must be adjusted.
Furthermore, it should be noted that without ".preview" for the preview image (with corresponding adjustment in configuration file "dtype.xml"),
problems can occur if linked JPG files are used in the constructions, since no distinction between preview image and linked image is made here.

NOTE:
If the preference is not set, the preview image will be created as "$(ORIGINALFILENAME).preview.jpg".

3.) "keepExtension": Determines whether the token "$(ORIGINALFILENAME)" keeps the extension of the master original or whether it is removed.

Possible values are:


"true" = The extension of the master original remains unchanged
"false" = The extension of the master original will be removed

Example:
plm.options.Thumbnail.INV.jpg.keepExtension = true

4.) "UseMonochromBackground": The ECTR removes the background from preview images by using the color of the pixel at position 0,0 as the mask
color. For this to work, the preview images generated by the interface must have a monochrome background.

Possible values are:


"true" = Preview images with monochrome background are generated.
"false" = The background of the generated preview images is not monochrome.

Example:
plm.options.Thumbnail.INV.jpg.UseMonochromBackground = true
Values: See under Description!
plm.options.Thumbnail.INV.jpg.fileformat = $(ORIGINALFILENAME).preview
plm.options.Thumbnail.INV.jpg.keepExtension = true
Default value:
plm.options.Thumbnail.INV.jpg.size = 180
plm.options.Thumbnail.INV.jpg.UseMonochromBackground = false
Parameter: plm.document.variantKeepVersion.INV
Description: Decided whether generic factories should keep member when versioned or not.
"true" = Keep member
Values:
"false" = Don't keep member
Default value: true
Parameter: plm.options.MakeComponents.TargetAssemblyHandling.INV
Description: Determines how a new DIR can be created for the target assembly during function "Make Components".
"0" = A dialog will prompt whether to create a new DIR
Values:
"1" = The target assembly has to be named "SAP_GENERATED_NAME.iam" to create a new DIR for it.
Default value: 0
Parameter: plm.options.MakeComponents.AttributesToCopy.INV
Decided which document attributes will be copied from the source part to the new created documents during function "Make Components".

Description:
IMPORTANT:
Only custom properties are supported!
Values: A list of custom property names, separated by ';'.
Default value: --
Parameter: plm.options.MakeComponents.CreateDark.INV

CIDEON Software & Services GmbH & Co. KG Page 41 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether the function "Make Components" should be executed in dark mode, or whether the ECTR import dialog for external number
assignment should be displayed.

Description:
NOTE:
If documents are created dark with "Make Components", they each automatically receive their own DIR. Using the ECTR import dialog, the number
assignment can be done externally, that means manually.
"true" = Create dark
Values:
"false" = ECTR import dialog will be shown
Default value: true
Parameter: plm.options.OnDirty.CheckedIn.allowed.INV
Description: Defines the options offered in the checkout dialog, which can be selected when a checkout is rejected (radio button "No" selected).
'0' = Not allowed, only revert (always available)
'1' = Allow, modification only in memory (not recommended!)
Values:
'2' = Allow, modification in local file (set read/write)
'3' = All three options are provided
Default value: 0
Parameter: plm.options.UpdateAttributes.UpdateReadOnly.INV
Description: Refresh attributes on ReadOnly documents in structure.
"true" = Attributes of ReadOnly documents will be refreshed
Values:
"false" = Don't refresh attributes of ReadOnly documents
Default value: true
Parameter: plm.options.UpdateAttributes.RefreshContext.INV
Description: Specify which documents will be effected during attribute refresh.
'0' = Refresh the complete structure
Values: '1' = Refresh only the selected / top document
'2' = Ask user
Default value: 0
plm.om.DOC.containers.IPT =
MASTERMODEL;OLINKS;FAMILY_TEMPLATE;FAM_MEMBER;VERSIONS;SOURCEDOC;ORIGINALS;COMPS;
SMART_CONT(MACRO_INV_IPN);SMART_CONT(MACRO_INV_IDW);WLINKS; WHEREUSED;CLASSES;CADVARS
plm.om.DOC.containers.IAM = MASTERMODEL;OLINKS;FAMILY_TEMPLATE;FAM_MEMBER;VERSIONS;
Parameters: SOURCEDOC;ORIGINALS;COMPS;SMART_CONT(MACRO_INV_IPN);SMART_CONT(MACRO_INV_IDW); WLINKS;WHEREUSED;CLASSES;CADVARS
plm.om.DOC.containers.IPN = MASTERMODEL;OLINKS;VERSIONS;SOURCEDOC;ORIGINALS;COMPS;
SMART_CONT(MACRO_INV_IDW);WLINKS;WHEREUSED;CLASSES
plm.om.DOC.containers.IDW = MASTERMODEL;OLINKS;VERSIONS;SOURCEDOC;ORIGINALS;COMPS;
SMART_CONT(MACRO_INV_IDW);WLINKS;WHEREUSED;CLASSES
Description: Assignment of containers to document types.
Values: List of containers, separated by ';'.
Default value: See under Parameters.
plm.smart.container.MACRO_INV_IDW.name = Drawings for Document
plm.smart.container.MACRO_INV_IDW.functionGroup = MACRO_INV_IDW
plm.smart.container.MACRO_INV_IDW.macro = INV:inv_idw.txt
plm.smart.container.MACRO_INV_IDW.icon = tree/inv/file_inv_drawing
Parameters:
plm.smart.container.MACRO_INV_IPN.name = Drawings for Document
plm.smart.container.MACRO_INV_IPN.functionGroup = MACRO_INV_IPN
plm.smart.container.MACRO_INV_IPN.macro = INV:inv_ipn.txt
plm.smart.container.MACRO_INV_IPN.icon = tree/inv/file_inv_presentation
Description: Defines smart container macros.
Values: For every macro, a plain text name, a function group, the macro to be performed, and an icon are given.
Default value: See under Parameters.
Parameter: plm.execute.additional.INV

CIDEON Software & Services GmbH & Co. KG Page 42 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
You can execute additional functions before or after a particular PLM process by starting either an executable file (external tool), a CAD macro
(Internal VBA), or the PowerShell.

The following values are possible:

1.) Specifies the document type for execution ("DOKAR" field) and the time of execution:
plm.execute.additional.INV.<DOCTYPE>.<EXEC TIME>

Possible options for <EXEC TIME> are:


• "BeforeCheckIn": Execution before check in
• "AfterCheckOut": Execution after check out
• "AfterBallooning": Execution after ballooning
• "BeforeCreateDocuments": Execute before import
• "BeforeSaveAs": Execute before save
Example:
plm.execute.additional.INV.IPT.BeforeCheckIn

2.) Specifies the type of function to be executed:


plm.execute.additional.INV.<DOCTYPE>.<EXEC TIME>.type = [EXEC TYPE]

Possible options are:


• "Executable": External tool
• "CADMacro": CAD macro (internal VBA)
• "Powershell": Starts the Windows PowerShell
Example:
plm.execute.additional.INV.IAM.BeforeCheckIn.type = Executable

NOTE:
A macro must return a value of '0' otherwise the current operation will fail!

3.) Specifies the name of the external program, macro or command:


plm.execute.additional.INV.<DOCTYPE>.<EXEC TIME>.commandLine = [CMDLINE]

Description: Examples:
plm.execute.additional.INV.IAM.BeforeCheckIn.commandLine = D:\\test.bat
plm.execute.additional.INV.IAM.AfterCheckOut.commandLine = D:\\Tools\\ExtractFormat64.exe
plm.execute.additional.INV.IPT.AfterBallooning.commandLine = Module1.DoSomething

NOTES:
• Executable files need a valid file path with double (escaped) backslashes!
• VBA macros must always be specified in the form [Macro Module].[Macro Function]!
4.) Specifies the number of parameters to pass:
plm.execute.additional.INV.<DOCTYPE>.<EXEC TIME>.NumberParam = [PARAM COUNT]

Example:
plm.execute.additional.INV.IPT.AfterBallooning.numberParam = 1

5.) Specifies the parameters to pass as a string:


plm.execute.additional.INV.<DOCTYPE>.<EXEC TIME>.parameterN = [PARAM]

The placeholder 'N' stands for the parameter number. The parameter number determines the order in which the parameters are passed!

There are 2 tokens which can be integrated into the parameter string to be passed:
• $(FILENAME): Returns the file name of the document.
• $(MetaData:<PropertyName>): Returns certain SAP metadata whose name has been specified.
Possible values for <PropertyName> are:
AUTHORIZATIONGROUP, CADKZ, CHANGENUMBER, CONV_STATUS, DELETEFLAG, DELFL, DESCRIPTION, DIRTY, FAMILY, HASMATERIAL,
HASMULTIMATLINK, HASNONMASTER, HASREFERENCE, HNV, HRV, ISASSEMBLY, MASTER, MASTER_FILENAME, NUMBER, OFFICE, PART, REVLEVEL,
STATUS, STRUCT, SUBTYPE, TYPE, USER, USERDEFINED1, USERDEFINED2, USERDEFINED3, USERDEFINED4, VERSION.
NOTE:
The DType can be queried with "$(MetaData:SUBTYPE)".

Examples:
plm.execute.additional.INV.IAM.BeforeCheckIn.parameter1 = -File
plm.execute.additional.INV.IAM.BeforeCheckIn.parameter2 = $(FILENAME)
plm.execute.additional.INV.IAM.BeforeCheckIn.parameter3 = -DType
plm.execute.additional.INV.IAM.BeforeCheckIn.parameter4 = $(MetaData:SUBTYPE)
Values: See under Description.
Default value: ---
Parameter: plm.convert.additional.INV
Description: Defines the Inventor document types to which additional formats can be assigned.
Values: List of document types, separated by ';'.
Default value: IPT;IAM;IDW

CIDEON Software & Services GmbH & Co. KG Page 43 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
General parameter construction:
plm.convert.additional.INV.<DOCTYPE1> = <CONVERT TYPE1>;<CONVERT TYPE2>
plm.convert.additional.INV.<DOCTYPE1>.<CONVERT TYPE1>.extension = <destination extension>
plm.convert.additional.INV.<CONVERT TYPE1>.options = <OPTION1>:<OPTION2>;<OPTION3>
plm.convert.additional.INV.<DOCTYPE1>.<CONVERT TYPE1>.<OPTION1> = <VALUE>

Additional files formats for documenttypes:


plm.convert.additional.INV.IPT = JT;FlatPatternDXF
plm.convert.additional.INV.IAM = JT
plm.convert.additional.INV.IDW = PDF
plm.convert.additional.INV.DWG = PDF

Convert options:
Parameters:
plm.convert.additional.INV.FlatPatternDXF.options = AcadVersion
plm.convert.additional.INV.JT.options = Version;FileStructure

JT options for "IPT":


plm.convert.additional.INV.IPT.JT.Version = 80
plm.convert.additional.INV.IPT.JT.FileStructure = 0

JT options for "IAM":


plm.convert.additional.INV.IAM.JT.Version = 80
plm.convert.additional.INV.IAM.JT.FileStructure = 0

FlatPatternDXF options for "IPT":


plm.convert.additional.INV.IPT.FlatPatternDXF.AcadVersion = 2004
Description: Defines the characteristics for the additional formats assigned to individual Inventor document types (convert type).
The individual additional formats will be assigned options which, in turn, are each assigned specific values (general parameter construction can be
found under Parameters). Allowed formats for SheetMetal FlatPattern are: "FlatPatternDXF", "FlatPatternDWG" and "FlatPatternSAT".

IMPORTANT:
Values: • Enumeration values in the options must be specified numerically, the name is not accepted! Example PDF export, enumerator
'PrintRangeEnum': The name of the value is 'kPrintAllSheets' and has the value '14082'. Therefore: plm.convert.additional.INV.PDF.PrintRangeEnum
= 14082.
The values of all enumerations can be found in the AutoDesk manual "Inventor API Reference Manual"!
• More information about the possible options can be found in the AutoDesk Inventor documentation!
Default value: See under Parameters.
Parameter: plm.convert.additional.INV.<CONVERT_TYPE>.filenameFormat
The names for neutral formats can be configured. The following placeholders are available, which are replaced by the corresponding SAP values:
• "$ (DOCNUMBER)" : SAP name
Description: • "$ (DOCTYPE)" : Document category
• "$ (DOCVERSION)" : Document version
• "$ (DOCPART)" : Document section
Value: String that can contain the allowed placeholders.
Default value: Number.$(DOCNUMBER)_Type.$(DOCTYPE)_Version.$(DOCVERSION)_Part.$(DOCPART)
Parameter: plm.convert.additional.INV.<CONVERT_TYPE>.keepExtension
The option "keepExtension" is available for all additional file formats and determines whether the file name extension of the CAD file is transferred
to the file name of the additional format file.
Description:
NOTE:
If this option is not defined, "true" is assumed automatically!
"true" = The file name is formed from the CAD file name with its extension.
Value:
"false" = The file name is formed from the CAD file name without its extension.
Default value: true (or not existing!)
Parameter: plm.convert.additional.FamilyMembers.INV
Description: Determines whether to create additional formats for family members.
"true" = Create additional formats.
Values:
"false" = Do not create additional formats.
Default value: true
plm.cad_variant.fgroup.forDocType.IAM = INV_CADVAR_IAM
Parameter:
plm.cad_variant.fgroup.forDocType.IPT = INV_CADVAR_IPT
Description: Definition of the function group for the DOKART variant.
Value: Name of the function group.
Default value: See under Parameters.
Parameter: plm.cad_variant.fgroup.forVariantType.<VariantType>
Description: Definition of the function group for the variant type.
Value: Name of the function group.
Default value: --
Parameter: plm.cad_variant.dgroup.forVariantType.<VariantType>
Description: Definition of the display group (layout) for the corresponding variant type.
Value: Name of the display group.
Default value: --
plm.om.CADVAR.containers.fgroup.INV_CADVAR_IAM = @plm.om.CADVAR.containers@;!CADVAR_CHILDREN!;!CADVAR_PARENT!
Parameter:
plm.om.CADVAR.containers.fgroup.INV_CADVAR_IPT = @plm.om.CADVAR.containers@;!CADVAR_CHILDREN!;!CADVAR_PARENT!

CIDEON Software & Services GmbH & Co. KG Page 44 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Definition of containers for CAD variants for specific function groups.
Description: The definition of containers for CAD variants is contained in the global "default.txt". As of ECTR version 5.2.7.0, the definition can only be made here
for certain function groups.
Value: The container definition.
Default value: See under Parameters.
Parameter: plm.options.loadDrawings.MultiRefAllowed.INV
Description: Specifies whether documents with more than one reference should also be considered for non-masters.
"true" = Save, import, view application structure with drawings also accepts drawings and presentations with more than one reference.
Values:
"false" = Save, import, display application structure with drawings does not accept drawings and presentations with more than one reference.
Default value: true
Parameter: structure.view.INV.generic.object.type
Specifies the key name of property for different object types.

Description: NOTE:
Will be read from node attributes as follows:
POS_TYPE = [INV_MATERIAL_NEW | INV_MATERIAL | INV_VIRTUAL_NEW | INV_VIRTUAL]
Values: Key name of property.
Default value: POS_TYPE
structure.view.INV.generic.object.INV_MATERIAL_NEW.name
structure.view.INV.generic.object.INV_MATERIAL.name
Parameters:
structure.view.INV.generic.object.INV_VIRTUAL_NEW.name
structure.view.INV.generic.object.INV_VIRTUAL.name
Specifies the property mapping for the default node view.

Description:
NOTE:
Will be read from node attributes as follows: DEFAULT_NAME = "Customized I18N Text".
Values: Key name of property
Default value: DEFAULT_NAME
structure.view.INV.generic.object.DRAW_CONTAINER.name = DEFAULT_NAME
Parameters:
structure.view.INV.generic.object.DRAW_CONTAINER.icon = {0}/sap/folder_open
Beschreibung: Specifies default names and icons for folders in which drawings are to be displayed separately in the application structure.
Folder name as character string or DEFAULT_NAME,
Werte:
Name of the icon in the file "images.jar" (see chapter "Icons for CAD originals in SAP ECTR").
Standardwert: See under Parameters.
plm.structure.node.CUAPOB_INV_MATERIAL.icon.1 = structure/flag/state/$(ANY_MODIFIED)/INV
plm.structure.node.CUAPOB_INV_MATERIAL.icon.2 = structure/flag/state/$(STATE)/INV
plm.structure.node.CUAPOB_INV_MATERIAL_NEW.icon.1= structure/flag/state/$(ANY_MODIFIED)/INV
plm.structure.node.CUAPOB_INV_MATERIAL_NEW.icon.2 = structure/flag/state/$(STATE)/INV
Parameters:
plm.structure.node.CUAPOB_INV_VIRTUAL.icon.1 = structure/flag/state/$(ANY_MODIFIED)/INV
plm.structure.node.CUAPOB_INV_VIRTUAL.icon.2 = structure/flag/state/$(STATE)/INV
plm.structure.node.CUAPOB_INV_VIRTUAL_NEW.icon.1 = structure/flag/state/$(ANY_MODIFIED)/INV
plm.structure.node.CUAPOB_INV_VIRTUAL_NEW.icon.2 = structure/flag/state/$(STATE)/INV
Description: Specifies the icon mappings depending on status flags for each possible value of POS_TYPE.
Values: Mapping paths for each icon.
Default value: See under Parameters.
Parameter: plm.document.PresentationAsNonMaster.INV
Determines whether presentations should be considered within the functions "Save", "Import" and "Show CAD Structure".

ATTENTION, important note:


Once this option has been set to "true", the presentations in the working directory have been cached and are always taken along. If this option is
subsequently changed from "true" to "false", the cache must be cleared by deleting the file "CadCache.db" in the directory SessionDir to rebuild the
Description:
cache!

NOTE:
If "true", presentations behave like a dependent drawing and the parameters plm.options.importOnDemand.loadDrawings.INV and
plm.options.save.loadDrawings.INV will be considered accordingly!
"true" = presentations are dependent documents and behave like drawings.
Values:
"false" = presentations are treated as master documents.
Default value: false
Parameter: plm.options.CreateDirDuringMakeDrawingOrAssemblyFromPartOrAssembly.INV
Determines which dialog should be displayed when the function "Create drawing view" is started.

Description:
NOTE:
The setting "0" is not available with Inventor!
"1" = Show "Create Master" dialog
Values:
"2" = Show "Create Dependent Document" dialog
Default value: 1
Parameter: plm.options.command.OpenWithECTR.ACDDWG.INV

CIDEON Software & Services GmbH & Co. KG Page 45 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Handling of Inventor open scenarios for AnyCad documents

Parameter structure:
plm.options.command.OpenWithECTR.<DocumentFormat>.INV
Description: <DocumentFormat>: The document format of the AnyCad document.

IMPORTANT:
Currently, only "ACDDWG" is supported!
'0' = Do not use original Inventor command "Open in AutoCAD"
'1' = Replace the original Inventor "Open in AutoCAD" command
Values:
'2' = Place below the original Inventor "Open in AutoCAD" command
'3' = Place inside "SAP PLM" submenu
Default value: 3
Parameter: plm.options.SapSaveIntermediateForCadSave.INV
Determines whether saving a model with DIS in CAD automatically triggers an intermediate save in SAP.

Description:
ATTENTION:
This has a negative effect on the performance of saving in CAD!
"true" = Closing the model in CAD triggers an intermediate save in SAP.
Values:
"false" = No intermediate save will be performed after closing the model in CAD.
Default value: false
Parameter: plm.options.CheckinOnCadClose.INV
Description: Determines whether closing the CAD triggers a check-in in SAP.
"True" = Closing the CAD triggers a check-in in SAP.
Values:
"false" = No check-in when closing the CAD.
Default value: false
Parameter: plm.options.ForceTemplateProject.INV
Description: Forces the usage of the template project even when there is already an ECTR project in Inventor.
"true" = Overwrites existing project with template project every time
Values:
"false" = Ignore template project if ECTR project is already set
Default value: false
Parameter: plm.options.InventorProjectName.INV
Name of the Inventor project to be used for creating ECTR Inventor projects.

Description:
NOTE:
This parameter is optional.
Values: Name of the Inventor project. Example: ECTR_@PLM_SYSTEM@_@PLM_CLIENT@
Default value: --
Parameter: plm.options.command.SynchronizeDrawingAssemblyBOM.INV
Description: Determines whether changes to the drawing BOM should also affect the assembly BOM.
"True" = Change assembly BOM when modifying the drawing BOM
Values:
"false" = No change of the assembly BOM when modifying the drawing BOM
Default value: false
Parameter: plm.options.SaveAsNewDocument.CancelSourceFile.INV
Description: This parameter controls whether the source document is to be cancelled in case of a "SaveAsNewDocument".
"true" = Cancel source document
Values:
"false = Do not cancel source document
Default value: true
Parameter: plm.options.SaveAs.CheckInAfterCreate.INV
Description: Determines whether documents should be checked in after a new version or a new document has been created.
"true" = Documents are checked in
Values:
"false" = Documents remain checked out
Default value: false
experimental.renamer.call.INV = true
plm.application.INV.cadRenamer.enable = true
Parameter:
plm.application.INV.cadRenamer.components = MULTI_LEVEL
plm.document.create.references.mastercomp.add.INV = true
Controls the call of the additional application "renamer3INV.exe".

Description:
ATTENTION:
These parameters come directly from the ECTR. This is necessary to ensure the function of the renamer. They should not be changed!
Values: Since these parameters are not to be changed, no values are specified here.
Default values: See under Parameter!
Parameter: plm.options.ImportOnDemand.DeleteOriginals.INV
Description: Delete original CAD files after successful import on demand.
"true" = Delete CAD files
Values:
"false" = Do not delete CAD files
Default value: false

CIDEON Software & Services GmbH & Co. KG Page 46 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameter: plm.options.ImportOnDemand.CheckInAfterCreate.INV
Description: Check-in documents after successful import on demand.
"true" = Documents will be checked-in
Values:
"false" = Documents will be checked-out
Default value: true
Parameter: plm.options.MacroName.GetRelatedDrawings.INV
Defines a macro that is executed when the "Open drawing" function is used in Inventor. The default macro "get_related_drawings.txt" ensures
that master drawings are also loaded.

Description: HINTS:
• Available from ECTR version 5.1.15.x and interface version 2.30.83.0!
• The macro file entered here must be located in the directory "%PLM_INSTDIR%\applications\inv\customize\scripts\macros"!
• It must be ensured that the macro is entered in the file "connector-macro-whitelist.txt", which is located in the "customize/config" directory!
• The macro is only called if the parameter plm.options.SapOpenForLoadDrawing.INV is set to the value '1' or '2'!
Value: Name of the macro file.
Default value: get_related_drawings.txt
Parameter: plm.options.MacroName.GetRelatedPresentations.INV
Defines a macro to get all related master and non-master presentations of a document. This macro is used, e.g., for the function "Open
Presentation" in CAD.

Description: HINTS:
• Available from Inventor version 2022.1 and interface version 02.29.136.00!
• The macro file entered here must be located in the directory "%PLM_INSTDIR%\applications\inv\customize\scripts\macros"!
• It must be ensured that the macro is entered in the file "connector-macro-whitelist.txt", which is located in the directory "customize/config"!
Values: Name of the macro file.
Default value: get_related_presentations.txt
Parameter: plm.docstructure.instdata.attr.namepattern.INV
Determines whether and how the CATEGORY field for component attributes is filled.
Regular expression pattern to define the parts of instance property names used as category and name. The expression must contain two capture
groups named "category" and "fieldname".
Example:
Description: Expression: (?<category>.*)-(?<fieldname>.*)
Property: STPO-POSNR => CATEGORY = STPO | NAME = POSNR

ATTENTION:
ECTR version 5.2.6.0 or higher for real components and ECTR version 5.2.7.0 or higher for virtual components is required to use this preference!
Values: Regular expression
Default value: (?<category>.*)-(?<fieldname>.*)
Parameter structure:
plm.options.BOMTable.Column.SLE.[CAD_COLUMN] = [SAP_FIELD]

Parameter: plm.options.BOMTable.Column.INV.Material = MATERIAL_EXT


plm.options.BOMTable.Column.INV.Postext1 = POSTEXT1
plm.options.BOMTable.Column.INV.Postext2 = POSTEXT2
plm.options.BOMTable.Column.INV.OtherColumn = POSTEXT2
If a BOM table exists, and it contains a column called [CAD_COLUMN], values within this column are updated with the contents of [SAP_FIELD].

Description: ATTENTION:
• These configuration options are available from patch 14 of the interface!
• If columns must be created, then always in capital letters!
Implemented values (tags) for [SAP_FIELD]. Possible values are:
"MATERIAL" = Internal material number, returned in return table "ET_BALLOONS", column "MATERIAL".
Values: "MATERIAL_EXT" = External material number, returned in return table "ET_BALLOONS", column "MATERIAL_EXT".
"POSTEXT1" = Return value of the return table "ET_BALLOONS", column "POSTEXT1".
"POSTEXT2" = Return value of the return table "ET_BALLOONS", column "POSTEXT2".
Default value: See under Parameters!
Parameter: plm.options.BOMTable.AddNonExistingColumns.INV
If a column with the name [CAD_COLUMN] does not exist in the parts list table, it can be added. This is then updated with the contents of
Description:
[SAP_FIELD].
"true" = Add columns if not exist
Values:
"false = Do not add non-existent columns
Default value: true
Parameter: plm.options.TransferCadPosNr.INV
Description: Decides whether item numbers in the Inventor BOM should also be transferred as ComponentAttribute.
"true" = Transfer Inventor item numbers
Values:
"false" = Do not transfer Inventor item numbers
Default value: false
Parameter: plm.options.TransferCadQuantities.INV
Description: Decides whether quantities in the Inventor BOM should also be transferred as ComponentAttribute in the same way as item numbers.
"true" = Allow transfer of quantities
Values:
"false" = No quantities transferred
Default value: false

CIDEON Software & Services GmbH & Co. KG Page 47 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameter: plm.options.PromotePhantomPositions.INV
Determines whether the positions of phantom assemblies are to be transferred as pseudo-virtual components.
This allows overwriting the position number and quantities of positions offered by dummy assemblies.
Description:
ATTENTION:
This option requires a backend implementation to be used!
"true" = Transfer phantom compositions
Values:
"false" = No transfer of phantom compositions
Default value: false
Parameter: plm.appl.language.INV
Description: Specified the language of the CAD program. The appropriate language package must be installed.
Language specification in the form <Language>-<Country> (e.g., "en" or "de") or the environment variable "%PLM_LANGUAGE%". This is set by the
ECTR according to the current SAP logon language.
Values:
See also the files "%PLM_INSTDIR%\customize\config\plm_initilize.bat" and "%PLM_INSTDIR%\customize\config\saplogon.txt"
(plm.logon.gui.languages).
Default value: %PLM_LANGUAGE%
Parameter: plm.appl.startup.parameters.INV
At program start, one or more parameters can be passed to Inventor, e.g.,: "/importoptions=filename.xml". You use this parameter to specify the
Description:
names of the parameters to be transferred. The specification is made without '/'!
Values: List of names of parameters to pass, separated by ';'.
Default value: --
Parameter: plm.appl.startup.[paramX].INV = [value]
A value to pass must be specified for each transfer parameter specified with parameter plm.appl.startup.parameters.INV. [paramX] designates the
Description:
parameter name.
Values: The value to be passed. It can also contain environment variables.
Default value: --
Parameter: plm.options.CommandContext.UseActiveDocument.INV
Description: Decides whether all ribbon functions related to documents should affect the top document or the active document of an open assembly.
"true" = The active (in-place editing) document is used
Values:
"false" = The top document of the assembly is used
Default value: false
Parameter: plm.options.Logging.LogPerformanceTrace.INV
Description: Decides whether to create a log file with performance traces in the ECTR log directory for the interface.
"true" = Log performance traces
Values:
"false" = No logging of performance traces
Default value: false
Parameter: plm.options.Cancel.DialogDefaultValue.INV
Description: Determines which option is selected by default in the dialog "Cancel edit and discard work".
'0' = Reload original from SAP
Values:
'1' = Close original in CAD
Default value: 0
Parameter: plm.options.OnDirty.Checkout.DialogDefaultValue.Action.INV
Defines the default setting of the options in the Checkout dialog.
'-1' sets the radio button "Yes, checkout" as default. The values '0', '1' and '2' set the respective action in the listbox as default if the user rejects
a checkout with the radio button "No".
Description:
ATTENTION:
In situations where checkout may not be possible, e.g. when the document status is "Locked", the radio button "No" and the option "Discard
changes" will be set as default!
'-1' = Radiobutton "Yes, checkout"
'0' = Discard changes
Values:
'1' = Allow, change only in memory (not recommended!)
'2' = Allow change in local file (set read/write)
Default value: -1
Parameter: plm.options.OnDirty.Checkout.DialogDefaultValue.ObjectList.INV
Defines the default name of an object list and thus its use in the Checkout dialog.

Description:
NOTE:
If an object list name is preset with this preference, the checkbox "Add to Object List" is automatically preset as well!
Values: Name of the Object List or empty.
Default value: --
Parameter: plm.options.OnDirty.Checkout.DialogDefaultValue.ApplyAll.INV
Description: Sets the default value for the "Apply for all..." checkbox in the Checkout dialog.
"true" = Option "Apply for all..." is set
Values:
"false" = Option "Apply for all..." is not set
Default value: false
Parameter: plm.options.Cancel.LoadedParts.INV

CIDEON Software & Services GmbH & Co. KG Page 48 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The interface makes the parts loaded in the CAD available to the ECTR during cancel. This costs time and is not absolutely necessary for the
action "Cancel". It is therefore possible to choose whether only the parts of the active document should be transferred or no parts at all. This can
increase the performance, but only for very large assemblies.
Description:

ATTENTION:
Changing this preference should only be done after prior consultation! In case of doubt, the default value '0' should be retained.
'0' = Provide all loaded parts.
Values: '1' = Provide only the parts of the active document.
'2' = Do not provide any loaded parts.
Default value: 1
Parameter: plm.options.Save.LoadedParts.INV
The interface makes the parts loaded in the CAD available to the ECTR during save. This costs time and is not absolutely necessary for the action
"Save". It is therefore possible to choose whether only the parts of the active document should be transferred or no parts at all. This can increase
the performance, but only for very large assemblies.
Description:

ATTENTION:
Changing this preference should only be done after prior consultation! In case of doubt, the default value '0' should be retained.
'0' = Provide all loaded parts.
Values: '1' = Provide only the parts of the active document.
'2' = Do not provide any loaded parts.
Default value: 1
Parameter: plm.options.Save.UseDocumentPropertiesAsRequestedComponentAttributes.INV
For the AdvancedBOM, the attributes ROMS1 to ROMS3 must be in the TMX_META as component attributes for variable-size items. For this,
certain document properties must be transferred to the ECTR as component attributes. The value for non-existing component attributes
referenced in bod_mapping_section is then taken from the document properties.
Description:

ATTENTION:
If the value is set to "true", this can reduce the performance!
"true" = Uses the document property if the component attribute is not present.
Values:
"false" = Do not use document properties as component attributes.
Default value: false
Parameter: plm.options.MaintainGeneric.SendAllGenericMembers.INV
Selects whether to send all members who are local to the disk, or only those members whose version matches the factory version.

Description:
ATTENTION:
The setting "false" of this preference is incompatible with the preference "plm.options.MaintainGeneric.DeleteMissingMember.INV"!
"true" = Send all members.
Values:
"false" = Send only members that refer to the correct version of the factory.
Default value: true
Parameter: plm.options.save.ReadTrafomatrix.INV
Reading the transformation matrices when saving can take quite a long time. Therefore, it is possible to suppress this if viewing is not used in the
ECTR. This can increase the performance.
Description:
ATTENTION:
The transformation matrices are necessary for viewing in the ECTR!
"true" = Read transformation matrices.
Values:
"false" = Suppress reading of the transformation matrices.
Default value: true
Parameter: plm.options.CloseDocumentAfterSapSaveDisplay.INV

ATTENTION:
Description: This parameter is no longer supported since version 02.25.102.00. The function can be called directly by the "Save and Close" function from the
ribbon!
Values: --
Default value: --

Use Excel files as parameter files

Excel parameter files can be created as a separate DIR or additional format (additional file).

Should the Excel file be created as an additional format, the option plm.document.ExcelAsAdditionalFile.INV
located in the file "%ECTR_INSTDIR%/applications/inv/customize/config/default.txt" must be set to "true".

However, should the Excel file be created as a separate DIR, the option
plm.document.ExcelAsAdditionalFile.INV must be set to "false".

In order for Excel files to be displayed as a separate DIR upon import (function "Import On Demand") at

CIDEON Software & Services GmbH & Co. KG Page 49 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
installation, the option plm.document.importondemand.searchAlso.INV must be set to the DType "CPA", and
"CPA" must be included in the list of DTypes.
As a standard, the CPA-DType (CadParameterFile) is delivered in the file "dtype.xml" for Excel files. The DType
can differ depending on the configuration for Excel files.

Example:

plm.document.importondemand.searchAlso.INV = CPA;XLS

Creating mold assemblies with "ECTR New"

If it has to be possible to create mold assemblies with "ECTR New", already initialized mold assemblies must be
used as a template.

To create such a template, a mold assembly must create and saved with Inventor. The resulting ".iam" file can
then serve as a template for the ECTR. For this, it should be moved to the template directory of the ECTR and
must be specified as seed file in the file "dtype.xml".

The DType "IAMMO", which is configured in the file "default.txt" via the parameter
"plm.document.dtype.Mold.INV", has already been defined in the "dtype.xml" file for mold assemblies:

Parameter assignment in "default.txt"

plm.document.dtype.Mold.INV = IAMMO

dtype.xml
The DType settings control the behavior of the SAP Engineering Control Center when new documents are
created and when the properties of documents are handled. Settings related to document type are defined in
the file "dtype.xml". The file "dtype.xml" sent out with the SAP Engineering Control Center Interface to Inventor
contains definitions and settings for document types supported by Inventor.

Structure

The file "dtype.xml" has the following basic structure:

File structure of "dtype.xml"

<!DOCTYPE DType_definitions SYSTEM "../../../../basis/aux-files/dtype_4110.dtd">


<DType_definitions>
<DType ... >
.
.
.
</DType>
<DType ... >
.
.
.
</DType>
</DType_definitions>

CIDEON Software & Services GmbH & Co. KG Page 50 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The element <DType> defines the characteristics of a document type or template. It outlines distinctions
between the master document, nonmaster documents dependent on the master document, and templates for
document type descriptions. The element <DType> possesses a variety of attributes and accepts a wide range
of subelements.

The setup and structure of the file "dtype.xml" are extensively explained in the help file
"Operations Guide_EN.pdf", which can be found in the directory
"%PLM_INSTDIR%\documentation\Manuals\en". The XML structure of "dtype.xml" is defined in the
file "%PLM_INSTDIR%\basis\aux-files\dtype_4110.dtd".

The DType definitions for the SAP Engineering Control Center Interface to Inventor are described here.

DType definitions for Inventor

With the installation of the SAP Engineering Control Center interface to Inventor, the file "dtype.xml" is
delivered. This includes the DType definitions that are essential for the interaction with the SAP Engineering
Control Center. Below these definitions will be explained.

The definition is divided into three areas:

Template definitions
Master document definitions
Nonmaster document definitions

The correlation of the DType definitions as well as their dependencies is shown in the following table:

Overview about DType definitions for Inventor

DType-ID Type App-Type Description


-----------------------------------------------------------------------------------------------
DEFLT Template --- Base template from SAP/DSC
| +- INVT Template INV Base template for all Inventor files
| +- INMDL Template INV Base template for 3D documents (IPT/IAM)
| | +- IPTML Template INV Base template for 3D Parts
| | | +- IPT Master INV 3D Part
| | | +- IPTNR Master INV 3D Part Not Renaming (e.g. for iPartMember)
| | | +- IPTCC Master INV 3D Normteil or Library Parts
| | | +- IPTSM Master INV 3D Sheet Metal
| | +- IAMLT Template INV Base template for 3D Assemblies
| | +- IAM Master INV 3D Assembly
| | +- IAMNR Master INV 3D Assembly Not Renaming (e.g. for iAssemblies)
| | +- IAMWM Master INV 3D Weldment Assembly
| | +- IAMMO Master INV 3D Mold Design Assembly
| +- INDRW Template INV Base template for "2D" documents (IPN/IDW/DWG)
| +- IPNTL Template INV Base template for Presentations
| | +- IPN Master INV Presentations as Master
| | +- IPNNM NonMaster INV Presentations as NonMaster
| +- IDWTL Template INV Base template for IDW-Drawings
| | +- IDW Master INV IDW-Drawings as Master
| | +- IDWNM NonMaster INV IDW-Drawings as NonMaster
| +- IDWGT Template INV Base template for DWG-Drawings
| +- IDWG Master INV DWG-Drawings as Master
| +- IDWGN NonMaster INV DWG-Drawings as NonMaster
XLS Template --- Base template from SAP/DSC for Excel
+- CPA Master XLS XLS Parameter File (XLS)

The following are the descriptions of the individual definitions for Inventor documents.

CIDEON Software & Services GmbH & Co. KG Page 51 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Generic DType definitions

The generic definitions are templates with basic definitions that are valid for different types of Inventor
documents. Templates are integrated in the other DType definitions.

NOTE:
It is recommended to maintain only the language English directly in the file "dtype.xml"! All other
languages will be offered via the particular "dictionary.txt" file. This affects the definitions of
DTypes and Seedfiles. All elements <description language="XY"> are omitted except English,
which are used as fallback.

The first step is to define the default template, which defines the basic properties for Inventor:

Generic DType definition "INVT" for Inventor

<DType type="template" identifier="INVT" include_template="DEFLT" application_type="INV"


group="INVENTOR">
...
</DType>

Attributes of element <DType> for template definition "INMDL


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The
ID must be one to five characters long.
identifier "INVT"
"INVT" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "DEFLT"
"DEFLT" = The DType template with the ID "DEFLT" from the global
"dtype.xml" file is included
Identifier for the application responsible for this document. This application
opens the file from the SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor.
Defines the group membership for master documents. The group
group "INVENTOR" membership is used to organize the DTypes in the "Create Document" dialog.
"INVENTOR" = Document belongs to this group.

The <program_options> subelement contains various settings that control the behavior of the document in
SAP Engineering Control Center.

Attributes of the subelement <program_options>


Attribute Value Description
Switches the automatic adaptation of the
auto_adjust_application_role "no" "Application Role" in RES4 on or off
"no" = No adjustment will be made.

CIDEON Software & Services GmbH & Co. KG Page 52 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether this DType is visible in the
combo box of the available document types in the
show_for_create "yes"
"Create Document" dialog.
"yes" = Document is visible.
Defines whether the document is a normal
document with original and assigned workstation
application or a container object for additional
has_primary_application "yes" originals without explicit original.

"yes" = The document has an original with


assigned workstation application.
Determines whether the newly created document
has a dirty flag.
dirty_flag "yes"
"yes" = The document has a dirty flag.
Determines whether a status change is performed
by the SAP Engineering Control Center during
check-in or whether the SAP system performs a
attempt_status_change_on_checkin "yes" status change.

"yes" = Status change by SAP Engineering


Control Center.
Determines which classification from SAP is used
in the document creation dialog to configure the
following input fields: "Authorization Group",
document_data_class "DOC_ADDIT_FIELDS"
"Laboratory/Office", "Change Number", "CM
Relevance".
"DOC_ADDIT_FIELDS" = Name of the class in SAP.

The subelement <copy_as> defines how the document behaves in a "CopyAs" action and how the SAP
Engineering Control Center reacts to this document.

Attributes of subelement <copy_as> of subelement <program_options>


Attribute Value Description
Determines whether a CopyAs is allowed for this DType.
allowed "yes"
"yes" = "CopyAs" action is allowed
Defines which additional originals in the document are not transferred to the copy
of the document during copying by means of a semicolon-separated list of
ignore_wsappl_list "ZIP"
identifiers for the workstation application of the additional originals.
"ZIP" = Additional originals of the type "ZIP" (ZIP archive) are not copied.
Determines whether the version number of the copy should be set to that of the
original or to the initial value (usually "00").
use_initial_version "yes"
"yes" = Set the version number of the copy to the initial value.

The <new_version> subelement contains settings for the versioning of documents.

Attributes of subelement <new_version> of subelement <program_options>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 53 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether the original file name should be assigned
according to the part rules for this DType or whether the previous file
rename_master_original "no" name should be kept unchanged.

"no" = Keep file name unchanged.


Determines, for which document statuses, the versioning of a
document is allowed. A list of document statuses can be separated by
status_list "AC;IW;RE"
";".
"AC;IW;RE" = New versions are allowed for this document status.
Determines which additional originals in the document are not
transferred to the new version of the document during versioning,
using a semicolon-separated list of identifiers for the workstation
ignore_wsappl_list "ZIP" application of the additional originals.

"ZIP" = Additional originals of the type "ZIP" (ZIP archive) are not
copied.
Defines which dependent documents are omitted when the master
document is versioned. The dependent documents to be ignored are
ignore_nm_dtype_list "" specified as a semicolon-separated list of DTypes.

"" = No document types to ignore.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
Determines whether the SAP GUI should
be opened to create a document.
create_with_SAP_GUI "no"
"no" = do not open SAP GUI.
Defines whether mass creation is allowed
for the document.
create_multi_allowed "no"
"no" = No mass creation allowed for this
document
Defines the document number
assignment in SAP.
document_number_assignment "internal"
"internal" = SAP assigns the number
automatically.
In case of external number assignment,
this value is entered as prefix in the input
field of the document creation dialog. In
case of internal number assignment, the
initial_document_number "*"
value in this field has no meaning.

"*" = The value in this field has no


meaning.
SAP document type for the newly created
document.
document_type "INV"
"INV" = SAP document type for Inventor
documents.

CIDEON Software & Services GmbH & Co. KG Page 54 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Shows or hides the classification panel in
the document creation dialog.
show_classification_pane "yes"
"yes" = Show classification panel in the
document creation dialog.
Initial value for the number of the SAP
document part for the new document to
initial_document_part "000"
be created.
"000" = Initial value for the part number.
Defines whether the default value for the
part number can be changed in the
"Document Creation" dialog of the SAP
part_editable "no" Engineering Control Center.

"no" = The default value cannot be


changed.
Initial value of the SAP document version
for the newly created document.
initial_document_version "00"
"00" = Initial value for the SAP document
version.
Determines whether the default value for
the document version can be changed in
the "Document Creation" dialog of the
version_editable "no" SAP Engineering Control Center.

"no" = The default value cannot be


changed.
Here you can define the initial status of a
newly created document.
change_to_after_create_status "AC"
"AC" = Identification of the initial status.
Determines how the file name for the
original document is composed. The
following placeholders are possible:
$(DOCNUMBER) for the document
number, $(DOCTYPE) for the document
type and $(DOCPART) for the document
filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
part.

"$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
= The file name consists of document
number, document type and part
document.
Specifies whether the document version
should be appended to the file name for
the original on this document (usually
"_$(DOCVERSION)").

filename_template_version "" "" = No version in the file name.

ATTENTION:
This option is not supported and
must be empty!

The <material_create> subelement contains settings for creating a material for a new document.

CIDEON Software & Services GmbH & Co. KG Page 55 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the subelement <material_create>
Attribute Value Description
Determines whether and how a material is created for a new
document.
material_creation_method "deferred"
"deferred" = No material is created for the document. It is
possible to create a material for this document at a later date.
Defines the material number assignment in the SAP system. The
values are identical to those of document number assignment.
material_number_assignment "internal"
"internal" = The SAP system assigns the number automatically.
Material type or a ';'-separated list of material types for the new
material to be created.
material_type "FERT;HALB"
"FERT;HALB" = List of SAP material types.
Template material with which the material creation is
performed.
material_template ""
"" = No material template specified.
Initial value for the assigned work.
material_plant_assignment ""
"" = No initial work assigned.
Specifies the default class for the material.
material_default_class ""
"" = No standard class for the material.

The sub-element <primary_application> determines which application is responsible for this master document
(primary application) and defines the rules for checking the originals in and out.

Attributes of the subelement <primary_application>


Attribute Value Description
"INV" = Identification of the SAP workstation application for
primary_workstation_application "INV"
Inventor.
Defines whether an attribute update should occur when the dirty
flag is set.
update_attributes_for_dirty "yes"
"yes" = Perform attribute update.
Defines the attribute update in the "Open for editing" action.
update_attributes_for_rw "yes"
"yes" = Perform attribute update.
Defines the attribute update for the action "Open read-only".
update_attributes_for_ro "no"
"no" = Do not perform an attribute update.

The subelement <container_file> defines the properties of the ZIP archive, which is stored in the document as
a container file. It contains the subelement <plmfile>, which defines the properties of the container file.

Attributes of subelement <plmfile> of subelement <container_file> of <primary_application>


Attribute Value Description
Filters for file name extensions in the file system.
extension "ecf"
"ecf" = File name extension.

CIDEON Software & Services GmbH & Co. KG Page 56 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Assigns the original to the workstation application.
workstation_application "ECF"
"ECF" = Identification of the workstation application.
Adds a description to the original document.
description "ECtr container file"
"ECtr container file" = Description for the original.

The <checkout_rules> subelement determines how the original document is handled during check-out.

Attributes of subelement <checkout_rules> of subelement <primary_application>


Attribute Value Description
Defines whether the original is renamed when opened
according to the rules for part names.
rename_master_original_at_checkout "no"
"no" = Keep file name of the original when opening.
Defines whether only one version of this document may be
stored in the session directory.
one_version_in_session_only "yes"
"yes" = Only one version of the document in the session
directory allowed.
Defines whether a hard link can be used for the original
document in the Session directory, or whether a copy must
hardlink_in_session "no" always be created.

"no" = Always create a copy.


Defines whether, for all referenced components, the files in the
session directory could be provided. The check is carried out
with the Open for Edit function. If not all required files are in
check_references_on_edit "yes"
the Session directory, the action is aborted and the document
is not opened for editing.
"yes" = Perform check.
Determines whether a structure resolution is performed when
opening a document.
read_structure "flag"
"flag" = Perform structure resolution, only if "Structure" flag is
set.

The sub-element <checkin_rules> determines how files in the Additional directory and originals on the
document are handled during check-in. It contains several subelements for this purpose.

Attributes of the subelement <checkin_rules> of <primary_application>


Attribute Value Description
"yes" = Prevents a document without CAD from being checked in via the
context menu in the ECTR desktop view.

from_application_only "yes"
ATTENTION:
For the correct storage of the documents with their structure, it is absolutely
necessary that this value is set to "yes"!

The subelement <ignore> defines which files are ignored during the backup. It contains the subelement
<plmfile>, which defines the additional file types to be ignored.

CIDEON Software & Services GmbH & Co. KG Page 57 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of subelements <plmfile> of subelement <ignore> of <checkin_rules>
Attribute Value Description
The respective file name extensions of the additional file
types to be ignored in the file system.
extension "bak", "xml", "tmp"
"bak", "xml", "tmp" = File name extensions of the additional
file types.
Filters by file name using regular expressions.
filename_pattern "VEConverterResponse\.xml"
"VEConverterResponse\.xml" = Filter mask.

The <delete_in_sap> subelement defines which originals on the document are deleted when checking in. This
allows a targeted cleanup of the document. It contains the subelement <plmfile> which defines the additional
file types to be deleted.

Attributes of subelements <plmfile> of subelement <delete_in_sap> of <checkin_rules>


Attribute Value Description
Workstation application identifiers for the individual additional
workstation_application "EPG", "EPJ", "JT" formats.
"EPG", "EPJ", "JT" = identifiers of the workstation application.

The subelement <delete_in_session> defines which files are deleted during check-in. It contains the
subelement <plmfile> which defines the additional file types to be deleted.

Attributes of subelements <plmfile> of subelement <delete_in_session> of <checkin_rules>


Attribute Value Description
The file name extensions of the files to be deleted in the
file system.
extension "jt", "rh", "vds"
"jt", "rh", "vds" = File name extensions of the additional
file types.
Filters by filenames using regular expressions.
".*\.preview\.jpg",
filename_pattern
".*\.preview\.gif" ".*\.preview\.jpg", ".*\.preview\.gif" = Regular Expression
for file names.

The subelement <additional_files> determines which additional formats of a document can be displayed and
edited in the SAP Engineering Control Center.

Attribute of the subelement <additional_files>


Attribute Value Description
Determines whether additional originals are allowed for this document.
enable_additional_files "yes"
"yes" = Additional originals are allowed.

The subelement <ignore_files> defines which of the additional originals on the document are NOT displayed in
the original container of a document in SAP Engineering Control Center. It contains subelements of the type
<plmfile>, which define the individual document types.

Attribute of the subelement <plmfile> of subelement <ignore_files> of <additional_files>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 58 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The identifiers of the document types that should not be
displayed.
workstation_application "EPJ", "EPG", "JT", "JTM"
"EPJ", "EPG", "JT", "JTM" = Identifiers of the document
types.

The <store_files> subelement defines the assignment of the originals to the workstation application when
adding auxiliary files (neutral formats) to a document. The additional files can be added by Drag & Drop or
menu function.

Attributes of the subelement <store_files>


Attribute Value Description
Filters by file name for JPEG files using regular expressions.
filename_pattern ".*\.preview\.jpg"
".*\.preview\.jpg" = Filter mask for JPEG files.
"gif",
"pdf",
The file extensions of the respective additional files (neutral
extension "jt",
formats).
"txt",
"xls"
"EPJ",
"EPG",
"PDF", The identifiers of the document types of the respective
workstation_application
"JT", additional files (neutral formats).
"TXT",
"XLS"
"ECTR Preview (jpeg)",
"ECTR Preview (gif)",
"$(FILENAME)", The descriptions of the respective additional files (neutral
description
"3D Preview JT", formats).
"$(FILENAME)",
"Excel files"

Next comes the generic DType template for 3D documents (assemblies and parts):

Generic DType definition "INMDL" for Inventor

<DType type="template" identifier="INMDL" include_template="INVT" application_type="INV"


group="INVENTOR">
...
</DType>

Attributes of element <DType> for template definition "INMDL


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The
ID must be one to five characters long.
identifier "INMDL"
"INMDL" = ID of this template definition.

CIDEON Software & Services GmbH & Co. KG Page 59 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines which template definition is included in this definition.
include_template "INVT"
"INVT" = The DType template with the ID "INVT" from this "dtype.xml" file is
included.
Identifier for the application responsible for this document. This application
opens the file from the SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor.
Defines the group membership for master documents. The group
membership is used to organize the DTypes in the "Create Document" dialog.
group "INVENTOR"
"INVENTOR" = Document belongs to this group.

The <program_options> subelement contains various settings that control the behavior of the document in
SAP Engineering Control Center.

Attributes of the subelement <program_options>


Attribute Value Description
So-called "Function Groups" can be defined. For documents with a
common function group, you can define e.g. own context menus.
This defines the Function Group to which documents of this type
function_group "DOC_INVMDL"
belong.

"DOC_INVMDL" = Identification of the Function Group.


Name of a section in the attribute mapping file in which customer-
specific data is defined. The data is displayed in the Object Browser
customer_data_section "INVMDL"
under the "Customer Data" tab.
"INVMDL" = Name of the section.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
Defines which attributes from the attribute mapping files are synchronized
during document creation.
attribute_section "INVMDL"
"INVMDL" = Name of the section.

The sub-element <primary_application> determines which application is responsible for this master document
(primary application) and defines the rules for checking the originals in and out.

Attributes of the subelement <primary_application>


Attribute Value Description
Name of a section in the attribute mapping file in which the attribute exchange
between SAP and the application is defined.
attribute_section "INVMDL"
"INVMDL" = Name of the section in the attribute mapping file.
Determines whether a relative path should be used to address a document of
this type.
use_relative_path "yes"
"yes" = Use relative path.

CIDEON Software & Services GmbH & Co. KG Page 60 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The <checkout_rules> subelement determines how the original document is handled during check-out.
The <scripts> subelement contains scripts that are executed before the check-out.

Attribute of the subelement <script> of the subelement <scripts> of <checkout_rules>


Attribute Value Description
Defines at which stage of the process the script is executed.
phase "after_session_update"
"after_session_update" = Runs the script after each checkout.

The individual scripts are contained in the subelement <script>.

Attribute of subelement <script> of subelement <scripts> of <checkout_rules>


Attribute Value Description
Defines the complete call path of the script to be executed.
name "@PLM_INSTDIR@\applications\inv\customize\scripts\copy-additional-files.bat"
"@PLM_INSTDIR@\applications\inv\customize\scripts\copy-additional-files.bat" =
Call path of the script file "VEConverter.bat".

<script> contains the <params> subelement, which defines the parameters to be passed to the script to be
executed. For this purpose, one or more subelements <param> contains <param>, each defining one
parameter.

Attributes of subelements <param> of subelement <params> of subelement <script> of subelement <scripts> of


<checkout_rules>
Attribute Value Description
"--master-file",
name Contains for each defined parameter its name.
"--input-directory"
value "$(masterfile)", "$(add_dir)" Script parameters sometimes contain variable data in the form of placeholders ("$(...)").

The sub-element <checkin_rules> determines how files in the Additional directory and originals on the
document are handled during check-in.
The subelement <save_direct> determines which additional files (additional formats) are stored in the
Additional directory when saving as originals on the document. It contains the subelement <plmfile>, which
determines the individual additional file types.

Attributes of subelements <plmfile> of subelement <save_direct> of <checkin_rules>


Attribute Value Description
Filters by file name using regular expressions.
".*\.preview\.jpg",
filename_pattern ".*\.preview\.gif",
".*\.preview\.jpg",
".*_mono\.rh", ".*\.vds"
".*\.preview\.gif", ".*_mono\.rh", ".*\.vds" = Filter masks.
The respective file name extensions of the additional
files in the file system.
extension "jt", "rh"
"jpg", "rh" = The respective file name extensions.
Workstation application identifiers for the individual
additional formats.
"EPJ", "EPG", "JTM",
workstation_application
"RHM", "RH"
"EPJ", "EPG", "JTM", "RHM", "RH" = Identifiers of
document types.
"ECtr Preview (jpeg)", Description of the respective additional files.
"ECtr Preview (gif)", "ECtr
description 3D Preview", "Monolithic "ECtr Preview (jpeg)", "ECtr Preview (gif)", "ECtr 3D
RH", "Monolithic VDS", Preview", "Monolithic RH", "Monolithic VDS", "SAP 3D
"SAP 3D Preview" Preview" = Description of the additional files.

CIDEON Software & Services GmbH & Co. KG Page 61 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The <scripts> subelement contains scripts that are executed before check-in. The individual scripts are
contained in the <script> subelement.

Attributes of the subelement <script> of the subelement <scripts> of <checkin_rules>


Attribute Value Description
Defines the complete call path of the script to be executed.

"@PLM_INSTDIR@\basis\sys\win\bin\VEConverter.bat" =Call path


of the script file "VEConverter.bat".
name "@PLM_INSTDIR@\basis\sys\win\bin\VEConverter.bat"
NOTE:
For ECTR older than version 5.1.12 the script
"@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat"
must be used!

<script> contains the <params> subelement, which defines the parameters to be passed to the script to be
executed. For this purpose, one or more subelements <param> contains <param>, each defining one
parameter.

Attributes of subelements <param> of subelement <params> of subelement <script> of subelement <scripts> of


<checkin_rules>
Attribute Value Description
"convertfile", "$(masterfile)",
"--output-directory, "$(add_dir)",
"--output-format", "VDS" (für Visual Enterprise < 9.0: "RH"),
Contains the name of each
"--sap-identifier",
defined parameter. Some
"DOCUMENT=$(doc_type)*$(doc_nr)*$(doc_part)*$(doc_vr)",
name of them contain variable
"--sap-metadata", "DOCTYPE=$(doc_type)",
data in the form of
"--sap-metadata", "DOCNUMBER=$(doc_nr)",
placeholders ("$(...)").
"--sap-metadata", "DOCPART=$(doc_part)",
"--sap-metadata", "DOCVERSION=$(doc_vr)",
"--import-setting", "LoadExternalFiles=false"

The subelement <additional_files> determines which additional formats of a document can be displayed and
edited in the SAP Engineering Control Center.

Attribute of the subelement <additional_files>


Attribute Value Description
Determines whether additional originals are allowed for this document.
enable_additional_files "yes"
"yes" = Additional originals are allowed.

The subelement <ignore_files> defines which of the additional originals on the document are NOT displayed in
the original container of a document in SAP Engineering Control Center. It contains subelements of the type
<plmfile>, which define the individual document types.

Attribute of subelement <plmfile> of subelement <ignore_files> of <additional_files>


Attribute Value Description
The identifiers of the document types that should not be
displayed.
workstation_application "EPJ", "EPG", "JT", "JTM"
"EPJ", "EPG", "JT", "JTM" = Identifiers of the document
types

The <allowed_nonmaster> subelement determines which document type is allowed as a dependent document

CIDEON Software & Services GmbH & Co. KG Page 62 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
(Nonmaster document).

Attributes of the subelement <allowed_nonmaster>


Attribute Value Description
The unique DType-ID of the dependent document definition.
DType "VWINM"
"VWINM" = DType of the allowed dependent document.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The generic DType template for 2D documents (Drawings) follows:

Generic DType definition "INDRW" for Inventor

<DType type="template" identifier="INDRW" include_template="INVT" application_type="INV"


group="INVENTOR">
...
</DType>

Attributes of element <DType> for template definition "INDRW


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The
ID must be one to five characters long.
identifier "INDRW"
"INDRW" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INVT"
"INVT" = The DType template with the ID "INVT" from this "dtype.xml" file is
included.
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP
application_type "INV" Engineering Control Center.

"INV" = For Inventor, this is the Workstation Application (WSAppl).


Defines the group membership for master documents. The group
membership is used to organize the DTypes in the "Create Document" dialog.
group "INVENTOR"
"INVENTOR" = Document belongs to this group.

The <program_options> subelement contains various settings that control the behavior of the document in
SAP Engineering Control Center.

Attributes of the subelement <program_options>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 63 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
So-called "Function Groups" can be defined. For documents with a
common function group, you can define e.g. own context menus.
This defines the Function Group to which documents of this type
function_group "DOC_INVDRW"
belong.

"DOC_INVDRW" = Identification of the Function Group.


Name of a section in the attribute mapping file in which customer-
specific data is defined. The data is displayed in the Object Browser
customer_data_section "INVDRW" under the "Customer Data" tab.

"INVDRW" = Name of the section.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
Defines the document number assignment in SAP.
document_number_assignment "master"
"master" = The number of the master document is taken over.

The sub-element <primary_application> determines which application is responsible for this master document
(primary application) and defines the rules for checking the originals in and out.

Attribute of the subelement <primary_application>


Attribute Value Description
Name of a section in the attribute mapping file in which the attribute exchange
between SAP and the application is defined.
attribute_section "INVDRW"
"INVDRW" = Name of the section in the attribute mapping file.

The sub-element <checkin_rules> determines how files in the Additional directory and originals on the
document are handled during check-in. It contains several subelements for this purpose.
The subelement <save_direct> determines which additional files (additional formats) are stored in the
Additional directory when saving as originals on the document. It contains the subelement <plmfile>, which
determines the individual additional file types.

Attributes of subelements <plmfile> of subelement <save_direct> of <checkin_rules>


Attribute Value Description
Filters by filenames using regular expressions.
".*\.preview\.jpg",
filename_pattern
".*\.preview\.gif"
".*\.preview\.jpg", ".*\.preview\.gif" = Filter masks.
Workstation application identifiers for the
individual additional formats.
workstation_application "EPJ", "EPG"
"EPJ", "EPG" = Identifiers of the document types.
Description of the respective additional files.
"ECtr Preview (jpeg)", "ECtr
description
Preview (gif)" "ECtr Preview (jpeg)", "ECtr Preview (gif)" =
Description of the additional files.

And now the DType template for individual parts (standard parts and sheet metal parts):

CIDEON Software & Services GmbH & Co. KG Page 64 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Generic DType definition "IPTML" for Inventor

<DType type="template" identifier="IPTML" include_template="INMDL" application_type="INV"


application_role="P">
...
</DType>

Attributes of element <DType> for template definition "IPTML


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IPTML"
"IPTML" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INMDL"
"INMDL" = The DType template with the ID "INMDL" from this "dtype.xml" file
is included.
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP Engineering
application_type "INV" Control Center.

"INV" = For Inventor, this is the Workstation Application (WSAppl).


This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "P"
"P" = Identification of the object type for parts.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the
tree.
icon_position "1"
"1" = Far left, "6" = far right.
Identification of a symbol group. Other symbols can be
displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the
symbol to be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_part$(FAMILY)"
"{0}/tree/inv/inventor_part$(FAMILY)" = The icon file.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attribute of the subelement <document_create>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 65 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SAP document type for the newly created document.
document_type "IPT"
"IPT" = SAP document type.

The sub-element <primary_application> determines which application is responsible for this master document
(primary application) and defines the rules for checking the originals in and out.

Attribute of the subelement <primary_application>


Attribute Value Description
Determines whether a relative path should be used to address a document of this
type.
use_relative_path "yes"
"yes" = Use relative paths.

The sub-element <checkin_rules> determines how files in the Additional directory and originals on the
document are handled during check-in. It contains several subelements for this purpose.

Attribute of the subelement <checkin_rules> of <primary_application>


Attribute Value Description
"yes" = Prevents a document without CAD from being checked in via the
from_application_only "yes"
context menu in the ECTR desktop view.

The subelement <save_direct> determines which additional files (additional formats) are stored in the
Additional directory when saving as originals on the document. It contains the subelement <plmfile>, which
determines the individual additional file types.

Attributes of subelements <plmfile> of subelement <save_direct> of <checkin_rules>


Attribute Value Description
".*\.preview\.jpg", Filters by file name using regular expressions.
filename_pattern ".*\.preview\.gif", ".*_mono\.rh", ".*\.preview\.jpg", ".*\.preview\.gif",
".*_mono\.vds" ".*_mono\.rh", ".*_mono\.vds" = Filter masks.
The respective file name extensions of the
additional file types to be backed up in the file
extension "jt", "rh" system.
"jt", "rh" = File name extensions of the
additional file types.
Workstation application identifiers for the
individual additional formats.
workstation_application "EPJ", "EPG", "JT", "RHM", "RH"
"EPJ", "EPG", "JT", "RHM", "RH" = Identifiers of
the document types.
Description of the respective additional files.
"ECtr Preview (jpeg)", "ECtr
"ECtr Preview (jpeg)", "ECtr Preview (gif)", "ECtr
Preview (gif)", "ECtr 3D Preview",
description 3D Preview", "Monolithic RH", "Monolithic VDS",
"Monolithic RH", "Monolithic VDS",
"SAP 3D Preview" = Description of the additional
"SAP 3D Preview"
files.

The DType template for assemblies follows:

CIDEON Software & Services GmbH & Co. KG Page 66 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Generic DType definition "IAMLT" for Inventor

<DType type="template" identifier="IAMLT" include_template="INMDL" application_type="INV"


application_role="A">
...
</DType>

Attributes of element <DType> for template definition "IAMLT


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IAMLT"
"IAMLT" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INMDL"
"INMDL" = The DType template with the ID "INMDL" from this file is included.
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP Engineering
application_type "INV" Control Center.

"INV" = For Inventor, this is the workstation application (WSAppl).


This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "A"
"A" = Identifier of the object type for assemblies.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
icon_position "1" the tree.
"1" = Far left, "6" = far right.
Identification of a symbol group. Other symbols
icon_group "default" can be displayed depending on their status.
"default" = This is the default icon.
Path for determining the icon file containing the
symbol to be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_assembly$(FAMILY)"
"{0}/tree/inv/inventor_assembly$(FAMILY)" =
The icon file.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IAM"
"IAM" = SAP document type.

CIDEON Software & Services GmbH & Co. KG Page 67 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether the file name for the original is renamed during
document creation according to the set naming rules, or whether the file
rename_template_filename "yes" name of the original file is transferred unchanged.
"yes" = The file name of the original is renamed when the document is
created

The DType template for presentations follows:

Generic DType definition "IPNTL" for Inventor

<DType type="template" identifier="IPNTL" include_template="INDRW" application_type="INV"


application_role="D">
...
</DType>

Attributes of element <DType> for template definition "IPNTL


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The ID
identifier "IPNTL" must be one to five characters long.
"IPNTL" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INDRW"
"INDRW" = The DType template with the ID "INDRW" from this "dtype.xml" file
is included.
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP Engineering
application_type "INV"
Control Center.
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = Identifier of the object type for Drawings.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "1"
"1" = Far left, "6" = far right.
Identification of a symbol group. Other symbols can be
displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the symbol
to be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_presentation"
"{0}/tree/inv/inventor_presentation" = The icon file.

The subelement <document_create> contains settings that control how a new document is created in SAP.

CIDEON Software & Services GmbH & Co. KG Page 68 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the subelement <document_create>
Attribute Value Description
SAP document type for the newly created document.
document_type "IPN"
"IPN" = SAP document type.
Defines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = The SAP system assigns the number automatically.

The subelement <seedfile> contains settings for the template file. Several template files can be assigned, i.e.
<seedfile> can occur several times. This contains the subelement <description>, which defines description
texts in different languages. There are also template files for the Inventor versions "2019" to "2021".

Attributes of the 1st subelement <seedfile> of subelement <document_create>


Attribute Value Description
When type="template" is used, this attribute defines the file name
of the template file to be used. A file with this name must exist,
otherwise the program will abort with an error.
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).ipn"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).ipn" = File name of the template file to be used for
presentations with inch dimensions.
Defines how the original of the document is created.
type "template"
"template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is preset in
the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type="select" this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipn" the files matching the filter are offered for selection.

"*.ipn" = Filter for the file extension.


Identifier of the template description in the dictionary.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard(in)" = Dictionary identifier.

Attributes of the 2nd subelement <seedfile> of subelement <document_create>


Attribute Value Description
The filename attribute is used to specify the template file to be
used. You can select a template file in the Create Document dialog
using a file selection dialog.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).ipn"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).ipn" = File name of the template file for presentations with
millimeter dimensions.
Defines how the original of the document is created.
type "template"
"template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is preset in
the "Create Document" dialog.
default "yes"
"yes" = This template file is the default.
When selecting a template file with type="select" this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipn" the files matching the filter are offered for selection.

"*.ipn" = Filter for the file extension.


Identifier of the description of the template in the dictionary.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard(mm)" = Dictionary identifier.

The following subelement <seedfile> contains settings for the version independent template file.

CIDEON Software & Services GmbH & Co. KG Page 69 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the 3rd subelement <seedfile> of subelement <document_create>
Attribute Value Description
When type="template" is used, this attribute defines the file name of the
template file that is used.
filename ""
"" = No template file.
Defines how the original of the document is created. The filename attribute
specifies the template file to be used. A template file can be selected in the
type "select" "Create Document" dialog using a file selection dialog.

"select" = A template file can be selected in the "Create Document" dialog.


This allows you to determine whether this template file is preset in the "Create
Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type="select" this attribute defines the
filter for the file extension. In the file selection dialog, the files matching the
extension_filter "*.ipn" filter are offered for selection.

"*.ipn" = Filter for the file extension.


Identifier of the template description in the dictionary.
dictionary_identifier "select"
"select" = Dictionary identifier.

The DType template for drawings of type "IDW":

Generic DType definition "IDWTL" for Inventor

<DType type="template" identifier="IDWTL" include_template="INDRW" application_type="INV"


application_role="D">
...
</DType>

Attributes of element <DType> for template definition "IDWTL


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IDWTL"
"IDWTL" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INDRW"
"INDRW" = The DType template with the ID "INDRW" from this file is included.
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP Engineering
application_type "INV" Control Center.

"INV" = For Inventor, this is the workstation application (WSAppl).

CIDEON Software & Services GmbH & Co. KG Page 70 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = Identifier of the object type for Drawings.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "1"
"1" = Far left, "6" = far right.
Identification of a symbol group. Other symbols can be
displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the symbol to
be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_drawing"
"{0}/tree/inv/inventor_drawing" = The icon file.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IDW"
"IDW" = SAP document type.
Defines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = The SAP system assigns the number automatically.

The subelement <seedfile> contains settings for the template file. Several template files can be assigned, i.e.
<seedfile> can occur several times. This contains the subelement <description>, which defines description
texts in different languages. There are also template files for the Inventor versions "2019" to "2021".

Attributes of the 1st subelement <seedfile> of subelement <document_create>


Attribute Value Description
When type="template" is used, this attribute defines the file
name of the template file to be used. A file with this name must
exist, otherwise the program will abort with an error.
"@PLM_INSTDIR@\applications\INV\templates\2021\English\ANSI
filename
(in).idw"
"@PLM_INSTDIR@\applications\INV\templates\2021\English\ANSI
(in).idw" = File name of the template file to be used for
drawings of type "IDW" with inch dimensions.
Defines how the original of the document is created.
type "template" "template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is preset
in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
For dependent documents only: Determines whether the
dependent document receives a component reference (sort
string: 'DC') or whether the document is a simple dependent
component_reference "yes"
document (sort string: 'D')

"yes" = A component reference is created.

CIDEON Software & Services GmbH & Co. KG Page 71 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Identifier of the template description in the dictionary.
dictionary_identifier "20xx.English.ANSI(in)"
"20xx.English.ANSI(in)" = Dictionary identifier.

Attributes of the 2nd subelement <seedfile> of subelement <document_create>


Attribute Value Description
The filename attribute is used to specify the template file to be
used. You can select a template file in the Create Document dialog
using a file selection dialog.
filename "@PLM_INSTDIR@\applications\INV\templates\2021\Metric\DIN.idw"
"@PLM_INSTDIR@\applications\INV\templates\2021\Metric\DIN.idw"
= File name of the template file for drawings of type "IDW" with
millimeter dimensions.
Defines how the original of the document is created.
type "template" "template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is preset in
the "Create Document" dialog.
default "yes"
"yes" = This template file is the default.
For dependent documents only: Determines whether the
dependent document receives a component reference (sort string:
component_reference "yes" 'DC') or whether the document is a simple dependent document
(sort string: 'D').
"yes" = A component reference is created.
Identifier of the template description in the dictionary.
dictionary_identifier "20xx.Metric.DIN"
"20xx.Metric.DIN" = Dictionary identifier.

Attributes of the 3rd subelement <seedfile> of subelement <document_create>


Attribute Value Description
When type="template" is used, this attribute defines the file name of the template file to be used.
filename ""
"" = No template file.
Defines how the original of the document is created. The filename attribute specifies the template file to be used. A template file can be
selected in the "Create Document" dialog using a file selection dialog.
type "select"
"select" = A template file can be selected in the "Create Document" dialog.
This allows you to determine whether this template file is preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type="select" this attribute defines the filter for the file extension. In the file selection dialog, the files
matching the filter are offered for selection.
extension_filter "*.idw"
"*.idw" = Filter for the file extension.
Identifier of the template description in the dictionary.
dictionary_identifier "select"
"select" = Dictionary identifier.

Finally the DType template for drawings of type "DWG":

Generic DType definition "IDWGT" for Inventor

<DType type="template" identifier="IDWGT" include_template="INDRW" application_type="INV"


application_role="D">
...
</DType>

Attributes of element <DType> for template definition "IDWGT


Attribute Value Description
Defines the type of DType definition.
type "template"
"template" = This is a DType template definition.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IDWGT"
"IDWGT" = ID of this template definition.
Determines which template definition is included in this definition.
include_template "INDRW"
"INDRW" = The DType template with the ID "INDRW" from this file is included.

CIDEON Software & Services GmbH & Co. KG Page 72 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Identifier for the application responsible for this document (workstation
application). This application is used to open the file from the SAP Engineering
application_type "INV"
Control Center.
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = Identifier of the object type for Drawings.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "1"
"1" = Far left, "6" = far right.
Identification of a symbol group. Other symbols can be
displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the symbol to
be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_drawing"
"{0}/tree/inv/inventor_drawing" = The icon file.

The <program_options> subelement contains various settings that control the behavior of the document in
SAP Engineering Control Center.

Attributes of the subelement <program_options>


Attribute Value Description
So-called "Function Groups" can be defined. For documents with a common
function group you can define e.g. own context menus. This defines the
function_group "DOC_INVDWG" Function Group to which documents of this type belong.

"DOC_INVDWG" = Identification of the Function Group.

The subelement <document_create> contains settings that control how a new document is created in SAP.

Attributes of the subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IDW"
"IDW" = SAP document type.
Defines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = The SAP system assigns the number automatically.

The subelement <seedfile> contains settings for the template file. Several template files can be assigned, i.e.
<seedfile> can occur several times. This contains the subelement <description>, which defines description
texts in different languages.

Attributes of the 1st subelement <seedfile> of subelement <document_create>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 73 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When type="template" is used, this attribute defines the file
name of the template file to be used. A file with this name must
"@PLM_INSTDIR@\applications\INV\templates\20xx\English\ANSI exist, otherwise the program will abort with an error.
filename
(in).dwg" "@PLM_INSTDIR@\applications\INV\templates\20xx\English\ANSI
(in).dwg" = File name of the template file to be used for
drawings of type "DWG".
Defines how the original of the document is created.
type "template"
"template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is
preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
For dependent documents only: Determines whether the
dependent document receives a component reference (sort
string: 'DC') or whether the document is a simple dependent
component_reference "yes"
document (sort string: 'D').

"yes" = A component reference is created.


Identifier of the template description in the dictionary.
dictionary_identifier "20xx.English.ANSI(in)"
"20xx.English.ANSI(in)" = Directory identifier.

Attributes of the 2nd subelement <seedfile> of subelement <document_create>


Attribute Value Description
The filename attribute is used to specify the template file to be
used. You can select a template file in the Create Document dialog
using a file selection dialog.
filename "@PLM_INSTDIR@\applications\INV\templates\20xx\Metric\DIN.dwg"
"@PLM_INSTDIR@\applications\INV\templates\20xx\Metric\DIN.dwg"
= File name of the template file for drawings of the type "DWG".
Defines how the original of the document is created.
type "template"
"template" = Via the attribute "filename" the template file to be
used is specified.
This allows you to determine whether this template file is preset in
the "Create Document" dialog.
default "yes"
"yes" = This template file is the default.
For dependent documents only: Determines whether the
dependent document receives a component reference (sort string:
'DC') or whether the document is a simple dependent document
component_reference "yes"
(sort string: 'D').

"yes" = A component reference is created.


Identifier of the template description in the dictionary.
dictionary_identifier "20xx.Metric.DIN"
"20xx.Metric.DIN" = Directory identifier.

Attributes of the 3rd subelement <seedfile> of subelement <document_create>


Attribute Value Description
When type="template" is used, this attribute defines the file name of the
template file to be used. A file with this name must exist, otherwise the
filename "" program will abort with an error.

"" = No template file.


Defines how the original of the document is created. The filename attribute
specifies the template file to be used. A template file can be selected in the
type "select" "Create Document" dialog using a file selection dialog.

"select" = A template file can be selected in the "Create Document" dialog.


This allows you to determine whether this template file is preset in the "Create
Document" dialog.
default "no"
"no" = This template file is not preset.

CIDEON Software & Services GmbH & Co. KG Page 74 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When selecting a template file with type="select" this attribute defines the
filter for the file extension. In the file selection dialog, the files matching the
extension_filter "*.dwg"
filter are offered for selection.
"*.dwg" = Filter for the file extension.
Identifier of the template description in the dictionary.
dictionary_identifier "select"
"select" = Directory identifier.

The DType definition for master documents

The SAP Engineering Control Center distinguishes between master documents and dependent documents
(nonmaster documents). The master document is the main document and contains the CAD model file to be
processed. In addition, the master document is the basis for the preparation of the bill of materials.

NOTE:
It is recommended to maintain only the language English directly in the file "dtype.xml"! All other
languages will be offered via the particular "dictionary.txt" file. This affects the definitions of
DTypes and Seedfiles. All elements <description language="XY"> are omitted except English
which are used as fallback.

The DType definition is divided into template definitions and actual DType definitions for master documents
which are included in a template. First, the DType definition for Parts:

DType definition for master documents of type "IPT"

<DType type="master" identifier="IPT" include_template="IPTML" application_type="INV"


application_role="P" sort_key="1">
...
</DType>

Attributes of element <DType> of the DType definition "IPT"


Attribute Value Description
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IPT"
"IPT" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IPTML"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the "RES4" field of the SAP table DRAW.
application_role "P"
"P" = Identifier of the object type for parts.

CIDEON Software & Services GmbH & Co. KG Page 75 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Defines a sorting key which is used for an alphanumeric sorting of the DType
entries in the combo box for DType selection.
sort_key "1"
"1" = sorting key.

The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center. The subelement describes settings for versioning documents.

Attribute of the subelement <new_version> of subelement <program_options>


Attribute Value Description
Determines whether, when versioning, the original is given a file name
according to the part rules for this DType or whether the previous file
rename_master_original "no" name is kept unchanged.

"no" = keep file name unchanged.


Determines whether the entire part family group (generic part +
variants) is versioned during versioning of the generic part (template).
take_instances_for_generic "yes"
"yes" = The variants are co-versioned during the versioning of the
generic part.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of the subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IPT"
"IPT" = Inventor Part document.
Specifies whether the filename for the original is renamed during the
document creation according to the set naming rules, or whether the
filename of the template file is adopted unchanged.
rename_template_filename "yes"
"yes" = The filename of the original is renamed when the document is
created.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2019 to 2021. These differ only in the access thread of the respective template files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models with
inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create document" dialog.
default "no"
"no" = This template file is not preset.

CIDEON Software & Services GmbH & Co. KG Page 76 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard(in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard(mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
template file that is used.
filename "Standard.ipt"
"Standard.ipt" = file name.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute defines
the filter for the file extension. In the file selection dialog, the files
extension_filter "*.ipt" matching the filter are offered for selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

CIDEON Software & Services GmbH & Co. KG Page 77 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the subelements <allowed_nonmaster>
Attributes Value Description
The unique DType ID of the dependent document definition.
"IDWNM",
DType
"IDWGN"
"IDWNM", "IDWGN" = DTypes of the permitted dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The following is the DType definition for standard parts:

DType definition of master documents of DType "IPTNR"

<DType type="master" identifier="IPTNR" include_template="IPTML" application_type="INV"


application_role="P">
...
</DType>

Attributes of the element <DType> of the DType definition "IPTNR"


Attribute Value Description
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IPTNR"
"IPTNR" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IPTML"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "P"
"P" = Identifier of the object type for parts.

The <program_options> subtree contains various settings that control the behavior of the document in the
SAP Engineering Control Center.

Attributes of subelement <program_options>


Attribute Value Description
Sets the Function Group to which the document belongs. For documents with
a common Function Group, for example, specific context menus can be
function_group "DOC_INVNR" defined.

"DOC_INVNR" = This DType is assigned to the Function Group "DOC_INVNR".

CIDEON Software & Services GmbH & Co. KG Page 78 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Defines whether this DType is visible in the combo box of the available
document types in the "Create document" dialog.
show_for_create "no"
"no" = Document is not visible.

The subelement <copy_as> determines how the document behaves during a "CopyAs" action and how SAP
Engineering Control Center reacts to the document.

Attribute to the subelement <copy_as> from subelement <program_options>


Attribute Value Description
Determines whether this DType is visible in the combo box of the available document
types in the "Create Document" dialog.
allowed "no"
"no" = Document is not visible.

The <new_version> subelement of <program_options> contains various settings that control the behavior of
the document in the SAP Engineering Control Center. The subelement describes settings for versioning
documents.

Attributes of the subelement <new_version> of subelement <program_options>


Attribute Value Description
Determines whether the original is given a filename according to the
component rules for this DType during versioning, or whether the
rename_master_original "no" previous filename is retained unchanged.

"no" = The file name is retained.


Determines whether the entire part family group (generic part +
variants) is versioned during versioning of the generic part (template).
take_instances_for_generic "yes"
"yes" = The variants are co-versioned during the versioning of the
generic part.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IPT"
"IPT" = Inventor Part document.
Specifies whether the filename for the original is renamed during the
document creation according to the set naming rules, or whether the
filename of the template file is adopted unchanged.
rename_template_filename "no"
"no" = The filename of the template file is copied to the original in the
document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2019 to 2021. These differ only in the access thread of the respective template files.

CIDEON Software & Services GmbH & Co. KG Page 79 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>
Attribute Value Description
Defines the filename of the template file to be used for models with
inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard(in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard (mm)" Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
template file that is being used.
filename "Standard.ipt"
"Standard.ipt" = File name.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.

CIDEON Software & Services GmbH & Co. KG Page 80 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When selecting a template file with type = "select", this attribute defines
the filter for the file extension. In the file selection dialog, the files
extension_filter "*.ipt" matching the filter are offered for selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

Attributes of subelements <allowed_nonmaster>


Attribute Values Description
The unique DType-ID of the dependent document definition.
"IDWNM",
DType
"IDWGN"
"IDWNM", "IDWGN" = DTypes of the allowed dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Max. Number of possible dependent documents of this type.

The DType definition for standard parts:

DType definition for master documents of type "IPTCC"

<DType type="master" identifier="IPTCC" include_template="IPTML" application_type="INV"


application_role="PN">
...
</DType>

Attribute Value Description


Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IPTCC"
"IPTCC" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IPTML"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "PN"
"PN" = Identifier of the object type for standard parts.

The <program_options> subelement contains various settings that control the behavior of the document in the

CIDEON Software & Services GmbH & Co. KG Page 81 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SAP Engineering Control Center.

Attributes of subelement <program_options>


Attribute Value Description
Function groups can be defined. For documents with a common function
group, e.g. custom context menus. This defines the function group to which
function_group "DOC_INVCC" documents of this type belong.

"DOC_INVCC" = Identifier of the function group.


Defines whether this DType is visible in the combo box of the available
document types in the "Create document" dialog.
show_for_create "no"
"no" = Document is not visible.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IPT"
"IPT" = Inventor Part document.
Specifies whether the filename for the original is renamed during the
document creation according to the set naming rules, or whether the
filename of the template file is adopted unchanged.
rename_template_filename "no"
"no" = The filename of the template file is copied to the original in the
document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2019 to 2021. These differ only in the access thread of the respective template files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models with
inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard(in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 82 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.ipt" the files matching the filter are offered for selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard(mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
template file that is being used.
filename "Standard.ipt"
"Standard.ipt" = File name.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute defines
the filter for the file extension. In the file selection dialog, the files
extension_filter "*.ipt" matching the filter are offered for selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "select"
"select" = Description.

The DType definition for Sheet Metal:

DType definition for master documents of type "IPTSM"

<DType type="master" identifier="IPTSM" include_template="IPTML" application_type="INV"


application_role="P">
...
</DType>

Attributes of element <DType> of DType definition "IPTSM"


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 83 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IPTSM"
"IPTSM" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IPTML"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "P"
"P" = Identifier of the object type part.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IPT"
"IPT" = Inventor Part document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2019 to 2021. These differ only in the access thread of the respective template files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models
with inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Sheet
filename
Metal (in).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Sheet
Metal (in).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file
to use.
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this
attribute defines the filter for the file extension. In the file
selection dialog, the files matching the filter are offered for
extension_filter "*.ipt"
selection.

"* .ipt" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.SheetMetal(in)"
"20xx.English.SheetMetal (in)" = Description.

CIDEON Software & Services GmbH & Co. KG Page 84 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>
Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Sheet
filename
Metal (mm).ipt"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Sheet
Metal (mm).ipt" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template
file to use.
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this
attribute defines the filter for the file extension. In the file
selection dialog, the files matching the filter are offered for
extension_filter "*.ipt"
selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "20xx.SheetMetal (mm)"
"20xx.SheetMetal (mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
template file that is being used.
filename "Standard.ipt"
"Standard.ipt" = File name.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute defines
the filter for the file extension. In the file selection dialog, the files
extension_filter "*.ipt" matching the filter are offered for selection.

"* .ipt" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

Attributes of the subelements <allowed_nonmaster>


Attribute Value Description
The unique DType ID of the dependent document definition.
"IDWNM",
DType
"IDWGN"
"IDWNM", "IDWGN" = DTypes of the permitted dependent documents.

CIDEON Software & Services GmbH & Co. KG Page 85 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for Assemblies:

DType definition for master document of type "IAM"

<DType type="master" identifier="IAM" include_template="IAMLT" application_type="INV"


application_role="A" sort_key="1">
...
</DType>

Attributes of element <DType> of DType definition "IAM"


Attribute Value Description
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IAM"
"IAM" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IAMLT"
"IAMLT" = The DType template with the ID "IAMLT" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "A"
"A" = Identifier of the object type for assemblies.
Defines a sort key that is used for alphanumeric sorting of DType entries in the
DType selection combo box.
sort_key "1"
"1" = Sort key.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IAM"
"IAM" = Inventor Assembly document.
Specifies whether the filename for the original is renamed during the
document creation according to the set naming rules, or whether the
filename of the template file is adopted unchanged.
rename_template_filename "yes"
"yes" = The filename of the original is renamed when the document is
created.

CIDEON Software & Services GmbH & Co. KG Page 86 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2014 and 2019 to 2021. These differ only in the access thread of the respective template
files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models with
inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard(in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard(mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the
filename of the template file that is being used.
filename "@PLM_INSTDIR@\applications\inv\templates\2014\Standard.iam"
"@PLM_INSTDIR@\applications\inv\templates\2014\Standard.iam"
= File name.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".

CIDEON Software & Services GmbH & Co. KG Page 87 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as a dependent
document (Nonmaster document).

Attributes of the subelements <allowed_nonmaster>


Attribute Value Description
"IPNNM", The unique DType ID of the dependent document definition.
DType "IDWNM",
"IDWGN" "IPNNM", "IDWNM", "IDWGN" = DTypes of the permitted dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for Generic Assemblies:

DType definition for master documents of type "IAMNR"

<DType type="master" identifier="IAMNR" include_template="IAMLT" application_type="INV"


application_role="A">
...
</DType>

Attributes of element <DType> of DType definition "IAMNR"


Attribute Value Description
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IAMNR"
"IAMNR" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IAMLT"
"IAMLT" = The DType template with the ID "IAMLT" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "A"
"A" = Identifier of the object type for assemblies.

The <program_options> subelement contains various settings that control the behavior of the document in the

CIDEON Software & Services GmbH & Co. KG Page 88 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SAP Engineering Control Center.

Attributes of subelement <program_options>


Attribute Value Description
Function groups can be defined. For documents with a common function
group, e.g. custom context menus. This defines the function group to which
function_group "DOC_INVNR" documents of this type belong.

"DOC_INVNR" = Identifier of the function group.


Defines whether this DType is visible in the combo box of the available
document types in the "Create document" dialog.
show_for_create "no"
"no" = Document is not visible.

The subelement <copy_as> determines how the document behaves during a "CopyAs" action and how SAP
Engineering Control Center reacts to the document.

Attribute to the subelement <copy_as> from subelement <program_options>


Attribute Value Description
Determines whether this DType is visible in the combo box of the available document
types in the "Create Document" dialog.
allowed "no"
"no" = Document is not visible.

The subelement <new_version> describes settings for versioning documents.

Attributes of the subelement <new_version> of subelement <program_options>


Attribute Value Description
Determines whether the original is given a filename according to the
component rules for this DType during versioning, or whether the
rename_master_original "no" previous filename is retained unchanged.

"no" = The file name is retained.


Determines whether the entire part family group (generic part +
variants) is versioned during versioning of the generic part (template).
take_instances_for_generic "yes"
"yes" = The variants are co-versioned during the versioning of the
generic part.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IAM"
"IAM" = Inventor Assembly document.

CIDEON Software & Services GmbH & Co. KG Page 89 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Specifies whether the filename for the original is renamed during the
document creation according to the set naming rules, or whether the
filename of the template file is adopted unchanged.
rename_template_filename "no"
"no" = The filename of the template file is copied to the original in the
document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2014 and 2019 to 2021. These differ only in the access thread of the respective template
files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models with
inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
filename
(in).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Standard
(in).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of the template file.
dictionary_identifier "20xx.English.Standard(in)"
"20xx.English.Standard (in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
filename
(mm).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Standard
(mm).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Standard(mm)"
"20xx.Metric.Standard (mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 90 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When using type = "template", this attribute defines the
filename of the template file that is being used.
filename "@PLM_INSTDIR@\applications\inv\templates\2014\Standard.iam"
"@PLM_INSTDIR@\applications\inv\templates\2014\Standard.iam"
= Filepath of the template file to use.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create
document".
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as a dependent
document (Nonmaster document).

Attributes of the subelements <allowed_nonmaster>


Attribute Value Description
"IPNNM", The unique DType ID of the dependent document definition.
DType "IDWNM",
"IDWGN" "IPNNM", "IDWNM", "IDWGN" = DTypes of the permitted dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for Weldment Assemblies:

DType definition for master documents of type "IAMWM"

<DType type="master" identifier="IAMWM" include_template="IAMLT" application_type="INV"


application_role="A">
...
</DType>

Attributes of element <DType> of the DType definition "IAMWM"


Attribute Value Description
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IAMWM"
"IAMWM" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IAMLT"
"IAMLT" = The DType template with the ID "IAMLT" from this "dtype.xml" file is
included.

CIDEON Software & Services GmbH & Co. KG Page 91 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control
application_type "INV" Center.

"INV" = For Inventor, this is the workstation application (WSAppl).


This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "A"
"A" = Identifier of the object type for assemblies.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IAM"
"IAM" = Inventor Assembly document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for ANSI and DIN is available for Inventor versions
2019 to 2021. These differ only in the access thread of the respective template files.

Attributes of the 1. subelement <seedfile> (ANSI) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models with
ANSI.
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Weldment
filename
(ANSI).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Weldment
(ANSI).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset in
the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog, the
extension_filter "*.iam" files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.English.Weldment(ANSI)"
"20xx.English.Weldment(ANSI)" = Description.

Attributes of the 2. subelement <seedfile> (DIN) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for DIN models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Weldment
filename
(DIN).iam" "@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Weldment
(DIN).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template file to
use.
This can be used to determine whether this template file is preset
in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.

CIDEON Software & Services GmbH & Co. KG Page 92 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When selecting a template file with type = "select", this attribute
defines the filter for the file extension. In the file selection dialog,
extension_filter "*.iam" the files matching the filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Weldment(DIN)"
"20xx.Metric.Weldment(DIN)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
filename ""
template file that is being used. "" = No file path.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute defines the
filter for the file extension. In the file selection dialog, the files matching the
extension_filter "*.iam" filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

Attributes of the subelements <allowed_nonmaster>


Attribute Value Description
"IPNNM", The unique DType ID of the dependent document definition.
DType "IDWNM",
"IDWGN" "IPNNM", "IDWNM", "IDWGN" = DTypes of the permitted dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for Mold Design Assemblies:

DType definition for master documents of type "IAMMO"

<DType type="master" identifier="IAMMO" include_template="IAMLT" application_type="INV"


application_role="A">
...
</DType>

Attributes of the element <DType> of the DType definition "IAMMO"


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 93 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Specifies the type of DType definition.
type "master"
"master" = This is the definition for master documents.
Unique ID string of this DType definition throughout the XML document. The ID
must be one to five characters long.
identifier "IAMMO"
"IAMMO" = ID of this DType definition.
Determines which template definition is included in this definition.
include_template "IAMLT"
"IAMLT" = The DType template with the ID "IAMLT" from this "dtype.xml" file is
included.
Identifier for the application that is responsible for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = For Inventor, this is the workstation application (WSAppl).
This is used to set the object type in the RES4 field of the SAP table DRAW.
application_role "A"
"A" = Identifier of the object type for assemblies.

The <program_options> subtree contains various settings that control the behavior of the document in the
SAP Engineering Control Center.

Attributes of subelement <program_options>


Attribute Value Description
Defines whether this DType is visible in the combo box of the available document
types in the "Create document" dialog.
show_for_create "yes"
"yes" = Document is visible.

The <document_create> subelement determines how settings are made for how the document is created in
SAP.

Attributes of subelement <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IAM"
"IAM" = Inventor Assembly document.

The <seedfile> subelement contains settings for the template file. A plurality of template files may be
associated, e.g. <seedfile> can occur several times. It contains the subelement <description>, which defines
description texts in different languages. A seed file definition for inches and millimeters is available for
Inventor versions 2014 to 2018. These differ only in the access thread of the respective template files.

Attributes of the 1. subelement <seedfile> (inch) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for models
with inches (inches).
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Mold
filename
Design (in).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\English\Mold
Design (in).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template
file to use.

CIDEON Software & Services GmbH & Co. KG Page 94 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this
attribute defines the filter for the file extension. In the file
selection dialog, the files matching the filter are offered for
extension_filter "*.iam"
selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.English.Mold(in)"
"20xx.English.Mold(in)" = Description.

Attributes of the 2. subelement <seedfile> (metric) of subelement <document_create>


Attribute Value Description
Defines the filename of the template file to be used for metric
models.
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Mold
filename
Design (mm).iam"
"@PLM_INSTDIR@\applications\inv\templates\20xx\Metric\Mold
Design (mm).iam" = Filepath of the template file to use.
Determines how the original of the document is generated.
type "template"
"template" = The "filename" attribute specifies the template
file to use.
This can be used to determine whether this template file is
preset in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.
When selecting a template file with type = "select", this
attribute defines the filter for the file extension. In the file
selection dialog, the files matching the filter are offered for
extension_filter "*.iam"
selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "20xx.Metric.Mold(mm)"
"20xx.Metric.Mold(mm)" = Description.

The following is the seed file definition for version-independent template files.

Attributes of the 3. subelement <seedfile> of subelement <document_create>


Attribute Value Description
When using type = "template", this attribute defines the filename of the
template file that is being used.
filename ""
"" = No file path.
Determines how the original of the document is generated.
type "select"
"select" = A template file can be selected in the dialog "Create document".
This can be used to determine whether this template file is preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type = "select", this attribute defines the
filter for the file extension. In the file selection dialog, the files matching the
extension_filter "*.iam" filter are offered for selection.

"* .iam" = File extension.


Description of this template file.
dictionary_identifier "select"
"select" = Description.

CIDEON Software & Services GmbH & Co. KG Page 95 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

Attributes of subelements <allowed_nonmaster>


Attribute Value Description
"IPNNM", The unique DType ID of the dependent document definition.
DType "IDWNM",
"IDWGN" "IPNNM", "IDWNM", "IDWGN" = DTypes of the permitted dependent documents.
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for presentations:

The DType definition for master documents of type "IPN"

<DType type="master" identifier="IPN" include_template="IPNTL" application_type="INV"


application_role="D">
...
</DType>

Attribute of element <DType> of DType definition "IPN"


Attribute Value Description
Sets the type of DType definition.
type "master"
"master" = Relates to the definition for master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one and five characters long.
identifier "IPN"
"IPN" = ID of this DType definition.
Determines which template definition should be integrated into this definition.
include_template "IPNTL"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file is
included.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = This is the Workstation Application for Inventor (WSAppl).
Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

The subelements <allowed_nonmaster> determine which document types are allowed as dependent
documents (Nonmaster document).

Attributes of subelements <allowed_nonmaster>


Attribute Value Description
The unique DType ID of the dependent document definition.
"IDWNM",
DType
"IDWGN"
"IDWNM", "IDWGN" = DTypes of the permitted dependent documents.

CIDEON Software & Services GmbH & Co. KG Page 96 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Number of allowed dependent documents for this master document.
max_count "99"
"99" = Maximal number of possible dependent documents of this type.

The DType definition for Drawings ("IDW"):

The DType definition for master documents of type "IDW"

<DType type="master" identifier="IDW" include_template="IDWTL" application_type="INV"


application_role="D">
...
</DType>

Attribute of element <DType> of DType definition "IDW"


Attribute Value Description
Sets the type of DType definition.
type "master"
"master" = Relates to the definition for master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one to five characters long.
identifier "IDW"
"IDW" = ID of this DType definition.
Determines which template definition should be integrated into this definition.
include_template "IDWTL"
"IPWTL" = The DType template with the ID "IPWTL" from this "dtype.xml" file is
included.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = This is the Workstation Application for Inventor (WSAppl).
Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

The DType definition for Drawings ("DWG"):

The DType definition for master documents of type "IDWG"

<DType type="master" identifier="IDWG" include_template="IDWGT" application_type="INV"


application_role="D">
...
</DType>

Attribute of element <DType> of DType definition "IDWG"


Attribute Value Description
Sets the type of DType definition.
type "master"
"master" = Relates to the definition for master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one to five characters long.
identifier "IDWGT"
"IDWGT" = ID of this DType definition.

CIDEON Software & Services GmbH & Co. KG Page 97 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines which template definition should be integrated into this definition.
include_template "IDWGT"
"IDWGT" = The DType template with the ID "IDWGT" from this "dtype.xml" file is
included.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control Center.
application_type "INV"
"INV" = This is the Workstation Application for Inventor (WSAppl).
Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

Finally, the DType definition for CAD parameter files of type "XLS":

The DType definition for master documents of type "XLS"

<DType type="master" identifier="CPA" include_template="TXLS" application_type="XLS"


group="Microsoft Office">
...
</DType>

Attribute of element <DType> the template definition "CPA"


Attribute Value Description
Sets the type of DType definition.
type "master"
"master" = Relates to the definition for master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one and five characters long.
identifier "CPA"
"CPA" = ID of this DType definition.
Determines which template definition should be integrated into this
definition.
include_template "TXLS"
"TXLS" = The DType template with the "XLS" ID from this "dtype.xml" file
is included. This is the generic definition.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control
application_type "XLS" Center.

"XLS" = This is the Workstation Application for (WSAppl).


Defines the group designation for master documents. The group
designation helps to organize DTypes within the dialog "create
"Microsoft
group document".
Office"
"Microsoft Office" = Document belongs to this group.

The subelement <icon> defines an abbreviation that will be used when determining the applicable symbol in
SAP Engineering Control Center. It also contains the subelement <icondef>.

Attributes of the first subelement <icondef> from subelement <icon>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 98 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Position of the symbol in the document entry in the
tree.
icon_position "1"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on the
status, other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Path to determine the icon file, which contains the
applicable symbol for this symbol position.
icon_identifier "tree/xls/$(TYPE)$(SUBTYPE)$(FAMILY)"
"tree/xls/$(TYPE)$(SUBTYPE)$(FAMILY)" = The icon
file.

Attributes of the second subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "2"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on
the status, other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Turns the symbol color on or off. This attribute
allows the correct display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the
applicable symbol for this symbol position.
icon_identifier "flag/flag_version_$(HER)$(HNV)$(HRV)"
"flag/flag_version_$(HER)$(HNV)$(HRV)" = The
icon file.

Attributes of the third subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "3"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on
the status, other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Turns the symbol color on or off. This attribute
allows the correct display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains
the applicable symbol for this symbol position.
"flag/flag_primaryfiles_moe$(MOE)_moc$(MOC)
icon_identifier
_iu$(IN_USE_BY_OTHER)"
"flag/flag_primaryfiles_moe$(MOE)_moc$(MOC)
_iu$(IN_USE_BY_OTHER)" = The icon file.

CIDEON Software & Services GmbH & Co. KG Page 99 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the fourth subelement <icondef> from subelement <icon>
Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "3"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on the status, other
symbols can be represented.
icon_group "released"
"released" = This is the "Released" symbol.
Turns the symbol color on or off. This attribute allows the correct
display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the applicable
symbol for this symbol position.
icon_identifier "flag/doc_is_released"
"flag/doc_is_released" = The icon file.

Attributes of the fifth subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "3"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on the status,
other symbols can be represented.
icon_group "blocked"
"blocked" = This is the "Blocked" symbol.
Turns the symbol color on or off. This attribute allows the
correct display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the applicable
"flag/doc_is_blocked" = The symbol for this symbol position.
icon_identifier
icon file.
"flag/doc_is_blocked" = The icon file.

Attributes of the fifth subelement <icondef> from subelement <icon>


Attribute Value Description
Position des Symbols im Dokumenteintrag im Baum.
icon_position "3"
"1" = far left, "7" = far right.
Identification of a symbol group. Status-depending, other symbols
can be represented.
icon_group "inchange"
"inchange" = This is the "In Change" symbol.
Turns the symbol color on or off. This attribute allows the correct
display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.

CIDEON Software & Services GmbH & Co. KG Page 100 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Path to determine the icon file, which contains the applicable
symbol for this symbol position.
icon_identifier "flag/doc_is_in_change"
"flag/doc_is_in_change" = The icon file.

Attributes of the seventh subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "3"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on the status, other
symbols can be represented.
icon_group "archived"
"archived" = This is the "Archived" symbol.
Turns the symbol color on or off. This attribute allows the correct
display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the applicable
symbol for this symbol position.
icon_identifier "flag/doc_is_archived"
"flag/doc_is_archived" = The icon file.

Attributes of the eighth subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "4"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on
the status, other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Turns the symbol color on or off. This attribute
allows the correct display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains
the applicable symbol for this symbol position.
"flag/flag_primaryfiles_moe$(MOE)_moc$(MOC)
icon_identifier
_iu$(IN_USE_BY_OTHER)"
"flag/flag_primaryfiles_moe$(MOE)_moc$(MOC)
_iu$(IN_USE_BY_OTHER)" = The icon file.

Attributes of the ninth subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "5"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on
the status, other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.

CIDEON Software & Services GmbH & Co. KG Page 101 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Turns the symbol color on or off. This attribute
allows the correct display in filter lists.
use_status_color "yes"
"yes" = The symbol color for this icon is on.
Path to determine the icon file, which contains
the applicable symbol for this symbol position.
icon_identifier "flag/flag_material_$(MATX)$(MAT_AMB)"
"flag/flag_material_$(MATX)$(MAT_AMB)" = The
icon file.
Determines if the determination of symbol
colors of the document status or material
referenced_object "material" status is used.

"material" = The material status will be used.

Attributes of the first subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "6"
"1" = far left, "7" = far right.
Identification of a symbol group. Depending on the status, other
symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Turns the symbol color on or off. This attribute allows the correct
display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the applicable symbol
for this symbol position.
icon_identifier "flag/flag_$(DRAW)"
"flag/flag_$(DRAW)" = The icon file.

Attributes of the eleventh subelement <icondef> from subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in the tree.
icon_position "7"
"1" = far left, "7" = far right.
Identification of a symbol group. Status-depending, other symbols
can be represented.
icon_group "default"
"default" = This is the standard symbol.
Turns the symbol color on or off. This attribute allows the correct
display in filter lists.
use_status_color "no"
"no" = The symbol color for this icon is off.
Path to determine the icon file, which contains the applicable
symbol for this symbol position.
icon_identifier "gos_note_flag_$(HGN)"
"gos_note_flag_$(HGN)" = The icon file.

The subelement <program_options> contains different settings, which control the behavior of the document in

CIDEON Software & Services GmbH & Co. KG Page 102 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
the SAP Engineering Control Center.

Attributes of the <program_options> subelement


Attribute Value Description
Determines whether in dialog "create document " this DType is
visible in the combo box for accessible document types.
show_for_create "yes"
"yes" = Document is visible.
Determines if document is normal document with original and
designated Workstation Application or container object for
additional originals without explicit original.
has_primary_application "yes"
"yes" = the document has an original with the designated
Workstation application
Determines if the newly created document has a dirty flag.
dirty_flag "yes"
"yes" = The document has a dirty flag.
Determines if change of status applies during check in at SAP
Engineering Control Center or if SAP System conducts change of
attempt_status_change_on_checkin "yes" status.

"yes" = Change of status by SAP Engineering Control Center.


Sets the Function Group to which the document belongs. For
documents with a common Function Group, for example, specific
function_group "DOC" context menus can be defined.

"DOC" = This DType is assigned to the Function Group "DOC".


Name of a section in the attribute mapping file that is defined in
the customer-specific data. The data will be displayed in the
object browser under the
customer_data_section ""
"Customer Data" tab.

"" = No section has been defined.

The subelement <copy_as> determines how the document behaves during a "CopyAs" action and how SAP
Engineering Control Center reacts to the document.

Attribute to the subelement <copy_as> from subelement <program_options>


Attribute Value Description
Determines which additional originals of the document will be accepted during
copy but not into copy of document according to a table of identifiers for the
Workstation Application for additional originals all of which are separated by
ignore_wsappl_list "ZIP"
semicolon.

"ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied.


Determines whether the version number of the copy should be set on the original
or on the initial value (as a rule "00").
use_initial_version "yes"
"yes" = Version number of the copy on which the initial value will be set.

The subelement <new_version> contains settings for versioning of documents .

CIDEON Software & Services GmbH & Co. KG Page 103 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attribute to the subelement <new_version> from subelement <program_options>
Attribute Value Description
Determines the type of document status that allows versioning of documents. A
list of document statuses can be given separateed by ";".
status_list "AC;RE"
"AC;RE" = With this type of document status new versions are allowed.
Determines which additional originals of the document will not be accepted into
a new version of document during versioning, according to a list of identifiers for
ignore_wsappl_list "ZIP" the Workstation Application which are separated by semicolons.

"ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied.

The subelement <document_create> contains settings that control the way in which the document is created
in SAP.

Attributes to the subelement <document_create>


Attribute Value Description
Determines if SAP GUI should be opened
when creating a document.
create_with_SAP_GUI "no"
"no" = Do not open SAP GUI.
Determines whether mass creation of
documents of this type is allowed.
create_multi_allowed "no"
"no" = Mass creation of this document is
not permitted.
Determines the document number
assignment in SAP.
document_number_assignment "internal"
"internal" = SAP assigns the number
automatically.
The value of this field has no value when
the number is internally assigned. This
value is entered as a prefix in the input
field of the document system dialogue
when the number is externally assigned.
initial_document_number "" The user can delete/change the prefix at
any time.

"" = Empty, since there is no value,


because document_number_assignment
= "internal".
SAP document type for the newly created
document.
document_type "CPA"
"CPA" = CAD parameter document.
Shows or hides the classification panel in
the document creation dialog.
show_classification_pane "yes"
"yes" = Show classification panel in the
document creation dialog.

CIDEON Software & Services GmbH & Co. KG Page 104 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SAP document part or a semicolon-
separated list of SAP document parts for
the newly created document. If a list of
document parts has been specified, then
a documentation system dialog for one of
initial_document_part "000" the document parts can be selected from
a dropdown box in the SAP Engineering
Control Center.

"000" = Initial values for the document


part.
Defines whether the documentation
system dialog for the default value or the
selected SAP document part from the
"initial_document_part" attribute can be
part_editable "yes" changed in the input field from within the
SAP Engineering Control Center.

"yes" = The default value can be


changed.
SAP document version or a semicolon-
separated list of SAP document versions
for the newly created document. If a list of
document versions has been specified,
then a documentation system dialog for
initial_document_version "00"
one of the document versions can be
selected from a dropdown box in the SAP
Engineering Control Center.

"00" = Initial document version.


Determines whether the documentation
system dialog for the default value for the
document version can be changed from
the "initial_document_version" attribute
version_editable "no" within the SAP Engineering Control
Center.

"no" = The default value cannot be


changed.
Returns the initial status for the newly
created document.
change_to_after_create_status ""
"" = No initial status given.
Determines the composition of the file
name for the original document. The
following place holders are possible:
$(DOCNUMBER) = document number,
filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" $(DOCTYPE) = document type, and
$(DOCPART) = document.

"$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
= rules for the naming of the data files.
Determines the composition of the
document version in the file name for the
original of this document. The following
placeholder can be used: $(DOCVERSION)
filename_template_version ""
= Document version.

"" = The document version will not be


used.

CIDEON Software & Services GmbH & Co. KG Page 105 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The <seedfile> subelement contains settings for the template file. Several template files can be assigned, in
other words the <seedfile> may occur more than once. This includes the <description> subelement, which
defines each description text in different languages.

Attributes of the first subelement <seedfile> inherited from the subelement <document_create>
Attribute Value Description
When using type="template", this attribute defines the file
name of the template file that is used. The name can be
specified as relative or absolut. There must be a file with this
filename "@PLM_INSTDIR@\applications\INV\templates\inv-parameter.xls" name, or the process will terminate with an error.

"@PLM_INSTDIR@\applications\INV\templates\inv-parameter.xls"
= Relative filename to the template file used.
Determines how the original document will be generated.
type "template"
"template" = The "filename" attribute is used to specify the
template file that is to be used.
This determines whether this template file should be used as a
preset in the "Create Document" dialog.
default "yes"
"yes" = The template file is preset.

Attributes of the second <seedfile> subelement inherited from the <document_create> subelement
Attribute Value Description
When using type="template", this attribute defines the file name of the
template file that is used. The name can be specified as relative or
absolut. There must be a file with this name, or the process will
filename "@PLM_INSTDIR@\applications\INV\templates\inv-parameter-prefilled.xls" terminate with an error.

"@PLM_INSTDIR@\applications\INV\templates\inv-parameter-prifilled.xls"
= Relative filename to the template file used.
Determines how the original document will be generated.
type "template"
"template" = The "filename" attribute is used to specify the template
file that is to be used.
This determines whether this template file should be used as a preset in
the "Create Document" dialog.
default "yes"
"yes" = The template file is preset.

Attributes of the third <seedfile> subelement inherited from the <document_create> subelement
Attribute Value Description
When using type="template", this attribute defines the file name
of the template file that is used. The name can be specified as
relative or absolut. There must be a file with this name, or the
filename ""
process will terminate with an error.

"" = No data file name specified.


Determines how the original document will be generated.
type "select"
"select" = You can select a template file in the "Create
document" dialog.
This determines whether this template file should be used as a
preset in the "Create Document" dialog.
default "no"
"no" = No template file is preset.
When selecting a template file with the type="select", this
attribute determines the file extension filter that is used. In the
file selection dialog you can select files that are matched by the
extension_filter "*.xls,*.xlsx,*.xlsm,*.xlsb"
filter.

"*.xls,*.xlsx,*.xlsm,*.xlsb" = List of file extensions.

CIDEON Software & Services GmbH & Co. KG Page 106 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The subelement <material_create> contains settings for creating a new document from materials.

Attributes of the subelement <material_create>


Attribute Value Description
Determines whether and how a new document is created from
Materials.
material_creation_method "deferred"
"deferred" = No material is applied to the document. You can
attach Materials subsequently to this document.
Defines material number assignment in the SAP system. The
values are identical to those for the document number
material_number_assignment "internal" assignment.

"internal" = The SAP system assigns the number automatically.


Material type or a ';'-separated list of material types for the new
material that is to be created.
material_type "FERT;HALB"
"FERT;HALB" = List of SAP material types.
Template material with which the material attachments can be
processed.
material_template ""
"" = No material template specified.
Initial value for the assigned plant.
material_plant_assignment ""
"" = No initial plant.
Indicates the standard class for the material.
material_default_class ""
"" = No standard class for the material.

The subelement <primary_application> determines which application is assigned to this master document
(primary application) and defines the rules for the check in and check out of originals.

Attribute of the subelement <primary_application>


Attribute Value Description
"XLS" = Identification of the SAP workstation application for the
primary_workstation_application "XLS"
original.
Defines which attributes from the attribute mapping files are
synchronized during document creation.
attribute_section
"XLS" = Name of the section.
Defines the attribute update with the action "Open as read-only".
update_attributes_for_ro "yes"
"yes" = Perform attribute update.
Defines the attribute update for the action "Open for editing".
update_attributes_for_rw "yes"
"yes" = Perform attribute update.
Defines whether to update the attributes when the dirty flag is set.
update_attributes_for_dirty "yes"
"yes" = Perform attribute update.

The <container_file> subelement defines the characteristics of the ZIP archive which is stored in the document
as a container file. It contains the <plmfile> subelement, which defines the properties for the container file.

CIDEON Software & Services GmbH & Co. KG Page 107 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the subelement <plmfile> inherited from the subelement <container_file> from <primary_application>
Attribute Value Description
Filters by file name extensions in the file system.
extension "ecf"
"ecf" = File name extension.
Filters original documents according to the workstation
application.
workstation_application "ECF"
"ECF" = Identification of the workstation application.
Filters original documents according to their description.
"ECtr container
description
file" "ECtr container file" = Description of originals that will be used
for filtering.

The subelement <checkout_rules> determines how to treat the original of the document at checkout. It
includes the subelement <plmfile> that determines the individual additional file types.

Attribute of the <checkout_rules> subelement from the <primary_application> subelement


Parameter Values Description
Defines if the original is renamed during opening according to
rules for component names.
rename_master_original_at_checkout "no"
"no" = Keep file name during opening.
Determines if this document must have only one version in
the session directory.
one_version_in_session_only "no"
"no" = Multiple versions of the document are allowed in the
session directory.
Determines if hard link may be used for original document in
the session directory or if a copy must always be created.
hardlink_in_session "no"
"no" = Always create a copy.

The subelement <checkout_direct> defines which of the originals filed directly with the document will be
transferred to the additional registery during the action "open for editing".

Attributes of the subelement <plmfile> inherited from the subelement <checkout_direct> from subelelement
<primary_application>
Parameter Values Description
Identification of workstation application for the file type that is to be
transferred to the additional directory.
workstation_application "TXT"
"TXT" = Identification of the workstation application.

The subelement <checkin_rules> determines how files in the additional directory and document originals are
treated when checking in. This is why it has multiple subelements.

Attribute of the subelement <checkin_rules> from <primary_application>


Attribute Value Description
"yes" = Prevents a document from being checked in without CAD in the
from_application_only "yes"
desktop view of the ECTR via the context menu.

CIDEON Software & Services GmbH & Co. KG Page 108 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The subelement <save_direct> determines which additional files (paragraph styles) are stored as originals in
the additional directory when saving. It includes multiple <plmfile> subelements that determine the individual
additional file types.

Attributes of the subelement <plmfile> inherited from the subelement <save_direct> from <checkin_rules>
Attribute Value Description
The respective file name extensions of additional files in
the file system.
extension "jpg", "gif"
"jpg", "gif" = The respective file name extensions.
Workstation application identifiers for each additional style.
workstation_application "EPJ", "EPG"
"EPJ", "EPG" = Identification of the workstation application.
Description of the respective additional file.
"ECtr Preview (jpeg)",
description
"ECtr Preview (gif)" "ECtr Preview (jpeg)", "ECtr Preview (gif)" = Description of
additional files.

The <ignore> subelement determines which files will be ignored when saving. It includes multiple <plmfile>
subelements that determine the additional file types to ignore.

Attributes of the <plmfile> subelement inherited from the <ignore> subelement from <save_direct> subelement from
<checkin_rules>
Parameter Values Description
The respective file name extensions of the additional files to ignore in the file
system.
extension "bak", "tmp"
"bak", "tmp" = File name extensions of the additional file types.

The subelement <delete_in_sap> determines which original documents should be deleted during check in.
This allows for a targeted adjustment of the document. It includes multiple <plmfile> subelements that
determine the additional file types to delete.

Attributes of the <plmfile> subelement inherited from the <delete_in_sap> subelement from the <save_direct> subelement
from <checkin_rules>
Parameter Values Description
Workstation application identifiers for each additional style.
workstation_application "EPJ", "EPG", "CGM"
"EPJ", "EPG", "CGM" = Identification of the workstation
application.

The subelement <delete_in_session> determines which files should be deleted during check in. It includes
multiple <plmfile> subelements that determine the additional file types to delete.

Attributes of the <plmfile> subelement inherited from the <delete_in_session> subelement from the <save_direct>
subelement from <checkin_rules>
Parameter Values Description
Filters by file names and regular expressions.
".*\.preview\.jpg",
filename_pattern
".*\.preview\.gif"
".*\.preview\.jpg", ".*\.preview\.gif" = Filter mask.

CIDEON Software & Services GmbH & Co. KG Page 109 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The file name extensions of the files to be deleted in the
file system.
extension "cgm"
"cgm" = File name extensions of the additional file
types.

The <delete_in_session> subelement determines which files should be deleted during check in. It includes
multiple <plmfile> subelements that determine the additional file types to delete.

Attributes of the <plmfile> subelement inherited from the <delete_in_session> subelement from the <save_direct>
subelement from <checkin_rules>
Parameter Values Description
Filters by file names and regular expressions.
".*\.preview\.jpg",
filename_pattern
".*\.preview\.gif"
".*\.preview\.jpg", ".*\.preview\.gif" = Filter mask.
The file name extensions of the files to be deleted in the
file system.
extension "cgm"
"cgm" = File name extensions of the additional file
types.

The subelement <save_local> determines which additional files (additional styles) are stored in the local
directory when saving. It includes the subelement <plmfile> that determines the individual additional file
types.

Attributes of the subelement <plmfile> inherited from the subelement <save_local> from <checkin_rules>
Attribute Value Description
The file name extension of additional files which should be saved locally.
extension "avi"
"avi" = File name extension.

The subelement <scripts> contains scripts or programs that run before checking in. The individual
scripts/programs are contained in subelement <script>.

Attributes of the subelement <script> inherited from the subelement <scripts> from <checkin_rules>
Parameter Values Description
Sets the entire call path of the executing program.
Name "thumb_console64.exe"
"thumb_console64.exe" = Name of the program to be executed.

<script> contains the subelement <params> which determines the parameters to be sent to the executing
script. This includes one or more subelements <param>, which each define a parameter.

Attributes of the subelements <params>, subelement <params>, subelement <script>, subelement <scripts> from
<checkin_rules>
Parameter Values Description
"-pathFile",
Contains the name of the defined parameter.
"-pathThumb",
Name
"-width",
"-pathFile", "-pathThumb", "-width", "-height" = The parameter name.
"-height"

CIDEON Software & Services GmbH & Co. KG Page 110 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
A value can be specified for each parameter, which is passed in this
way to the executed program / script. These may include variable data
"$(masterfile)",
in the form of placeholders ("$ (...)"), which are resolved before
"$(add_dir)\zmodel.jpg",
value execution.
"300",
"300"
"$(masterfile)", "$(add_dir)\zmodel.jpg", "300", "300" = Place holder
for the value to be passed.

The subelement <additional_files> determines which additional formats of a document will be displayed and
can be edited in the SAP Engineering Control Center.

Attribute of the subelement <additional_files>


Parameter Values Description
Determines whether the additional originals are permissable for this
document.
enable_additional_files "yes"
"yes" = additional originals are permissible.

The subelement <ignore_files> determines which additional originals of the document in the originals
container of a document can NOT be displayed in SAP Engineering Control Center. These includes subitems of
type <plmfile> which define the individual document types.

Attributes of the subelements <plmfile> of the subelement <ignore_files> from <additional_files>


Parameter Values Description
The identifiers of the types of documents that should not be displayed.
"EPJ",
workstation_application
"EPG"
"EPJ", "EPG" = Identification of the document types.

The DType definitions for nonmaster documents

The SAP Engineering Control Center distinguishes between master documents and dependent documents. The
latter are referred to as non-master documents and are dependent on master documents.

NOTE:
It is recommended to maintain only the language English directly in the file "dtype.xml"! All other
languages will be offered via the particular "dictionary.txt" file. This affects the definitions of
DTypes and Seedfiles. All elements <description language="XY"> are omitted except English
which are used as fallback.

First the DType-definition for presentations:

DType-definition for non-master-documents of type "IPNNM"

<DType type="nonmaster" identifier="IPNNM" include_template="IPNTL" application_type="INV"


application_role="D">
...
</DType>

Attribute of the element <DType> of the DType definition "IPNNM" template definition
Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 111 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines the kind of DType definition.
type "nonmaster"
"nonmaster" = It relates to the definition for non-master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one and five characters long.
identifier "IPNNM"
"IPN" = ID of this DType definition.
Determines which template definition should be integrated into this
definition.
include_template "IPNTL"
"IPTML" = The DType template with the ID "IPTML" from this "dtype.xml" file
is included.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control
application_type "INV" Center.

"INV" = This is the Workstation Application for Inventor (WSAppl).


Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

The <nonmaster_options> subelement specifies whether a dependent document is linked to the material of
the master document.

Attributes of the subelement <nonmaster_options>


Attribute Value Description
Determines whether the content of the dependent document depends on
the content of the master document
depends_on_master "yes"
"yes" = Nonmaster document depends on the master document.
Determines whether the dependent document receives an object link to the
material of the master document.
link_to_master_material "no"
"no" = Do not create an object link from the material of the master
document to this dependent document.

The sub-element <document_create> contains settings that control the way in which the document is created
in SAP.

Attributes to the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "IPN"
"IPN" = Inventor Presentation document.
Determines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = The number is assigned internally.

The <material_create> subelement contains settings for creating a material for a new document.

Attributes of the subelement <material_create>


Attribute Value Description

CIDEON Software & Services GmbH & Co. KG Page 112 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Decides whether and how a material is created for a new
document.
material_creation_method "deferred"
"deferred" = No material is created for the document. However,
a subsequent material creation is possible.
Defines the material number assignment in the SAP system (the
values are identical to those of the document number
material_number_assignment "master" assignment).

"master" = Material number is taken from the master.


Type or types of material as defined in the SAP system.
material_type "FERT;HALB"
"FERT;HALB" = List of material types.
Template material with which the material can be created.
material_template ""
"" = No template material specified.
Initial value for the assigned plant.
material_plant_assignment ""
"" = No initial plant assigned.
Defines a default class for the material, as defined in the SAP
system
material_default_class ""
"" = No standard class defined.

Now the DType definition for Nonmaster Drawings ("INM")

DType-definition for non-master-documents of type "IDWNM"

<DType type="nonmaster" identifier="IDWNM" include_template="IDWTL" application_type="INV"


application_role="D">
...
</DType>

Attribute of elements <DType> of DType definition "IDW"


Attribute Value Description
Determines the kind of DType definition.
type "nonmaster"
"nonmaster" = It relates to the definition for non-master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one to five characters long.
identifier "IDWNM"
"IDW" = ID of this DType definition.
Determines which template definition should be integrated into this
definition.
include_template "IDWTL"
"IPWTL" = The DType template with the ID "IPWTL" from this "dtype.xml" file
is included.
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control
application_type "INV" Center.

"INV" = This is the Workstation Application for Inventor (WSAppl).

CIDEON Software & Services GmbH & Co. KG Page 113 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "1"
"1" = Far left, "6" = Far right.
Identification of a symbol group. Other symbols
can be displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the
symbol to be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_drawing$(NM_OLD)"
"{0}/tree/inv/inventor_drawing$(NM_OLD)" = The
icon file.

The <nonmaster_options> subelement specifies whether a dependent document is linked to the material of
the master document.

Attributes of the subelement <nonmaster_options>


Attribute Value Description
Determines whether the content of the dependent document depends on
the content of the master document.
depends_on_master "yes"
"yes" = Nonmaster document depends on the master document
Determines whether the dependent document receives an object link to the
material of the master document.
link_to_master_material "no"
"no" = Do not create an object link from the material of the master
document to this dependent document

The sub-element <document_create> contains settings that control the way in which the document is created
in SAP.

Attributes to the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "INM"
"INM" = Inventor Presentation document.
Determines the document number assignment in SAP.
document_number_assignment "master"
"master" = The number will be taken up by master document.

The <material_create> subelement contains settings for creating a material for a new document.

CIDEON Software & Services GmbH & Co. KG Page 114 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the subelement <material_create>
Attribute Value Description
Decides whether and how a material is created for a new
document.
material_creation_method "deferred"
"deferred" = No material is created for the document. However,
a subsequent material creation is possible.
Defines the material number assignment in the SAP system (the
values are identical to those of the document number
material_number_assignment "master"
assignment)
"master" = Material number is taken over from the master.
Type or types of material as defined in the SAP system.
material_type "FERT;HALB"
"FERT;HALB" = List of material types.
Template material with which the material can be created.
material_template ""
"" = No template material specified.
Initial value for the assigned work.
material_plant_assignment ""
"" = No initial work assigned.
Defines a default class for the material, as defined in the SAP
system
material_default_class ""
"" = No standard class defined.

Finally, the DType definition for Nonmaster drawings ("DWG") follows:

DType-definition for non-master-documents of type "IDWGN"

<DType type="nonmaster" identifier="IDWGN" include_template="IDWGT" application_type="INV"


application_role="D">
...
</DType>

Attribute of elements <DType> of DType definition "IDWNM"


Attribute Value Description
Determines the kind of DType definition.
type "nonmaster"
"nonmaster" = It relates to the definition for non-master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one to five characters long.
identifier "IDWGN"
"IDWGN" = ID of this DType definition.
Determines which template definition should be integrated into this
definition.
include_template "IDWGT"
"IDWGT" = The DType template with the ID "IDWGT" from this "dtype.xml"
file is included.

CIDEON Software & Services GmbH & Co. KG Page 115 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Designates the application that is relevant for this document (Workstation
Application). This application opens the file from SAP Engineering Control
application_type "INV" Center.

"INV" = This is the Workstation Application for Inventor (WSAppl).


Here, you can adjust the object type in the RES4 field of the SAP table DRAW.
application_role "D"
"D" = ID of the object type for Drawings.

The <icon> subelement defines an abbreviation that is used to determine the symbol to be used in SAP
Engineering Control Center. It contains the subelement <icondef>.

Attributes of subelement <icondef> of subelement <icon>


Attribute Value Description
Position of the symbol in the document entry in
the tree.
icon_position "1"
"1" = Far left, "6" = Far right.
Identification of a symbol group. Other symbols
can be displayed depending on their status.
icon_group "default"
"default" = This is the default icon.
Path for determining the icon file containing the
symbol to be used for this symbol position.
icon_identifier "{0}/tree/inv/inventor_drawing$(NM_OLD)"
"{0}/tree/inv/inventor_drawing$(NM_OLD)" = The
icon file.

The <nonmaster_options> subelement specifies whether a dependent document is linked to the material of
the master document.

Attributes of the subelement <nonmaster_options>


Attribute Value Description
Determines whether the content of the dependent document depends on
the content of the master document.
depends_on_master "yes"
"yes" = Nonmaster document depends on the master document.
Determines whether the dependent document receives an object link to the
material of the master document.
link_to_master_material "no"
"no" = Do not create an object link from the material of the master
document to this dependent document

The sub-element <document_create> contains settings that control the way in which the document is created
in SAP.

Attributes to the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "INM"
"INM" = Inventor Nonmaster Drawing document.

CIDEON Software & Services GmbH & Co. KG Page 116 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines the document number assignment in SAP.
document_number_assignment "master"
"master" = The number will be taken up by master document.

The <material_create> subelement contains settings for creating a material for a new document.

Attributes of the subelement <material_create>


Attribute Value Description
Decides whether and how a material is created for a new
document.
material_creation_method "deferred"
"deferred" = No material is created for the document. However,
a subsequent material creation is possible.
Defines the material number assignment in the SAP system (the
values are identical to those of the document number
material_number_assignment "master"
assignment)
"master" = Material number is taken over from the master.
Type or types of material as defined in the SAP system.
material_type "FERT;HALB"
"FERT;HALB" = List of material types.
Template material with which the material can be created.
material_template ""
"" = No template material specified.
Initial value for the assigned work.
material_plant_assignment ""
"" = No initial work assigned.
Defines a default class for the material, as defined in the SAP
system
material_default_class ""
"" = No standard class defined.

options.xml
Any user can individually apply settings which control the behavior of the SAP Engineering Control Center. This
can be done in the "Preferences" dialog, which can be opened in the system bar via the menu "Settings ->
Preferences" of the SAP Engineering Control Center.

ECTR menu "Settings"

There you will find setting options referring to interaction between SAP Engineering Control Center and den
SAP Engineering Control Center Interfaces for individual CAD systems. For each installed interface, a node is

CIDEON Software & Services GmbH & Co. KG Page 117 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
present in the tree on the left side:

ECTR dialog "Preferences"

The CAD-specific data file "options.xml" determines the options that are given for the particular CAD system.
We are talking about parameters, which a part of the CAD-specific data file "default.txt" and which are pre-
allocated with a standard value.

Settings made under "Settings -> Preferences" in the menu will be saved in the file "user.txt" for every user in
their specific ECTR work directory, under the sub-menu "preferences" (the exact path:
"%APPDATA%\SAP\ECTR\data\<<ECTR-Version>>\<<SAP-
Server_Mandant_Username>>\preferences\user.txt").

ATTENTION:
The settings made via the menu "Settings -> Preferences" and stored in the file "user.txt" for
each user in his ECTR working directory override the standard settings from the configuration file
"default.txt"! If the default values from the "default.txt" are to be used again, the options must be
deleted from the user-specific file "user.txt" after exiting ECTR!

The file "options.xml" has the following structure:

CIDEON Software & Services GmbH & Co. KG Page 118 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Structure of the file "options.xml"

<options>
<structure>
<node label="...">
<node card="<<Card X>>"/>
<node card="<<Card Y>>"/>
...
</node>
</structure>
<card name="<<Card X>>">
<option label="..." type="..." prefname="..." tooltip="..."/>
<option label="..." type="..." prefname="..." tooltip="...">
<entry name="..." value="..."/>
<entry name="..." value="..."/>
<entry name="..." value="..."/>
</option>
...
</card>
<card name="<<Card Y>>">
<option label="..." type="..." prefname="..." tooltip="..." maxchars="...">
<entry name="..." value="..."/>
<entry name="..." value="..."/>
</option>
<option label="..." type="..." prefname="..." tooltip="..." maxchars="..."/>
...
</card>
...
</options>

The elements <structure> define the entry on the left side of the options dialogue within the tree diagram.
This must contain a sub-element <node> which describes specifically the node.

Attributes of element <node>


Attribute Value Description
(Optional) If the attribute exists, a folder icon with the given name will appear.
label="..." Name
Below you will find the cards arranged under a branch, defined as in the following.
Defines an entry in the tree diagram, which contains changeable parameters
Card
card="..." (preferences), and which will appear on the right when clicked. The adjustable
identifier
parameter will be defined in the corresponding element <card>.

CIDEON Software & Services GmbH & Co. KG Page 119 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
All elements <node> should have a label! It is recommended that you do not write the text for
the label in plain text into this XML file, but instead reference a corresponding dictionary identifier.
Then, depending on the language set in the ECTR, the appropriate text is always read from the
respective file "dictionary.txt".
Example options.xml:

<node label="Inventor">
<node card="Miscellaneous" label="plm.options.card.misc"/>
<node card="Application structure"
label="plm.options.card.application.structure"/>
.
.
.
</node>

Dictionary identifiers can and should also be used for the following attributes:
<option label="...">, <option tooltip="..."> and <entry name="...">
Example dictionary.txt:

# Preference keys from options.xml


plm.options.card.misc=Verschiedenes
plm.options.card.application.structure=Applikationsstruktur
.
.
.

With the element <card> you define the options that can be reached under the respective card note. The
assignment is done via name of card.

Attribute of element <card>


Attribute Value Description
name="..." Name Name of Card, like in the element <node>

The sub-element <option> always defines one option that appears on the card. Here you allocate a parameter
(preference) from the CAD-specific file "default.txt" as well as the possible value area. In doing so, an empty
editing field will appear or a list of values will apply.

Attributes of sub-element <option>


Attribute Value Description
Name or description of Description of the option as appears on the card under
label="..."
the option "Description"
file type of the option. The following are possible:
type="..." Data type
"string", "boolean", "long"
prefname="..." Parameter name The complete name of the preference from file "default.txt"
(Optional) Description of the option. Appears as tooltip, when
tooltip="..." Description of the option
mouse cursor is positioned on the option
(Optional) Maximum possible number of signs or characters
maxchars="..." Number
within an editing field

If you want to present a list of possible values, you have to enter the sub-element <entry> which might occur
repeatedly.

CIDEON Software & Services GmbH & Co. KG Page 120 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of sub-element <entry>
Attribute Value Description
name="..." Name Name of value in the list
Value according to attribute "type" from element
value="..." Value, which is given to parameter at choice
<option>

If you place the attribute "maxchars" within the element <option> and at the same time you put values over
<entry>, an edit field appears. But for entries, which are identical to the values that are connected to the
attribute "name", the values set in the attribute "value" will be given to the parameter.

ATTENTION:
When adding new settings to this file, note the following: Some preferences are cached by the
interface, so that an update of the value is not guaranteed during operation! However, all settings
in the standard delivery of the file "options.xml" can be changed during operation.

plm_setenv.bat
The file "plm_setenv.bat" serves to set environment variables. These can then be evaluated from the SAP
Engineering Control Center Interface to Inventor after launch. As this deals with a traditional batch file,
command line instructions such as "set" and "if" can also be used here, as well as contents of already existing
environment variables, with the notation "%<<Variable name>>%".

On default, the "plm_setenv.bat" file contains the default values of the environment variables supported by the
interface.
Possible environment variables are:

Available environment variables


Environment variable Possible values Description
'0' = Detailed dialog. Defines whether a simple loading dialog for ECTR and CAD processes ('1' - '5')
USE_SIMPLE_DIALOG '1' - '5' = Simple dialog with should be displayed in the user interface instead of detailed status messages
different loading icons. ('0').

"true" = Write document Enables writing a complete dump of the current document structure to the log
structure to log. file ("true").
PLM_LOG_INTERFACE_DUMP_DOC_STRUCTURE
"false" = Do not write document ATTENTION:
structure to log. This can affect the performance of large assemblies!

ATTENTION:
The file "plm_setenv.bat" is only executed if the CAD system is started from ECTR, i.e. either via
the menu "System->Launch Application->Start Inventor" or by opening a document in the
Application Structure etc. If Inventor is started without ECTR or the connection to ECTR is
established later, setting environment variables via the file "plm_setenv.bat" does not work!

rfc-tunnel-whitelist.txt
The configuration file "rfc-tunnel-whitelist.txt" contains a list of all RFC function modules that can be called by
the SAP Engineering Control Center Interface to Inventor via the ECTR. Calling RFC function modules that are
not contained in this list is rejected with an error. With this white list, the SAP Engineering Control Center
Interface to Inventor follows the security concept of the ECTR and enables you to ensure that only permitted
RFC function modules can be executed.

The standard configuration includes the following RFC functions that are allowed to be executed:

CIDEON Software & Services GmbH & Co. KG Page 121 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
/DSCSAG/MM_GETNONMASTER2
CDESK_SRV_MODIFY_INST_DATA

The wildcard character '*' is allowed when specifying the RFC function. This makes it possible to
specify entire groups of RFC functions that have the same prefix in their names, for example.

Loading rules for opening documents (load_scenarios.xml)


Since ECTR version 5.1.11.0 it is possible to combine different "explosion scenarios" with different loading
options for documents in CAD applications. The prerequisite for this is that a corresponding explosion scenario
exists in SAP.

Detailed information on this topic can be found in the article "How to configure different load
scenarios" in the SAP Community Wiki.

It is therefore possible to define different rules for loading different document types for the SAP Engineering
Control Center Interface to Inventor. The optional configuration file "load_scenarios.xml" must be created in
the directory "..\customize\config". In this file, corresponding loading rules are described as in the following
example:

CIDEON Software & Services GmbH & Co. KG Page 122 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Example for the file "load_scenarios.xml"

<?xml version="1.0" encoding="utf-8"?>


<document_load_scenarios xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="../../../../basis/aux-files/load-
scenarios.xsd">
<document_load_scenario>
<name>EXAMPLE_LOAD_SCENARIO</name>
<description>Example LoadScenario</description>
<application_type>INV</application_type>
<bod_explosion>
<explosion_scenario>CAD_LOAD</explosion_scenario>
<explosion_rule>
<active/>
</explosion_rule>
</bod_explosion>
<application>
<option>
<name>DesignViewRepresentation</name>
<value>0</value>
</option>
<option>
<name>PositionalRepresentation</name>
<value></value>
</option>
<option>
<name>LevelOfDetailRepresentation</name>
<value>1</value>
</option>
<option>
<name>DeferUpdates</name>
<value>false</value>
</option>
<option>
<name>ImportNonInventorDWG</name>
<value>true</value>
</option>
<option>
<name>OpenExpress</name>
<value>false</value>
</option>
<option>
<name>SkipAllUnresolvedFiles</name>
<value>false</value>
</option>
<option>
<name>DeferFlatPatternUpdate</name>
<value>true</value>
</option>
</application>
</document_load_scenario>
</document_load_scenarios>

The element <document_load_scenario> describes the load rule.

Attributes of element <document_load_scenario>


Attributes Value (example) Description

CIDEON Software & Services GmbH & Co. KG Page 123 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Name of the load scenario defined here.

"EXAMPLE_LOAD_SCENARIO" = Name.

name "EXAMPLE_LOAD_SCENARIO" HINT:


The name can be used to store this load rule via the
configuration file "menu_macros.txt" as a command in the
context menu in the "Desktop" view of the ECTR (see "How to
configure different load scenarios").
description "Example Load Scenario" Description of this load scenario.
Identifier for the application that is responsible for this
document. This application opens the file from the SAP
application_type "INV" Engineering Control Center.

"INV" = For Inventor.

The sub-element <bod_explosion> describes the corresponding explosion scenario, which must be defined in
SAP.

Attribute of element <document_load_scenario>


Attribute Value (example) Description
Name of the corresponding explosion scenario.

"CAD_LOAD" = Name.
explosion_scenario "CAD_LOAD"
ATTENTION:
An explosion scenario with the name specified here must exist in SAP! For more information on explosion
scenarios, see "How to configure different load scenarios").

The sub-element <application> contains several sub-elements <option>, which describe the individual
aspects of the loading rule.

Attributes of the 1. element <option>


Attributes Value (example) Description
Defines the design view representation for the document to be
name "DesignViewRepresentation"
loaded.
The following values can be set:

'0' = Last Active


'1' = Master
value '0'
'2' = All Visible
'3' = Nothing Visible
'4' = Default
n = n own design views

Attributes of the 2. element <option>


Attributes Value (example) Description
Defines the name of the positional representation for the document
name "PositionalRepresentation"
to be loaded.
value "" The name as text. Can also be empty!

Attributes of the 3. element <option>


Attributes Value (example) Description
name "LevelOfDetailRepresentation" Specifies the level of detail for the document to be loaded.

CIDEON Software & Services GmbH & Co. KG Page 124 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The following values can be set:

'1' = Master
value '0' '2' = All Parts Suppressed
'3' = All Components Suppressed
'4' = All Content Center Suppressed
n = n own Level Of Details

Attributes of the 4. element <option>


Attributes Value (example) Description
name "DeferUpdates" Specifies whether to defer updates.
"true" = Yes
value "false"
"false" = No

Attributes of the 5. element <option>


Attributes Value (example) Description
name "ImportNonInventorDWG" Specifies whether to import non Inventor DWGs.
"true" = Yes
value "true"
"false" = No

Attributes of the 6. element <option>


Attributes Value (example) Description
name "OpenExpress" Specifies whether to use Express Load.
"true" = Yes
value "false"
"false" = No

Attributes of the 7. element <option>


Attributes Value (example) Description
name "SkipAllUnresolvedFiles" Determines whether all unresolved references should be skipped.
"true" = Yes
value "false"
"false" = No

Attributes of the 8. element <option>


Attributes Value (example) Description
name "DeferFlatPatternUpdate" Specifies whether to defer the FlatPattern update.
"true" = Yes
value "true"
"false" = No

Version information
To gain an overview of the imported changes of the relevant releases of the SAP Engineering Control Center
Interface to Inventor, the changes are listed here in the configuration files "default.txt" and "dtype.xml".

The following table contains changes in parameters in the configuration file "default.txt". The status shows
whether the relevant parameter in this version was added ( ), changed ( ) or deleted ( ). When changing a
parameter, merely a new parameter name is given.

Changes in configuration file "default.txt"

CIDEON Software & Services GmbH & Co. KG Page 125 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
plm.cad_variant.fgroup.forDocType.IAM
plm.cad_variant.fgroup.forDocType.IPT
plm.cad_variant.fgroup.forVariantType.<VariantType>
plm.om.CADVAR.containers.fgroup.INV_CADVAR_IAM
plm.om.CADVAR.containers.fgroup.INV_CADVAR_IPT
plm.options.loadDrawings.MultiRefAllowed.INV
plm.om.DOC.containers.IPT
02.34.184.00 plm.om.DOC.containers.IAM
plm.options.SaveAsNewDocument.Replace.INV
plm.options.OnDirty.Checkout.DialogDefaultValue.Action.INV
plm.options.OnDirty.Checkout.DialogDefaultValue.ObjectList.INV
plm.options.OnDirty.Checkout.DialogDefaultValue.ApplyAll.INV
plm.options.save.ReadTrafomatrix.INV
plm.options.MaintainGeneric.SendAllGenericMembers.INV
plm.options.OnDirty.CheckedIn.allowed.INV
plm.options.variantType.INV
plm.options.MacroName.MapAttributesMacroName.INV
plm.options.bom.UsePrefixAsCategory.INV
02.33.178.00 plm.options.bom.UseAutoBomItemGroup.INV
plm.control.applType.WsAppl.INV
plm.docstructure.instdata.attr.namepattern.INV
plm.options.Cancel.DialogDefaultValue.INV
com.cideon.file.handler.copy.<DTYPE>
com.cideon.file.handler.delete.<DTYPE>
02.33.170.00 plm.options.PresetsPath.INV
plm.options.DesignDataPath.INV
plm.options.ContentCenterPath.INV
plm.execute.additional.INV
02.32.169.00 plm.options.Save.UseDocumentPropertiesAsRequestedComponentAttributes.INV
plm.options.Thumbnail.INV.jpg.<preference>
plm.ignore.dtype.use.relative.path.flag
plm.options.Cancel.LoadedParts.INV
02.30.156.00
plm.options.Save.LoadedParts.INV
plm.options.ReplaceVersion.CheckoutParents.INV
plm.appl.popwin.name.INV
02.30.152.00
plm.control.popwin.name.INV
plm.options.variantType.INV
02.29.147.00 plm.options.OnDirty.CheckedIn.allowed.INV
plm.options.TransferCadQuantities.INV
02.29.136.00 plm.options.MacroName.GetRelatedPresentations.INV
plm.options.InventorProjectName.INV
plm.structure.application.displaysubstitutestructure.INV
plm.options.SaveAs.CheckInAfterCreate.INV
02.25.102.00 plm.structure.application.ExpandDocumentsOnlyOnce.INV
plm.options.Cancel.LoadedParts.INV
plm.options.Save.LoadedParts.INV
plm.options.CloseDocumentAfterSapSaveDisplay.INV
02.24.100.00 plm.structure.application.show.drawing.container.ontop.INV
plm.options.Thumbnail.INV.jpg.<preference>
plm.options.importOnDemand.TransferAttributesToSAP.INV
02.23.97.00
plm.options.StructureAnalysis.MinimumErrorLevel.INV
plm.options.structureAnalyze.showDialogForMissingReferences.INV

CIDEON Software & Services GmbH & Co. KG Page 126 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
02.21.91.00 plm.options.SaveAsNewDocument.Replace.INV
plm.structure.application.DisplaySuppressedComponents.INV
plm.structure.application.show.drawing.INV
plm.structure.application.loadDrawings.INV
plm.structure.application.show.drawing.container.INV
structure.view.INV.generic.object.DRAW_CONTAINER.name
02.21.90.00
structure.view.INV.generic.object.DRAW_CONTAINER.icon
plm.options.SaveAsNewDocument.CancelSourceFile.INV
plm.options.MacroName.MapAttributesMacroName.INV
plm.options.checkForUpdates.before.CheckoutEdit.MultiLevel.INV
plm.options.checkForUpdates.before.CheckoutEdit.ExplosionScenario.INV
02.20.88.00 plm.options.bom.InsertVirtualBOMHeader.INV
plm.options.Logging.LogPerformanceTrace.INV
plm.document.dtype.FactoryDesign.Asset.IPT.INV
plm.document.dtype.FactoryDesign.Asset.IAM.INV
02.19.85.00
plm.document.dtype.FactoryDesign.LayoutTemplate.INV
plm.options.bom.InsertVirtualBOMHeader.INV
plm.options.MacroName.GetRelatedDrawings.INV
plm.appl.startViewerCommand.INV
plm.options.UpdateAttributes.RefreshContext.INV
plm.options.DisableDirtyHandlingForWritingComponentIDs.INV
02.18.77.00
plm.options.CommandContext.UseActiveDocument.INV
plm.options.SaveAsNewDocument.SubstitutePartHandling.INV
plm.options.Ballooning.InitializeBalloonWith.INV
plm.options.TransferCadQuantities.INV
02.18.71.00
plm.options.bom.UseAutoBomItemGroup.INV
plm.options.bom.UsePrefixAsCategory.INV
02.18.70.00 plm.options.Thumbnail.INV.jpg.<preference>
plm.options.Thumbnail.ViewOrientation.INV
plm.options.TemplateFiles.INV
plm.options.TransferCadPosNr.INV
02.16.58.00 plm.options.ImportOnDemand.DeleteOriginals.INV
plm.options.ImportOnDemand.CheckInAfterCreate.INV
plm.control.partnameRules.applExtension.INV

CIDEON Software & Services GmbH & Co. KG Page 127 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
plm.bom.create.IDW
plm.bom.createAtCheckin.IDW
plm.bom.updateAtCheckin.IDW
plm.bom.update.IDW
plm.bom.create.IPN
plm.bom.createAtCheckin.IPN
plm.bom.updateAtCheckin.IPN
plm.bom.update.IPN
plm.bom.create.IAM
plm.bom.createAtCheckin.IAM
plm.bom.updateAtCheckin.IAM
plm.bom.create.IPT
02.15.57.00
plm.bom.createAtCheckin.IPT
plm.bom.update.IPT
plm.bom.create.INM
plm.bom.createAtCheckin.INM
plm.bom.updateAtCheckin.INM
plm.bom.update.INM
plm.options.bom.InsertVirtualBOMHeader.INV
plm.options.BOMTable.AddNonExistingColumns.INV
plm.options.checkIn.UpdateAttributesFromSAP.INV
plm.options.SaveAsNewDocument.Replace.INV
plm.options.OpenInsert.UseLastActiveLevelOfDetail.INV
plm.options.OpenInsert.ViewRepresentation.INV
plm.options.DeferUpdateOnCheckin.INV
plm.options.ContentCenterPrimaryLanguage.INV
plm.options.MissingReferenceReloadOption.INV
plm.options.SapSaveAsNewDocumentForCadSaveAs.INV
plm.options.SapSaveAsNewDocumentForCadSaveCopyAs.INV
plm.appl.startup.parameters.INV
plm.appl.startup.[paramX].INV
plm.execute.additional.INV
plm.options.OpenInsert.UseLastActiveLevelOfDetail.INV
plm.structure.application.DisplayExternalReferences.INV
plm.document.dtype.<library name><type>.INV
plm.appl.qat.INV
02.14.55.00
plm.appl.language.INV
plm.options.OverwriteDTypeUpdateAttributeSettings.INV
plm.options.BOMTable.Column.INV.Material
plm.options.BOMTable.Column.INV.Postext1
plm.options.BOMTable.Column.INV.Postext2
plm.options.BOMTable.Column.INV.OtherColumn
plm.options.command.SynchronizeDrawingAssemblyBOM.INV
plm.options.ChangeDtype.INV
plm.options.Ballooning.BalloonContent.INV
plm.options.Thumbnail.Size.INV
plm.options.ForceTemplateProject.INV
plm.convert.additional.INV.<CONVERT_TYPE>.filenameFormat
02.13.53.00 plm.options.SapSaveAsNewDocumentForCadSaveAs.INV
plm.options.CheckinOnCadClose.INV
plm.options.SapSaveIntermediateForCadSave.INV
plm.options.CloseDocumentAfterSapSaveDisplay.INV
02.11.47.00
plm.options.CreateDirDuringMakeDrawingOrAssemblyFromPartOrAssembly.INV
plm.document.PresentationAsNonMaster.INV
plm.options.MakeComponents.CreateDark.INV

CIDEON Software & Services GmbH & Co. KG Page 128 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
02.10.44.00 plm.options.MakeComponents.TargetAssemblyHandling.INV
02.10.42.00 plm.options.OpenInsert.ShowLoadOptionsDialog.INV
02.09.41.00 plm.document.dtype.Mold.INV
plm.options.new.SaveActiveDocument.INV
plm.document.addcomponent.allowed.dTypeList.INV
plm.options.MakeComponents.AttributesToCopy.INV
02.09.39.00
plm.convert.additional.INV.IPT
plm.convert.additional.INV.FlatPatternDXF.options
plm.convert.additional.INV.IPT.FlatPatternDXF.AcadVersion
plm.options.structureAnalyze.showDialogForMissingReferences.INV
plm.document.dtype.Weldment.INV
plm.options.open.UseMultiSearchForSapOpen.INV
02.08.37.00
plm.options.SapOpenForLoadDrawing.INV
plm.options.new.SaveActiveDocument.INV
plm.options.TemplateProject.INV
02.07.30.00 plm.options.importOnDemand.updateAttributes.INV
plm.options.SapOpenForCadPlaceDocument.INV
plm.document.dtype.SheetMetal.INV
plm.options.importOnDemand.resetOccurrenceName.INV
02.06.27.00
default.txt plm.options.EmbedExcelOnInsert.INV
plm.structure.application.init.strategy.levels.INV
plm.options.Thumbnail.ViewOrientation.INV
plm.options.updateAttributes.useInteropPrefix.INV
plm.options.importOnDemand.loadDrawings.INV
plm.options.save.loadDrawings.INV
plm.structure.application.DisplayPosItem.INV
plm.options.save.saveExternalReferences
plm.options.deliverOnlyRequestedAttributesToSAP.INV
plm.options.importOnDemand.TransferAttributesToSAP.INV
02.05.25.00
plm.structure.application.LoadDrawings.INV
plm.options.Open.CopyFeaFiles.INV
plm.options.SapOpenForCadOpenDocument.INV
plm.document.dtype.Default.IPT.INV
plm.document.dtype.Default.IAM.INV
plm.document.dtype.Default.DWG.INV
plm.document.dtype.Default.IPN.INV
plm.structure.application.sendInstancesForGeneric.INV
plm.structure.application.AdditionalAttributes.INV
02.04.24.00
plm.structure.application.DisplayAdditionalAttributes.INV
plm.structure.application.CollectEntries.INV (Name changed!)
plm.structure.node.CUAPOB_INV_MATERIAL.icon.1
plm.structure.node.CUAPOB_INV_MATERIAL.icon.2
plm.structure.node.CUAPOB_INV_MATERIAL_NEW.icon.1
plm.structure.node.CUAPOB_INV_MATERIAL_NEW.icon.2
02.03.22.00
plm.structure.node.CUAPOB_INV_VIRTUAL.icon.1
plm.structure.node.CUAPOB_INV_VIRTUAL.icon.2
plm.structure.node.CUAPOB_INV_VIRTUAL_NEW.icon.1
plm.structure.node.CUAPOB_INV_VIRTUAL_NEW.icon.2
plm.options.ApplicationStructure.CollectEntries.INV
02.01.20.00
plm.options.CreateDIRForNewDocument.INV

CIDEON Software & Services GmbH & Co. KG Page 129 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
plm.document.dtype.iPartFactory.INV
01.03.18.00
plm.document.dtype.iAssemblyFactory.INV
plm.options.openAllReferencesToReadInstanceIDs.INV
01.03.16.00 plm.document.SaveAsNewDocument.CheckOutTop.INV
plm.doc.cancel.restore.files.INV
01.00.14.00 plm.options.importOnDemand.updateAttributes.INV
01.00.03.00 plm.control.partnameRules.applExtension.INV

The following table contains changes in the configuration file "dtype.xml":

Changes in configuration file "dtype.xml"


Version Description
The template definitions for "INMDL", "INDRW", "IPTML" and "IAMLT" as well as the master
document definition "CPA" have got the attribute from_application_only="yes" in their
checkin_rules.

02.12.48.00 ATTENTION:
The attribute "from_application_only" can only be processed from ECTR version 5.1.10
onwards, an older ECTR version terminates with an error message!
If you are working with an older ECTR, you should use the file "dtype.5.1.9.xml" instead of the
current "dtype.xml", which is located in the directory "template_customize".
It is recommended to maintain only the language English directly in the file "dtype.xml"! All
other languages will be offered via the particular "dictionary.txt" file. This affects the definitions
02.09.39.00
of DTypes and Seedfiles. All elements <description language="XY"> are omitted except
English, which are used as fallback.

The following table contains changes in the batch file "plm_setenv.bat" for Inventor:

Changes in the batch file "plm_setenv.bat"


Version Description
On default, the "plm_setenv.bat" file contains the default values of the environment variables
02.24.100.00 supported by the interface:
set USE_SIMPLE_DIALOG=false
set PLM_LOG_INTERFACE_DUMP_DOC_STRUCTURE=false

CIDEON Software & Services GmbH & Co. KG Page 130 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Final Remark

This manual is intended to facilitate handling of the product. Since this product is also constantly being further
developed, only the release status at the time of going to press could be taken into account here. CIDEON
Software & Services GmbH & Co KG is grateful for information and suggestions provided by users. Please enter
a SAP ticket in the SAP Support Portal.

This documentation has been prepared with the greatest possible care, but we cannot accept any liability for
any defects or errors that may occur.

You can find the current documentation in the SAP Help Portal.

On our homepage you will find further information and news!

CIDEON Software & Services GmbH & Co. KG

www.cideon.com

Copyright (C) 2023 CIDEON Software & Services GmbH & Co. KG. All rights reserved.

No part of this document may be reproduced or copied in any form for any purpose without the express
permission of CIDEON Software & Services GmbH & Co KG.

CIDEON Software & Services GmbH & Co. KG Page 131 of 131 2023-08-04
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com

You might also like