Professional Documents
Culture Documents
SAP Engineering Control Center Interface to Solid Edge 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 Solid Edge 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.
Under "%PLM_INSTDIR%\applications\" the individual Add-ins are stored during their installation in separate
subdirectories.
"%PLM_INSTDIR%\applications\sle" is the installation directory of the SAP Engineering Control Center Interface
to Solid Edge. It contains the following subdirectories which are significant for configuration:
%PLM_INSTDIR%\applications\sle\appdata
%PLM_INSTDIR%\applications\sle\basis
%PLM_INSTDIR%\applications\sle\documentation
%PLM_INSTDIR%\applications\sle\templates
%PLM_INSTDIR%\applications\sle\template-templates
%PLM_INSTDIR%\applications\sle\customize\config
%PLM_INSTDIR%\applications\sle\template-customize\config
The SAP Engineering Control Center Interface to Solid Edge has a ribbon bar in CAD next to the main menu
that contains its functions as buttons. In the subdirectory icons contained here, all the symbols used for these
ribbon bar buttons can be found in two sizes: 16 x 16 and 32 x 32 pixels.
aux-files: Contains the file "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).
sys: In "sys\win\bin" the individual interface modules can be found. They are copied and registered
here during installation.
In this directory, the user manuals can be found in both German and English as PDF files.
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
Here, files can be found that are necessary for the configuration of the SAP Engineering Control Center
Interface to Solid Edge. These are:
default.txt
dtype.xml
options.xml
menu.guidef
menu_macros.txt
plm_setenv.bat
attributes-from-sap.xml
attributes-to-sap.xml
At the start of Solid Edge, 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 standard settings are filed as copies in the "template-customize\config" special directory, which contains
homonymous files to those in directory "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!
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.
The following table provides an overview of the standard symbols for Solid Edge:
Unfortunately, there is currently no possibility to realize this technically. Solid Edge is always started in the
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 %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 Solid Edge 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 Solid Edge in the user interface of the SAP Engineering Control Center.
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.
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_SLEMDL":
# Cloning
+ om.popup.menu.CLONEPOS.DOC_SLEMDL = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.NEWINTNR_OPTION
= fnc.doc.clone.option.NEWEXTNR_OPTION
= fnc.doc.clone.option.NEWVERS_OPTION
= fnc.doc.clone.option.CHANGE_OPTION
= -----------------------------
= fnc.doc.clone.select.dependent
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload
+ om.popup.menu.CLONEPOS.DOC_SLEDRW = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.NEWINTNR_OPTION
= fnc.doc.clone.option.NEWEXTNR_OPTION
= fnc.doc.clone.option.NEWVERS_OPTION
= fnc.doc.clone.option.CHANGE_OPTION
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload
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."
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_SLE" is required, so that the SAP Engineering Control Center can start the
Solid Edge application as needed.
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.
"%PLM_INSTDIR%\customize\config\attributes-from-sap.xml"
and
%PLM_INSTDIR%\customize\config\attributes-to-sap.xml".
The following Solid Edge-specific attribute mapping files exist for this purpose:
and
"%PLM_INSTDIR%\applications\sle\customize\config\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.
<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>
Within a section, attributes belonging to this attribute section are defined with the sub-element
<APPL_ATTRIBUTE>.
Within the attribute definition, the subelement <DIR> addresses document attributes, and the subelement
<MA> addresses material attributes.
It is also possible to modify and combine string values read from SAP.
<CUTLEADING character="0">
<DIR field="DOCUMENTNUMBER"/>
</CUTLEADING>
The subelement <XFORMAT> combines the values "DOCUMENTNUMBER" and "DOCUMENTTYPE" read out
from SAP fields into one string:
<XFORMAT outputFormat="{0}/{1}">
<DIR field="DOCUMENTNUMBER"/>
<DIR field="DOCUMENTVERSION"/>
</XFORMAT>
<XFORMAT outputFormat="{0}/{1}">
<CUTLEADING character="0">
<DIR field="DOCUMENTNUMBER"/>
</CUTLEADING>
<DIR field="DOCUMENTVERSION"/>
</XFORMAT>
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\sle\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.
<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.
Within a section, the subelement <DIR> and the subelement <MA> addresses fields of the document or
material, respectively, which can be changed in SAP.
Within a section, attributes belonging to this attribute section are defined with the sub-element
<APPL_ATTRIBUTE>.
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":
<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>
Information regarding further possibilities for attribute mapping and the file structure of
"attributes-to-sap.xml" can be found in the "Operations Guide_EN.pdf" in the SAP Engineering
Control Center, which can be found in folder "%PLM_INSTDIR%\documentation\Manuals\en".
General information
The Solid Edge properties provided by the SAP Engineering Control Center Interface to Solid Edge are
described below. The properties can be used in the files "attributes-to-sap.xml" and "attributes-from-sap.xml"
for the synchronization with SAP data.
Property categories
Summary Information
Document Summary Information Properties
Custom Properties (User Defined Properties)
Extended Summary Information Properties
Project Information
Physical Properties
Mechanical Modeling Properties
Drawing Properties
ATTENTION:
The names of the Summary Information Properties are executed in the respective national
language! Here they are listed for English and German.
User-defined properties can be used with or without the prefix "UDP-". The parameter
"plm.options.updateAttributes.useInteropPrefix.SLE" in the configuration file "default.txt" can be
used to determine whether the prefix "UDP-" should be added to the custom properties.
Examples:
UDP-<Propertyname> --> "UDP- SAPName"
<Propertyname> --> "SAPName"
ATTENTION:
The "Var-" properties for mass and volume listed here, like all other var properties, should not
be used, as they are often obsolete and not correctly updated by Solid Edge. You should always
use "PP-" properties for mass and volume instead! They are listed here for completeness only.
Solid Edge Physical Properties (VAR)
Name Example property value Note
Var-Mass 0.886000 Should not be used!
Var-MassUnit kg Should not be used!
Var-Volume 0.001000 Should not be used!
Var-VolumeUnit dm^3 Should not be used!
Example:
DP-SheetName A4-Sheet
In Solid Edge, units can be selected for specific documents. This is done in the "Solid Edge Options" dialog
under "Units".
To be able to supply physical units in the units specifically selected or user-defined for a document, there are
the "DocumentUnit" properties. These are also configuration-dependent and must be used in the form "PP-
<Propertyname>".
The DocumentUnit properties in the configuration file "attribute-to-sap.xml" are used as follows:
<MA field="MARA-NTGEW">
<APPL_ATTRIBUTE name="PP-MassInDocumentUnit" />
</MA>
<MA field="MARA-GEWEI">
<APPL_ATTRIBUTE name="PP-MassUnitInDocumentUnit" />
</MA>
<MA field="MARA-VOLUM">
<APPL_ATTRIBUTE name="PP-VolumeInDocumentUnit" />
</MA>
<MA field="MARA-VOLEH">
<APPL_ATTRIBUTE name="PP-VolumeUnitInDocumentUnit" />
</MA>
The following conversion factors and text values for the units apply:
default.txt
The file "default.txt" contains basic settings that influence the interaction between the SAP Engineering Control
Center, SAP Engineering Control Center to Solid Edge 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.
The following table contains the first part of the description of all parameters, which are contained in the file
plm.control.empty.dtype.SEA = SEA
Parameter:
plm.control.empty.dtype.SEP = SEP
plm.control.empty.dtype.SED = SED
plm.control.empty.dtype.SES = SES
plm.control.empty.dtype.SEW = SEW
Necessary for the parallel operation CDESK / ECTR. As the documents created with CDESK have no DType, a DType can be allocated to every type of
Description:
document here.
Values: DType identifier.
Default value: See under Parameters.
Parameter: plm.document.genericDTypes.SLE
Description: Specifies the generic DTypes.
Values: A list of DTypes, separated by ';'
Default value: SEP;SEA
plm.document.variantDType.SEA = SEM
Parameters: plm.document.variantDType.SEP = SEP
plm.document.variantDType.SES = SES
Description: Defines the assignment of variant DTypes to specific generic DTypes.
Values: A list of DTypes, separated by ';'.
Default value: See under Parameters.
plm.document.dtype.Default.PAR.SLE = SEP
plm.document.dtype.Default.ASM.SLE = SEA
Parameters:
plm.document.dtype.Default.DFT.SLE = SED
plm.document.dtype.Default.PSM.SLE = PSM
Description: Defines the assignment of the default DTypes to the document types Part, Assembly, Drawing and Weldment Part.
Values: The respective default type.
Default value: See under Parameters.
Parameter: plm.appl.popwin.name.SLE
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 output a
Description:
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: *Solid Edge*
Parameter: plm.adv.clone.renamerProgram.SLE
Description: During cloning, renaming is necessary through an external program, which must be specified here.
Values: Full path of the program to be renamed.
Default value: @PLM_BINDIR_SLE@\\renamer3sle.exe
Parameter: plm.options.importOnDemand.TransferAttributesToSAP.SLE
Description: If you use an attribute section for <document_create> you have to set this option.
"true" = Use an attribute_section for <document_create>
Values:
"false" = No using of an attribute section for <document_create>
Default value: false
Parameter: plm.options.UpdateAttributes.UpdateReadOnly.SLE
Description: Determines whether attributes of ReadOnly documents should be updated in the structure.
"true" = Update attributes of ReadOnly documents
Values:
"false = Attributes of ReadOnly documents are not updated
Default value: true
Parameter: plm.options.Draft.UpdateViews.AfterAttributeUpdate.SLE
Specifies whether views of drawings should be updated automatically or not.
By default, views are automatically updated after properties of drawings are updated. However, this can take quite a long time for many views. Therefore,
there is the possibility to suppress this.
Description:
ATTENTION:
It should be noted that the views should be updated manually if the value is set to "false"!
"true" = Views automatisch aktualisieren
Values:
"false" = Keine automatische Aktualisierung der Views
Default value: true
Parameter: plm.convert.additional.SLE
Description: Specifies to which Solid Edge document types additional formats can be generated.
Values: A list of DTypes, separated by ';'
Default value: SEA;SEP;SED;SES;SEW;SDM
plm.convert.additional.SLE.SEA = jt
Parameters: plm.convert.additional.SLE.SEP = jt
plm.convert.additional.SLE.SES = jt
plm.convert.additional.SLE.SEW = jt
plm.convert.additional.SLE.SED = pdf
plm.convert.additional.SLE.SDM = pdf
Description: Specifies which additional file formats should be generated for which Solid Edge document types.
A list of additional file formats, separated by ';'.
The additional format type "3dpdf" creates a simple 3D-PDF of the model.
Values:
ATTENTION:
The creation of additional 3D-PDF formats is only possible if the corresponding documents are opened in Solid Edge. Otherwise, no export is performed,
and an error message will be written to the log!
Default value: See under Parameters
Parameter: plm.convert.additional.SLE.jt.keepExtension
Description: Determines whether the file extension for jt files should be retained.
"true" = Keep file extension
Values:
"false" = Do not keep file extension
Default value: false
Parameter: plm.convert.additional.SLE.JT.filenameFormat
The names for additional formats can be configured.
The following placeholders are available, which are replaced by the corresponding SAP values:
Description: • "$ (DOCNUMBER)": SAP name
• "$ (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 construction:
plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.extension = destination Extension
Parameter:
plm.convert.additional.SLE.SEA.JT.extension
Description: Specifies which file name extension should have an additional format ("JT" here)
Value: File extension
Default value: jt
Parameter construction:
plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.options = <VALUE>
Parameter:
plm.convert.additional.SLE.JT.options
Description: The option exists to set specific options for additional formats (here for "JT"). These can then be assigned a value.
Values: The name of an assigned option
Default value: Version
Parameter construction:
plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.<OPTION> = <VALUE>
Parameter:
plm.convert.additional.SLE.SEA.JT.Version
Description: If a specific option is set for an additional format, this can also be given a value for a Solid Edge document type (here, the document type "SEA").
Values: The value that the option should be assigned
Default value: 9
Parameter: plm.options.Thumbnail.SLE.jpg.<preference>
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 used for the preview image. If "size" is not set, the value of the parameter "plm.options.Thumbnail.Size.SLE" is used.
Example:
plm.options.Thumbnail.SLE.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)
Description:
Example:
plm.options.Thumbnail.SLE.jpg.fileformat = $(ORIGINALFILENAME).preview
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.
• 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.
Example:
plm.options.Thumbnail.SLE.jpg.keepExtension = true
Values: See under Description!
plm.options.Thumbnail.SLE.jpg.size = 180
Default value: plm.options.Thumbnail.SLE.jpg.fileformat = $(ORIGINALFILENAME).preview
plm.options.Thumbnail.SLE.jpg.keepExtension = true
Parameter: plm.options.CreateDIRForNewDocument.SLE
Description: Determines whether and how a document info record (DIR) should be created in a newly generated document.
'0' = never generate a document info record
Values: '1' = always generate a document info record
'2' = ask the user if a document info record should be generated
Default value: 2
Parameter: plm.options.HideDIRCreationDialog.SLE
Description: Determines whether the display of the ECTR dialog "Create DIS" should be prevented when creating a new document info record (Create Dark).
"true" = Prevent display of the dialog (create dark)
Values:
"false" = Show dialog
Default value: false
Parameter: plm.options.SaveDIRAfterCreation.SLE
Defines whether documents are to be saved in SAP when an assembly or drawing with a DIR is created from an active model.
Description: ATTENTION:
When a drawing is created from a model, it is saved after positioning the first view. So, you cannot insert more than one view! When inserting further
views, the drawing must be checked out.
"true" = Save to SAP
Values:
"false" = Do not save
Default value: false
Parameter: plm.bom.create.SED
Description: Determines whether a bill of materials (BOM) should be generated for drawings (document type SED).
"true" = Generate BOM
Values:
"false" = Do not generate BOM
Default value: false
Parameter: plm.bom.createAtCheckin.SED
Description: Determines whether a bill of materials (BOM) should be generated for drawings (document type SED).
"true" = Generate BOM
Values:
"false" = Do not generate BOM
Default value: false
Parameter: plm.bom.updateAtCheckin.SED
Description: Determines whether an existing BOM should be updated during checkin.
Description: WARNING:
Checking out before "save as new document" and "save as new version" does not work with all parent documents in Solid Edge! Therefore, this has been
disabled by default.
'0' = Do not check out
Values: '1' = Check out
'2' = Check out and save (intermediate)
Default value: 0
Parameter: plm.options.ReplaceVersion.CheckoutParents.SLE
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
plm.bom.item.property.SLE
Parameter:
plm.bom.item.property.SLE.<OccurrencePropName>
"Custom Occurrence Properties" from Solid Edge can be transferred to the SAP system as properties.
To achieve this, the names of the Custom Occurrence Properties to be transferred must be defined and the names of the SAP properties assigned to them
must be specified:
1. plm.bom.item.property.SLE
This parameter is used to pass a list of Custom Occurrence Properties.
Example: plm.bom.item.property.SLE = OccurrencePropName1;OccurrencePropName2
2. plm.bom.item.property.SLE.<OccurrencePropName>
Description: This parameter is used to assign one SAP property to each Custom Occurrence Property.
Example: plm.bom.item.property.SLE.OccurrencePropName1 = SAPProperty1
ATTENTION:
• To use this feature, the option "Maintain item numbers" must be activated in the "Solid Edge Options" dialog under "Position numbers" so that the
position numbers are retained. Otherwise, the Custom Occurrence Properties are not processed.
IMPORTANT: This option is file-dependent and must be set for each SLE document individually!
• Using these parameters is optional. Therefore, no default values are delivered!
plm.bom.item.property.SLE: List of Custom Occurrence Properties names, separated by semicolons.
Values:
plm.bom.item.property.SLE.<OccurrencePropName>: Name of the SAP property assigned to the respective Custom Occurrence Property.
Default value: --
Parameter: plm.document.FOA.Handling.SLE
Determines whether "Family of Assemblies" (FOA) is supported using MaintainGeneric.
Description: ATENTION:
• A change becomes effective only after restarting Solid Edge and ECTR!
• The value '2' causes that in addition to the Occurrences of a part also the names of the FOA members, in which it is installed, write into the SAP table
DMU_TMXMETA. For further information, see chapter "Problems with FOA handling and AdvancedBOM"!
'0' = No special handling for FOAs.
Values: '1' = Use MaintainGeneric.
'2' = Store the number of shoring units of a part and the names of the FOA members in the SAP table DMU_TMXMETA.
Description:
NOTE:
This setting is only used for Solid Edge versions older than 2019! From Solid Edge version 2019 on, the Solid Edge component IDs are used.
'0' = Component IDs will be written for read only documents
Values:
'1' = Component IDs will not be written for read only documents
Default value: 0
Parameter: plm.options.UpdateAttributes.RefreshContext.SLE
Description: Specify which documents will be affected during attribute refresh.
'0' = Complete structure
Values: '1' = Only selected / top document
'2' = Ask user
Default value: 0
Parameter: plm.document.variants.importOnDemand.SAPDescription.SLE
Description: Defines the SAP description for members of FOAs.
'1' = Member name in Solid Edge
Values: '2' = SAP FOA description
'3' = SAP FOA description and Solid Edge member name
Default value: 3
Parameter: plm.options.importOnDemand.loadDrawings.SLE
Determines whether drawings with a reference to the actual model will be imported too.
Description:
ATTENTION:
This option may decrease performance if activated!
"true" = Import
Values:
"false" = Do not import
Default value: false
Parameter: plm.options.CreateDependentDocument.AskUserOnAdditionalNonMasterCreate.SLE
Determines whether a new dependent document should always be created or an existing document should be opened during the "Create dependent
Description:
document" action if at least one dependent document is already assigned to the selected master.
"true" = Ask user
Values:
"false" = Always create a new dependent document
Default value: false
Parameter: plm.options.save.loadDrawings.SLE
Determines whether drawings with a reference to the actual model will be saved too.
Description:
ATTENTION:
This option may decrease performance if activated!
"true" = Save
Values:
"false" = Don't save
Default value: false
Parameter: plm.doc.cancel.restore.files.SLE
Description: Determines the action during the function "Cancel, discard changes."
"true" = Reset the local copy to the last check-in point
Values:
"false" = Delete the local copy from the session directory
Default value: false
Description:
ATTENTION:
This option is valid from Solid Edge version 2022!
"true" = Display suppressed components
Values:
"false" = Do not display suppressed components
Default value: true
Parameter: structure.view.SLE.generic.object.type
Specifies the generic object type to be displayed in the application structure.
Description:
NOTE:
For further information, please refer to the ECTR documentation.
Values: Generic object type.
Default value: POS_TYPE
structure.view.SLE.generic.object.DRAW_CONTAINER.name = DEFAULT_NAME
Parameters:
structure.view.SLE.generic.object.DRAW_CONTAINER.icon = {0}/sap/folder_open
Specifies default name and icon for folders in which drawings are to be displayed separately in the application structure.
Description:
NOTE:
For further information, please refer to the ECTR documentation.
Folder name as character string or DEFAULT_NAME.
Values:
Icon name in the file "images.jar" (see chapter "Icons for CAD originals in SAP ECTR").
Default value: See under Parameters!
structure.view.SLE.generic.object.SLE_VIRTUAL_NEW.name
Parameter:
structure.view.SLE.generic.object.SLE_VIRTUAL.name
Description: Specifies the attribute mapping for the default display of nodes.
Values: The key name or DEFAULT_NAME.
Default value: DEFAULT_NAME
Parameter: obr.filter.filter.asvselectpossible.sle
Description: Defines filter for the exclusion of the context menu function "Select" in the application structure of the ECTR.
Values: List of filters, separated by semicolon ';'.
Default value: *;PRP;_SELECT_POSSIBLE;STRING;(?i)false;RE
Parameter: obr.filter.filter.asvforeignpossible.sle
Defines filter for the exclusion of some context menu functions in the application structure of the ECTR for built-in non-solid edge files, e.g. "NX" and "JT"
Description:
files.
Values: List of filters, separated by semicolon ';'.
Default value: *;PRP;_ASV_FOREIGN_ORIGINAL;STRING;(?i)true;RE
Parameter: obr.filter.fnc.structure.view.application.generic(FUNCTION_ID)
Setting the filters as function filters for the Application Structure.
NOTE:
Several parameters can be specified, each with a different function ID.
Function filter, separated by semicolon.
Example:
Values:
"filter.asvselectpossible.sle" associates the filters set with the parameter obr.filter.filter.asvselectpossible.sle with the corresponding function in the
application structure view.
Default value: filter.asvforeignpossible.sle;filter.asvforeignpossible.sle
Parameter: plm.document.IgnoreDrawing2DrawingReferences.SLE
Defines whether references from drawings to drawings in the application structure are to be ignored.
Description:
This is important for handling drawing frames and applies to Import, Save, Application Structure, etc.
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"!
Description: ATTENTION:
• These parameters come directly from the ECTR. This is necessary to ensure the function of the renamer. They should not be changed!
• For ECTR version 5.1.15 and from 5.2. the preference "experimental.renamer.call.SLE" is obsolete and can be removed!
Values: Since these parameters are not to be changed, no values are specified here.
Default values: See under Parameter!
Parameter: plm.document.create.references.mastercomp.name.SLE
Description: ECTR requires that the wildcard reference "mastermodel.asm" be replaced by a correct reference.
Values: Name of the reference by which the wildcard reference is to be replaced.
Description:
ATTENTION:
The value "false" can greatly influence the performance for complex document structures!
"true" = Only check in components, which have documents in their structure or are themselves locally modified and/or checked out.
Values:
"false" = Always analyze and check in the complete document structure whether components were modified or not.
Default value: true
Parameter: plm.options.checkIn.AbortAnalysisOfCheckedInComponents.AbortAtFOA.SLE
Determines whether to abort structural analysis of read-only FOA components that are not the active document during check-in.
Description: ATTENTION:
Data can be lost if FOAs are not checked out when changes are made!
"true" = Abort
Values:
"false" = Do not abort
Default value: true
Parameter: plm.options.Thumbnail.Size.SLE
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.PathFinder.Show.DocumentStatus.SLE
Value: Set the document status in Solid Edge, visible in Path Finder.
"true" = Update document status
Wert:
"false" = Don't update document status
Default value: false
Parameter: plm.options.SaveAsNewDocument.UseCopyAs.SLE
During "Save As New Document", the integration uses the "SaveAs" API function by default, which changes the reference in all files opened in Solid Edge.
With this setting, the default behavior can be changed, and the integration uses the "SaveCopyAs" API function instead, which creates a detached copy of
the file.
Description:
ATTENTION:
Not supported for generic files (Family of Parts and Family of Assemblies)!
'1' = Use "SaveAs"
Values:
'2' = Use "SaveCopyAs"
Default value: 1
Parameter structure:
plm.options.BOMTable.Column.SLE.[CAD_COLUMN] = [SAP_FIELD]
Description: NOTES:
• The settings for balloons in the Solid Edge settings dialog "Partslist Properties" are ignored!
• If the item numbers are to be overwritten, they must be unique in the parts list!
'0' = According to the Balloon configuration in Solid Edge
'1' = Upper text in balloon
Values:
'2' = Bottom text in balloon
'3' = Overwrite item number
Default value: 0
Parameter: plm.document.IgnoreInterpartLinks.SLE
Determines whether interpart links should be ignored when importing new data.
Description:
NOTE:
A warning is displayed if the linked document is not found.
Values: "ignorePartToAssemblyLinks" = Links from parts to assemblies are ignored. This is logged while the import is running.
Default value: ignorePartToAssemblyLinks
Parameter: plm.document.CustomIgnoreDirectories.SLE
This setting is used to specify user-defined directories of parts or assemblies that should not be stored in a DIR.
Description: NOTES:
• This parameter is optional!
• The directory paths must be enclosed in quotes and backslashes must be doubled ('\\')!
Values: A list of directory paths, separated by semicolons.
Default value: "D:\\IgnoreAdditionals"; "D:\\ExcludedReferences"
Parameter: plm.document.CustomIgnoreDirectories.IgnoreSubDirectories.SLE
Specifies whether references in subdirectories in the user-defined directories from which references are to be ignored should also be ignored or not.
Description: NOTE:
This parameter is optional!
"true" = All references in subdirectories are also ignored.
Values:
"false" = All references in subdirectories are respected.
Default value: true
Parameter structure:
plm.library.SLE.<library name> = <Path to library>
Parameter:
plm.library.SLE.PartLib
To define a user-defined standard part library, its file path must be specified.
Description: ATTENTION:
• This path must be identical on all workstations!
• The directory path must be enclosed in quotes and backslashes must be doubled ('\\')!
File path of the standard parts library.
Values: Example:
"C:\\Solid Edge Standard Parts\\Standard Parts"
Default value: --
Parameter structure:
plm.document.dtype.<library name>.SLE= <DType name>
Parameter:
plm.document.dtype.PartLib.SLE
Description: This parameter can be used to predefine a DType in the "Import on demand" dialog for a user-defined standard.
Name of the DType.
Values:
Example: SEN
Default value: --
Parameter structure:
plm.tree.workdir.unknown.files.exclude.SLE.[Category] = [Regular Expression]
Description: Example:
plm.execute.additional.SLE.SEA.BeforeCheckIn.commandLine = D:\\Data\\Tools\\ExternalTool.exe
NOTE:
• Executables need a valid file path with escaped backslashes!
Example: "D:\\Data\\Tools\\ExternalTool64.exe"
• When using CADMacro, relative paths can also be specified!
Example: "..\\..\\..\\..\\..\\..\\Script\%USERNAME%\CIDEON.exe"
• When using CADMacro, environment variables are also evaluated!
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.
Examples:
plm.execute.additional.SLE.SEA.BeforeCheckIn.parameter1 = -File
plm.execute.additional.SLE.SEA.BeforeCheckIn.parameter2 = $(FILENAME)
plm.execute.additional.SLE.SEA.BeforeCheckIn.parameter3 = -DType
plm.execute.additional.SLE.SEA.BeforeCheckIn.parameter4 = $(MetaData:SUBTYPE)
NOTES:
• The DType can be queried with "$(MetaData:SUBTYPE)".
• For executables and PowerShell calls, the parameters can also be given as arguments (only the parameter values).
Values: See "Description"!
Default value: ---
Parameter: plm.loadoptions.versionConflictResolveMode.SLE
Resolves version conflicts when multiple versions of the same DIR are required.
Description: NOTES:
• Only works when filenames include versions!
• Use "auto" if the file name contains version numbers and the loading option "As last saved" is used!
"highest_in_structure" = Only the highest versions are loaded.
Values: "all" = Always load all versions for all documents.
"auto" = Load only necessary versions.
Default value: auto
Parameter: plm.control.partnameRules.resolveInSap.SLE
Activation of FileLookUp for Import on Demand.
Description:
IMPORTANT:
Do not change this parameter unless you are advised otherwise!
"true" = FileLookUp is activated
Values:
"false" = FileLookUp is deactivated
Default value: true
Parameter: plm.options.checkIn.UpdateAttributesFromSAP.SLE
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 before save
Description: NOTE:
These settings can be reached in the ECTR preferences for Solid Edge under "Application Structure" as preference "Scroll to selection: Application Structure
-> CAD".
"true" = Scrolls in the PathFinder to the selection.
Values:
"false" = Do not scroll to the selection in the PathFinder. The selection may be outside the visible area.
Default value: false
Parameter: plm.structure.application.CollectEntries.SLE
Determines whether multiple installed components are displayed individually or combined on one level in the Application Structure of the ECTR.
ATTENTION:
Single parts, sheet metal parts, welded parts (pwd) and assembly families ("plm.document.FOA.Handling.SLE" = 0) are always displayed together.
Description:
NOTE:
These settings can be reached in the ECTR preferences for Solid Edge under "Application Structure" as preference "Collect Entries?".
"collectNone" = No summary. Each instance is presented individually.
Values:
"collectAll" = Summarize all instances. Display only one node with the total number.
Default value: collectNone
Parameter: plm.structure.application.init.strategy.levels.SLE
Number of levels to be displayed in the application structure of the ECTR.
Description: NOTE:
These settings can be achieved in the ECTR preferences for Solid Edge under "Application Structure" as preference "Number of levels which should be
submitted to application structure".
'1' - n = Number of levels to be displayed.
Values:
"all" = Display all layers.
Default value: 1
Parameter: plm.options.ImportOnDemand.DeleteOriginals.SLE
Description: Specifies whether the original CAD files are to be deleted after successful import on demand.
"true" = Delete CAD files
Values:
"false" = Do not delete CAD files
Default value: false
Parameter: plm.options.ImportOnDemand.CheckInAfterCreate.SLE
Description: Determines whether documents should be checked in after successful import.
"true" = Documents are checked in
Values:
"false" = Documents won't check in
Default value: true
Parameter: plm.docstructure.instdata.attr.namepattern.SLE
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: plm.options.CreateDirDuringMakeDrawingOrAssemblyFromPartOrAssembly.SLE
Determines whether an "Import on demand" should be performed during the action "Create Drawing / Assembly from Assembly / Part" or whether a "Create
Description:
DIS" dialog should be displayed.
'0' = Use Import on demand
Values: '1' = Use "Create DIR" dialog with drawing as master DIR
'2' = Use "Create DIR" dialog with drawing as dependent document
Default value: 0
Parameter: plm.options.SapSaveAsNewDocumentForCadSaveAs.SLE
Description: Specifies whether the command "Save as..." in CAD can optionally be enabled to save as a new document in SAP.
'0' = Never save as new document, use CAD behavior
Values: '1' = Always save as new document
'2' = Ask user
Default value: 0
ATTENTION:
If the option is set to value 1 or 2, the assembly document will be dirty after loading it.
Default value: 0
Parameter: plm.loadoptions.SLE.ShowCADOpenDialog.Extensions
Description: The Solid Edge "Open File" dialog should be displayed for the file extensions specified here.
Values: List of file extensions in the form ".xyz", separated by ';'. If the parameter remains empty, this applies to all file extensions.
Default value: <Empty>
Parameter: plm.options.StructureAnalysis.MinimumErrorLevel.SLE
Description: Defines the minimum error level for problems to be displayed in the error dialog during the structure analysis.
'0' = Never show dialog (not recommended!)
'1' = Display dialog only if errors were found
Values:
'2' = Display dialog if errors or warnings were found
'3' = Always show dialog
Default value: 3
Parameter: sap.bapi.useGuiTransaction
Description: NOTES:
This parameter is optional.
If it is set here, it overwrites a possibly set value in the file "default.txt" of the ECTR.
List of names of SAP DynPros separated by semicolon.
Values:
Example: /DSCSAG/DOC_CREATE2; /DSCSAG/DOC_CREATE_MULTI
Default value: --
Parameter: plm.structure.application.DisplayAdditionalAttributes.SLE
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" = Don't show additional file properties
Default value: --
Parameter: plm.structure.application.AdditionalAttributes.SLE
Defines which file properties should be displayed in the application structure.
Description:
NOTE:
This parameter is optional.
List of file properties to display, separated by semicolon.
Values:
Example: Prop1;Prop2;Display Name;SAP_CC_NAME
Default value: --
Parameter: plm.options.MechanicalModeling.UpdateMaterial.MaterialLibrary.SLE
Specifies a custom Solid Edge material library when assigning a Solid Edge material for a model from SAP.
Description: NOTES:
• This setting only has an effect if no value for the property "MM-MaterialLibrary" is transferred from SAP!
• If no material library is specified, the integration searches for the material in the standard material libraries of Solid Edge!
Value: Name of the material library to be used.
Default value: CustomMaterialLibrary
Parameter: plm.document.FOA.ReplaceInAllMembers.SLE
Description: Defines whether the context menu function "Replace Component" should be offered for FOA components on the first level.
"true" = Function is offered.
Values:
"false" = Function is not available.
Default value: false
Parameter: plm.structure.application.ExpandDocumentsOnlyOnce.SLE
Defines whether only the first occurrence of a document node should be expanded in the application structure view of the ECTR. Further occurrences of
Description:
this document will then not be expanded automatically.
"true" = Expand the same document only once.
Values:
"false" = Expand each occurrence of the same document.
Default value: false
Parameter: plm.structure.application.UsePlmObjectContent.SLE
Specifies whether "PlmObjectContent" or "GenericContentObject" should be used for virtual component nodes. This controls whether virtual components
linked to materials should be displayed as SAP objects (in the case material) ("true").
Description:
NOTE:
Setting this parameter to "true" requires ECTR version 5.1.12.12.0 or higher!
"true" = Use "PlmObjectContent" for virtual components.
Values:
"false" = Use "GenericContentObject" for virtual components.
Default value: false
plm.structure.node.CUAPOB_SLE_VIRTUAL.icon.1 = structure/flag/state/$(ANY_MODIFIED)/SLE
plm.structure.node.CUAPOB_SLE_VIRTUAL.icon.2 = structure/flag/state/$(STATE)SLE
Parameter:
plm.structure.node.CUAPOB_SLE_VIRTUAL_NEW.icon.1 = structure/flag/state/$(ANY_MODIFIED)/SLE
plm.structure.node.CUAPOB_SLE_VIRTUAL_NEW.icon.2 = structure/flag/state/$(STATE)/SLE
Description: Specifies the icon mapping depending on the status flags for each possible value of POS_TYPE.
Values: Mapping path for the respective icon.
Default value: See under Parameter!
Parameter: plm.structure.application.DisplayPosItem.SLE
Description: Specifies whether virtual components should be displayed below the corresponding node in the application structure tree.
"true" = Display virtual components.
Values:
"false" = Do not display virtual components.
Default value: true
Parameter: plm.options.Cancel.LoadedParts.SLE
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.
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: 0
Parameter: plm.options.SaveAs.CheckInAfterCreate.SLE
Description: Decides 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
Parameter: plm.options.InPlaceActivated.CheckOutDocument.SLE
When a part is opened with "Edit-in-Place" ("InPlaceActivated" command, "Edit" in Pathfinder) from a Solid Edge assembly, this assembly can be
Description:
checked out automatically.
'0' = No, do not check out the assembly.
Values: '1' = Yes, check out the assembly.
'2' = Ask user.
Default value: 0
Parameter: plm.options.MaintainGeneric.DeleteMissingMember.SLE
Determines whether to delete MaintainGeneric for FOA and FOP that are no longer transferred when saved.
Description:
ATTENTION:
This preference is available from ECTR version 5.2.6.0!
"true" = Delete
Values:
"false" = Do not delete
Default value: false
Parameter: plm.options.Save.UseDocumentPropertiesAsRequestedComponentAttributes.SLE
The value for non-existent component attributes referenced in "bod_mapping_section" in the DType definition in the "dtype.xml" file is taken from the
document properties. Only properties included in the "bod_mapping_section" in the DType definition are taken from the document properties. Which
document properties are available is controlled by the preference plm.options.deliverOnlyRequestedAttributesToSAP.SLE.
Note:
Description: More information about the configuration in the configuration files "dtype.xml" and "attributes-to-sap.xml" can be found in chapter "Adopt component
attributes"!
ATTENTION:
• If the value is set to "true", this can reduce the performance!
• This functionality is available from ECTR version 5.2.6.1 or S/4 1.1.6.1!
• Supersedes the parameter plm.options.TransferPropertiesTo.DMUTMX_META.SLW. This should not be used anymore!
"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.Cancel.DialogDefaultValue.SLE
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
There may be problems with FOA handling and AdvancedBOM derivation because users often do not insert a
part in an FOA member, but prefer to replace it, as this is faster for them. In this case, the data in the DMU
tables in SAP is no longer sufficient for correct mapping. As a result, not only is a different shoring state
displayed, but the Occurrences are also different. To counteract this, the number and names of the FOA
members in which an Occurrence is installed can be stored in the SAP table DMUTMX_META. This is done in the
SAP table DMUTMX_META according to the following scheme:
This information can be used for the material BOM derivation process. However, this requires a customer-
specific extension of the AdvancedBOM process, as this is not an SAP standard functionality!
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 Solid
Edge contains definitions and settings for document types supported by Solid Edge.
Structure
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 Solid Edge are described here.
With the installation of the SAP Engineering Control Center interface to Solid Edge the file "dtype.xml" is
The correlation of the DType definitions as well as their dependencies is shown in the following table:
The following are the descriptions of the individual definitions for Solid Edge documents.
The generic definitions are templates with basic definitions that are valid for all Solid Edge document types.
Templates are integrated in the other DType definitions. Two DType templates are defined for Solid Edge:
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 default template is defined, which defines the basic properties for Solid Edge:
The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center.
The subelement <copy_as> defines how the document behaves during a "CopyAs" action and how the SAP
Engineering Control Center reacts to this document.
"ZIP" = Additional originals of 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.
Determines whether the assigned material is also copied when the master
document is copied.
copy_material "no"
"no" = Do not copy assigned material.
Determines whether the dirty flag is removed from the copy.
remove_dirty_flag "no"
"no" = do not remove dirty flag.
The subelement <document_create> contains settings that control how a new document is created in SAP.
"$(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)").
ATTENTION:
It is strongly discouraged to use this
option as it may cause errors, so it should
be left empty!
Shows or hides the classification panel in
the document creation dialog.
show_classification_pane "yes"
"yes" = Show classification panel in the
document creation dialog.
The <material_create> subelement contains settings for creating a material for a new document.
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.
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.
The <checkout_rules> subelement determines how the original document is handled during check-out.
The subelement <checkout_direct> defines which of the originals stored directly on the document are
transferred to the Additional directory when the "Open for editing" action is performed on the original.
The subelement <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 <ignore> subelement defines which files are ignored when saving. For this purpose, it contains the
<plmfile> subelement several times, which defines the additional file types to be ignored.
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.
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.
The subelement <additional_files> defines, determines which additional formats of a document can be
displayed and edited in the SAP Engineering Control Center.
The subelement <view_files> determines for which of the additional originals displayed in the original
container, no processing can be performed on the document. These originals can only be displayed. For this
purpose, it contains subelements of the type <plmfile>, which define the individual document types.
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. For this purpose, it contains
subelements of the type <plmfile>, which define the individual 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.
"SLE" = This is the Workstation Application for (WSAppl) for Solid Edge.
Defines the group designation for master documents. The group designation
helps to organize DTypes within the dialog "Create document".
group "Solid Edge"
"Solid Edge" = Document belongs to this group.
The sub-element <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.
The sub-element <checkout_rules> determines how to treat the original of the document at checkout.
The sub-element <checkin_rules> determines how files in the additional directory and document originals are
treated when checking in. This is why it has multiple sub-elements.
The sub-element <save_direct> determines which additional files (paragraph styles) are stored as originals in
the additional directory when saving. It includes multiple <plmfile> sub-elements that determine the
individual additional file types.
Attributes of the sub-element <plmfile> inherited from the sub-element <save_direct> from <checkin_rules>
Attribute Value Description
The sub-element <scripts> contains scripts that are executed before checking in. Individual scripts are
included in the sub-element <script>.
"@PLM_INSTDIR@\basis\sys\win\bin\VEConverter.bat" = script
call path "VEConverter.bat".
name "@PLM_INSTDIR@\basis\sys\win\bin\VEConverter.bat"
ATTENTION:
For ECTR versions older than version 5.1.12 the default call
path is
"@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat"!
<script> contains the sub-element <params>, which determins parameters to be passed to the running
script. For this purpose, it includes one or more sub-elements <param>, each of which defines a parameter.
Attributes of the sub-elements <param>, sub-element <params>, sub-element <script>, sub-element <scripts> from
<checkin_rules>
Attribute Value Description
The sub-element <allowed_nonmaster> determines the type of document (Nonmaster document) that is
accepted as a dependent document.
Below, you can find the definition of the templates for the DType definition of Drawings:
The sub-element <program_options> contains different settings, which control the behavior of the document
in the SAP Engineering Control Center.
The sub-element <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.
The sub-element <checkout_rules> determines how to treat the original of the document at checkout.
The sub-element <checkin_rules> determines how files in the additional directory and document originals are
treated when checking in. This is why it has multiple sub-elements.
The sub-element <save_direct> determines which additional files (paragraph styles) are stored as originals in
the additional directory when saving. It includes multiple <plmfile> sub-elements that determine the
individual additional file types.
Attributes of the sub-element <plmfile> inherited from the sub-element <save_direct> from <checkin_rules>
Attribute Value Description
The SAP Engineering Control Center distinguishes between master documents and dependent 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. The DType definition of master
documents is divided into the DType definitions for assemblies ("SEA"), parts ("SEP"), drawings ("SEDM"),
sheet metal parts "SES") and weldment assemblies ("SEW").
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.
DType definition for master documents of type "SEA" for Solid Edge
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>.
The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center. It contains the subelement <new_version> which contains settings for
versioning documents.
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.
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.
The <first_level_files> subelement defines which additional originals in the document are stored next to the
original in the Session directory when checking out. It contains the subelement <plmfile>, which defines which
The following is a description of the DType definition for Solid Edge FOA documents:
DType definition for master documents of type "SEM" for Solid Edge FOA member documents
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>.
The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center.
The subelement <copy_as> contains different settings, which determine how the document behaves during a
"CopyAs".
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.
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.
The following is a description of the DType definition for Solid Edge Part documents:
DType definition for master documents of type "SEP" for Solid Edge Part documents
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>.
The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center. It contains the subelement <new_version> which contains settings for
versioning documents.
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.
The <primary_application> sub-element specifies which application is responsible for this master document
(primary application) and defines the rules for checking in and checking out originals.
The following is a description of the DType definition for Solid Edge Part documents:
DType definition for master documents of type "SEN" for Solid Edge Standard Part documents
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>.
The <program_options> subelement contains various settings that control the behavior of the document in the
SAP Engineering Control Center. It contains the subelement <new_version> which contains settings for
versioning documents.
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.
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.
Next comes the description of the DType definition for Solid Edge Part documents for sheet metal parts
("SES"):
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>.
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.
Now follows the description of the DType definition for Solid Edge Assemblies documents for welded
assemblies ("SEW"):
DType definition for master documents of type "SEW" for Solid Edge welding 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>.
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.
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.
The following is a description of the DType definition for Solid Edge Master Drawing ("SEDM") documents:
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>.
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.
The <material_create> subelement contains settings for creating a material for a new document.
material_creation_method "no" "no" = No material is created for the document. A subsequent material
creation for this document via SAP Engineering Control Center is not
possible.
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.
The last section describes the DType definition for Solid Edge Master Drawing ("SEDM") documents:
DType definition for master documents of type "SXLS" for Linked Excel files
The SAP Engineering Control Center distinguishes between master documents and dependent documents. The
latter are referred to as nonmaster documents and are assigned to their respective 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.
Here are the DType definitions of nonmaster documents for Solid Edge for the type "SED"-nonmaster:
"SLE" = This is the Workstation Application for (WSAppl) for Solid Edge.
The sub-element <icon> defines an abbreviation that will be used when determining the applicable symbol in
the SAP Engineering Control Center. It also contains the sub-element <icondef>.
The sub-element <nonmaster_options> is used to control how the dependent document responds in relation
to the master document.
The sub-element <document_create> determines the way in which the document is created in SAP.
The <seedfile> sub-element 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> sub-element, which
defines each description text in different languages.
Attributes of the second <seedfile> sub-element inherited from the <document_create> sub-element
Attribute Value Description
The "filename" attribute is used to specify the template file that is to be
used. You can create a template file in the "Create Document" dialog using
filename "Draft.dft" a file selection dialog.
The sub-element <material_create> contains settings for creating a new document from materials.
The sub-element <primary_application> determines which application is assigned to this master document
(primary application) and defines the rules for the checking in and out of the originals.
The actual definition of the component attributes to be adopted is then done in the corresponding section in
the configuration file "attributes-to-sap.xml":
Whether non-existing component attributes should be taken from the document properties is
controlled by the parameter
"plm.options.Save.UseDocumentPropertiesAsRequestedComponentAttributes.SLE"!
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.
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
present in the tree on the left side:
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!
<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.
Dictionary identifiers can and should also be used for the following attributes:
<option label="...">, <option tooltip="..."> and <entry name="...">
Example dictionary.txt:
With the element <card> you define the options that can be reached under the respective card node. The
assignment is done via name of card.
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.
If you want to present a list of possible values, you have to enter the sub-element <entry> which might occur
repeatedly.
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 Solid Edge 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:
"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 Solid Edge" or by opening a document in the
Application Structure etc. If Solid Edge is started without ECTR or the connection to ECTR is
established later, setting environment variables via the file "plm_setenv.bat" does not work!
For this to work, the following extensions must be added to the Solid Edge configuration file
"C:\Program Files\Siemens\Solid Edge 202X\Preferences\CustomOccurrenceProperty.xml":
<OccurrenceProperty>
<Name>SAP_MATERIAL_EXT</Name>
<Description>External Material number for virtual Components</Description>
<PropertyBehavior>Global+Overrides</PropertyBehavior>
<ListOfValues></ListOfValues>
<DefaultValue></DefaultValue>
</OccurrenceProperty>
<OccurrenceProperty>
<Name>SAP_MATERIAL_INT</Name>
<Description>Internal Material number for virtual Components</Description>
<PropertyBehavior>Global+Overrides</PropertyBehavior>
<ListOfValues></ListOfValues>
<DefaultValue></DefaultValue>
</OccurrenceProperty>
Version information
To gain an overview of the imported changes of the relevant releases of the SAP Engineering Control Center
Interface to Solid Edge, 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.
• The DType definitions "SEA" and "SEM" have both got the sub-element <program_options>
added.
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.08.50.00
of DTypes and Seedfiles. All elements <description language="XY"> are omitted except
English, which are used as fallback.
You must use transaction "CDESK_CUS" (for R/3 Systems) or "CAD_SRV_CUS" (for S/4HANA Systems) to define
the explosion rule "BOM_DERIVE" for the CAD system "SOLIDEDGE". You do this in the view "Explosion Rules"
under "Explosion Scenario":
The explosion rule "BOM_DERIVE" is empty by default. This must now be set as follows:
This customizing setting stops the determination of the document structure as soon as a document with SORTF
= SLE:I will be found. This means that the document itself and all subordinate documents are not added to the
hierarchy and are not determined further. This may prevent circular references:
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.
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.