CIDEON ECTR Interface To SolidWorks Configuration Manual PDF
CIDEON ECTR Interface To SolidWorks Configuration Manual PDF
SAP Engineering Control Center Interface to SOLIDWORKS manages the design data in SAP.
SAP Engineering Control Center Interface links the CAD system closely to the SAP PLM Interface and makes
data available to the company early-on in the design process. Product Lifecycle Management begins as soon
as the design has started instead of through an interface at the end of the design phase. By coupling the CAD
system and the SAP Engineering Control Center, the components designed in the CAD system can be
managed.
You can configure the SAP Engineering Control Center Interface to SOLIDWORKS 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.
© 2019 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 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Folder structure and directories .................................................................................................................. 4
Icons for CAD originals in SAP ECTR ............................................................................................................... 5
Manual installation of SAP Engineering Control Center Interface to SOLIDWORKS ......................................... 7
Starting SOLIDWORKS from ECTR in the SAP logon language ........................................................................ 7
The configuration files ................................................................................................................................... 8
Menu definitions ............................................................................................................................................. 8
menu.guidef ................................................................................................................................................ 8
menu_macros.txt ...................................................................................................................................... 10
attributes-from-sap.xml and attributes-to-sap.xml ....................................................................................... 10
attributes-from-sap.xml ............................................................................................................................ 11
attributes-to-sap.xml ................................................................................................................................. 14
SOLIDWORKS Properties ........................................................................................................................... 16
default.txt ..................................................................................................................................................... 21
Parameter transfer as XML file when calling external tools or macros ...................................................... 39
dtype.xml ..................................................................................................................................................... 40
DType definitions for SOLIDWORKS .......................................................................................................... 41
Generic DType definitions ..................................................................................................................... 41
DType definition for master documents ................................................................................................ 60
DType definition for nonmaster documents .......................................................................................... 74
options.xml ................................................................................................................................................... 77
plm_setenv.bat ............................................................................................................................................. 80
rfc-tunnel-whitelist.txt .................................................................................................................................. 81
connector-macro-whitelist.txt ....................................................................................................................... 81
Version information ...................................................................................................................................... 82
Configuration examples ............................................................................................................................... 85
Activate simple pop-up message .................................................................................................................. 85
Mapping the properties ................................................................................................................................ 86
Available properties .................................................................................................................................. 88
Use custom properties .............................................................................................................................. 89
Material-specific mapping ......................................................................................................................... 92
Variant-independent .............................................................................................................................. 92
Variant-specific ...................................................................................................................................... 93
Final Remark ............................................................................................................................................... 102
CIDEON Software & Services GmbH & Co. KG Page 2 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
CIDEON Software & Services GmbH & Co. KG Page 3 of 102 2019-12-05
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-ins are stored during their installation in separate
subdirectories.
"%PLM_INSTDIR%\applications\slw" is the installation directory of the SAP Engineering Control Center Interface
to SOLIDWORKS. It contains the following subdirectories which are significant for configuration:
"%PLM_INSTDIR%\applications\slw\appdata"
"%PLM_INSTDIR%\applications\slw\basis"
"%PLM_INSTDIR%\applications\slw\documentation"
"%PLM_INSTDIR%\applications\slw\templates"
"%PLM_INSTDIR%\applications\slw\template-templates"
"%PLM_INSTDIR%\applications\slw\template-customize\config"
"%PLM_INSTDIR%\applications\slw\customize\config"
"%PLM_INSTDIR%\applications\slw\customize\scripts\macros"
The SAP Engineering Control Center Interface to SOLIDWORKS has a toolbar in CAD next to the main menu
that contains its functions as buttons. In the subdirectory icons contained here, all of the symbols used for
these toolbar buttons can be found in two sizes: 16 x 16 and 32 x 32 pixels.
"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).
"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.
Will create a new document on the SAP Engineering Control Center, so you can choose from a list of 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.
CIDEON Software & Services GmbH & Co. KG Page 4 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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.
Here, files can be found that are necessary for the configuration of the SAP Engineering Control Center
Interface to SOLIDWORKS. 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 SOLIDWORKS, 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, for example specific types of
documents, workstation applications and menu items.
This directory contains additional scripts that extend the check-in and check-out process.
Macro definition files are stored here. The macro definition file "map_attributes.txt" for mapping attributes of
virtual components when saving is located here.
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 "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!
CIDEON Software & Services GmbH & Co. KG Page 5 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
A set of standard icons is delivered in the file "%PLM_INSTDIR%\applications\slw\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 SOLIDWORKS:
CIDEON Software & Services GmbH & Co. KG Page 6 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SOLIDWORKS Application
small\app_solidworks.png
Menu: System\Start application\SOLIDWORKS
Instruction: Parallel operation with the CIDEON CDESK-Interface to SOLIDWORKS is not supported
due to partially different data model! Other information for this is available under Problems during
parallel operation with CIDEON CDESK-Integration).
CIDEON Software & Services GmbH & Co. KG Page 7 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The configuration files
The files contained in the directory "%PLM_INSTDIR%\applications\slw\customize\config" 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
SOLIDWORKS 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 overriden
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 SOLIDWORKS
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 SOLIDWORKS 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
CIDEON Software & Services GmbH & Co. KG Page 8 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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.
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.
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_SLWMDL" (for SOLIDWORKS
models) and "om.popup.menu.CLONEPOS.DOC_SLWDRW" (for SOLIDWORKS drawings):
###############################################################################
# SOLIDWORKS Cloning Menu
+ om.popup.menu.CLONEPOS.DOC_SLWMDL = ? DOCUMENT_SLW_GENERAL_CLONING
+ om.popup.menu.CLONEPOS.DOC_SLWDRW = ? DOCUMENT_SLW_GENERAL_CLONING
Definition of the functions of the context menu for "Cloning" in file "menu_macros.txt"
? DOCUMENT_SLW_GENERAL_CLONING = fnc.doc.clone.option.NO_ACTION
= fnc.doc.clone.option.NEWINTNR_OPTION
= fnc.doc.clone.option.NEWEXTNR_OPTION
= fnc.doc.clone.option.REPLACE_OPTION
= fnc.doc.clone.option.NEWVERS_OPTION
= fnc.doc.clone.option.CHANGE_OPTION
= -----------------------------
= fnc.doc.clone.select.dependent
= -----------------------------
= fnc.clpbrd.delete
= fnc.doc.reload
CIDEON Software & Services GmbH & Co. KG Page 9 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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"
IMPORTANT:
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.
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_SLW" is required, so that the SAP Engineering Control Center can start the
SOLIDWORKS 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.
CIDEON Software & Services GmbH & Co. KG Page 10 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"%PLM_INSTDIR%\customize\config\attributes-from-sap.xml"
and
%PLM_INSTDIR%\customize\config\attributes-to-sap.xml".
The following SOLIDWORKS-specific attribute mapping files exist for this purpose:
"%PLM_INSTDIR%\applications\slw\customize\config\attributes-from-sap.xml"
and
"%PLM_INSTDIR%\applications\slw\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.
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.
Possible values are: "STANDARD", "default" und "STDMOD".
CIDEON Software & Services GmbH & Co. KG Page 11 of 102 2019-12-05
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>
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
CIDEON Software & Services GmbH & Co. KG Page 12 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
<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>
CIDEON Software & Services GmbH & Co. KG Page 13 of 102 2019-12-05
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\slw\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.
CIDEON Software & Services GmbH & Co. KG Page 14 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Name of the document or material field which can be changed in SAP.
Within a section, attributes belonging to this attribute section are defined with the sub-element
<APPL_ATTRIBUTE>.
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"!
With version 2.13.62.0 of the SAP Engineering Control Center Interface to SOLIDWORKS, the following
"DocumentSummaryInformation" attributes are provided additionally for mapping file names and folder
names:
You can now use the file "attributes-to-sap.xml" to map DMUCAD data together. You have to set the
"bod_mapping_section" in the configuration file "dtype.xml" for the DType of the document:
CIDEON Software & Services GmbH & Co. KG Page 15 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
set "bod_mapping_section" in dtype.xml
Only DMUCAD fields can be used as APPL_ATTRIBUT here! In addition, the macro file
"map_attributes.txt" must be in the customize\scripts\macros folder. This must also be entered in
the configuration file "connector-macro-whitelist.txt".
SOLIDWORKS Properties
General information
IThe SOLIDWORKS properties provided by the SAP Engineering Control Center Interface to SOLIDWORKS 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.
The properties consist of a prefix and the actual property name. The prefix designates the property category.
Property categories
CIDEON Software & Services GmbH & Co. KG Page 16 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Document properties
Document summary information
Custom properties (user defined properties)
Configuration specific custom properties
Physical properties
The properties "DP-Scale1" and "DP-Scale2" can also be read sheet-specifically and even view-
specifically. This can be set via the parameter "plm.options.DeliverSpecificSheetProperties.SLW" in
the configuration file "default.txt".
CIDEON Software & Services GmbH & Co. KG Page 17 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Category: Document summary information
Prefix: DSI-
User-defined properties can be used with or without the prefix "UDP-". Whether the "UDP-" prefix
is to be added to the custom properties can be determined via the parameter
"plm.options.updateAttributes.useInteropPrefix.SLW" in the configuration file "default.txt".
Examples:
UDP-<Propertyname> --> "UDP- SAPName"
<Propertyname> --> "SAPName"
User-defined properties can be used with or without the prefix "UDP-". Whether the "UDP-" prefix
is to be added to the configuration specific custom properties can be determined via the
parameter "plm.options.updateAttributes.useInteropPrefix.SLW" in the configuration file
"default.txt" bestimmt werden.
Examples:
$(variant:<Konfigurations-ID>)-UDP-<Propertyname> --> "$(variant:0)-UDP- SAPName"
$(variant:<Konfigurations-ID>)-<Propertyname> --> "$(variant:0)-SAPName"
HINT:
Configuration-specific properties from SAP to CAD can be written. The properties are then passed
on in a BAdI implementation. No customizing in the "attribtes-from-sap.xml" file is then required
for these properties!
CIDEON Software & Services GmbH & Co. KG Page 18 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
By default, the physical properties are always read according to configuration. Then the
configuration is identified again before the property name.
Example:
$(variant:<Konfigrations-ID>)-PP-<Propertyname> --> "$(variant:0)-PP-Accuracy"
CIDEON Software & Services GmbH & Co. KG Page 19 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Selection of document-specific units in SOLIDWORKS
In order 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 therefore be used
in the form "$(variant:<Configuration ID>)-PP-<Propertyname>".
<MA field="MARA-NTGEW">
<APPL_ATTRIBUTE name="$(variant)-PP-WeightInDocumentUnit"/>
</MA>
<MA field="MARA-GEWEI">
<APPL_ATTRIBUTE name="$(variant)-PP-WeightUnitInDocumentUnit"/>
</MA>
<MA field="MARA-VOLUM">
<APPL_ATTRIBUTE name="$(variant)-PP-VolumeInDocumentUnit" />
</MA>
<MA field="MARA-VOLEH">
<APPL_ATTRIBUTE name="$(variant)-PP-VolumeUnitInDocumentUnit" />
</MA>
The following conversion factors and text values apply to the units:
CIDEON Software & Services GmbH & Co. KG Page 20 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Grams 1000 g
Kilograms 1 kg
Milligrams 1000000 mg
Pounds 2,2046 lb
default.txt
The file "default.txt" contains basic settings that influence the interaction between the SAP Engineering Control
Center, SAP Engineering Control Center to SOLIDWORKS 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".
It is to be noted that the parameters of the character string ".SLW" listed here must be included
for SOLIDWORKS in order to be assigned to the appropriate CAD system from the SAP Engineering
Control Center!
ATTENTION:
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 table contains all parameters included in the file "default.txt" in delivery status, as well as their
default settings:
CIDEON Software & Services GmbH & Co. KG Page 21 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Description: Consider circle references for cloning.
Values: 'Y'
Default value: Y
plm.om.DOC.containers.SWP
Parameters: plm.om.DOC.containers.SWA
plm.om.DOC.containers.SWN
Description: Determines which information and attribute content of a document type should appear in the tree view of the ECTR.
Values: List of containers, separated by ';'.
Default value: CADVARS;@plm.om.DOC.containers@
plm.cad_variant.fgroup.forDocType.SWP
Parameters: plm.cad_variant.fgroup.forDocType.SWA
plm.cad_variant.fgroup.forDocType.SWN
Description: Defines the function group for SOLIDWORKS configurations for the individual document types.
Values: Name of the function group.
Default value: SLW_CADVAR
Parameter: sap.plm.document.variant.cdesk_variant.SLW
Description: Determines whether CDESK_VARIANT objects are to be used.
"true" = Use CDESK_VARIANT objects
Values:
"false" = Do not use CDESK_VARIANT objects
Default value true
Parameter: plm.options.variantType.SLW.SpeedPak
Defines the variant type for SpeedPaks.
Description:
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Variant type. Example: SPK
Default value: --
Parameter: plm.options.variantType.SLW.derivedConfiguration
Defines the variant type for derived configurations.
Description:
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Variant type. Example: DRV
Default value: --
Parameter: plm.options.variantType.SLW.<VARIANT_GROUP_NAME>
Defines a user-defined variant group and defines its variant type.
plm.options.variantType.SLW.<VARIANT_GROUP_NAME> = <VARIANT_TYPE>
<VARIANT_GROUP_NAME> = Name of the variant group
Description: <VARIANT_TYPE> = Variant type
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Variant type. Example: VWC
Default value: --
Parameter: plm.options.variantType.SLW.<VARIANT_GROUP_NAME>.namePattern
To define which configurations belong to the variant group, it is possible to define a name pattern using regular expressions
and/or a configuration-specific custom property.
Description:
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Regular expression. Example: ".*_view"
Default value: --
Parameter: plm.options.variantType.SLW.<VARIANT_GROUP_NAME>.property.<PROPERTY_NAME>
CIDEON Software & Services GmbH & Co. KG Page 22 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
To define which configurations belong to the variant group, you can define a configuration specific custom property.
plm.options.variantType.SLW.<VARIANT_GROUP_NAME>.property.<PROPERTY_NAME> = <PROPERTY_VALUE>
<VARIANT_GROUP_NAME> = Name of the variant group
Description: <PROPERTY_NAME> = Name of the custom property
<PROPERTY_VALUE> = Value of the custom property
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Name of the custom property. Example: X
Default value: --
Parameter: plm.options.variantType.BOMRelevant.SLW
List of BOM relevant variant types.
For BOM relevant variant types the configuration will be activated during structure analysis and the information will be read
which component is with which configuration built in a specific assembly configuration. Configurations which only represent
a view state are usually not BOM relevant. If no BOM relevant variant type is defined only configurations with variant type
Description: 'STD' are BOM relevant. For non BOM relevant variants no instance informations will be read. For these configurations it is
not possible to derive a BOM!
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: List of BOM relevant variant types separated by ';'.
Default value: --
Parameter: plm.mat.create.variant.types.hidden
It is possible to define in ECTR for view configurations that no material is to be created for it. To do this, you must specify
the variant types for which no materials are to be created.
NOTE:
It is also possible to specify different icons for view configurations. For this you have to specify an icon in the ECTR
configuration file "standard_icons.txt" for the respective variant type, which must be available in the archive "images-
Description:
sap.jar".
The entry must have the following form: cadvar.object.<variantType> = <path in images-sap.jar>
Example: "cadvar.object.SPK = {0}/sap/view_variant"
ATTENTION:
This option requires ECTR version 5.2.2.0 or higher!
Values: List of variant types separated by ';'. Example: SPK
Default value: --
Parameter: plm.cad_variant.fgroup.forVariantType.<variantType>
It is possible to define a separate menu for the different variant types. To do this, you must use this parameter to specify a
function group for the variant. The Function Group can then be used in the configuration files "menu.guidef" and
"menu_macros.txt".
ATTENTION:
This option requires ECTR version 5.2.2.0 or higher!
Values: Name of the Function Group. Example: SLW_VIEW_CADVAR
Default value: --
Parameter: plm.cad_variant.dgroup.forVariantType.<variantType>
It is possible to define display groups for the different variant types. To do this, a Display Group for the variant must be
specified with this parameter.
Description:
NOTE:
For further information on display groups, please refer to the ECTR documentation.
ATTENTION:
This option requires ECTR version 5.2.2.0 or higher!
Values: Name of the Display Group. Example: SLW_DGROUP
Default value: --
Parameter: plm.control.waitForSessionInMs.SLW
CIDEON Software & Services GmbH & Co. KG Page 23 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Description: Defines the time until the application starts and the communication via interface will be established.
Values: Time in milliseconds
Default value: 15000
Parameter: plm.options.Logging.LogPerformanceTrace.SLW
Decides whether to create a log file with performance traces in the ECTR log directory for the interface.
Description:
ATTENTION:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Log performance traces
Values:
"false = No logging of performance traces
Default value: false
Parameter: plm.options.structureAnalyze.readSmartFeatures.SLW
Indicates whether any existing SOLIDWORKS "smart features" should be resolved or not during structural analysis.
Description: ATTENTION:
- "ImportOnDemand" is not supported!
- If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Input smart features
Values:
"false" = Do not input smart features
Default value: false
Parameter: plm.options.importOnDemand.TransferAttributesToSAP.SLW
Description: If you use an attribute_section for <document_create/> in file "dtype.xml" you have to set this option.
"true" = Use attribute_section
Values:
"false" = Don't use attribute_section
Default value: false
Parameter: plm.options.importOnDemand.loadDrawings.SLW
Determines whether drawings which have a reference to imported models will be imported or not.
Description:
ATTENTION:
This may decrease performance!
"true" = Import also drawings
Values:
"false" = Ignore drawings
Default value: false
Parameter: plm.options.importOnDemand.loadResolvedForSave.SLW
Description: Determines whether model will be loaded fully resolved for save during import on demand or not.
"true" = Load model fully resolved for save
Values:
"false" = Use SOLIDWORKS setting
Default value: false
Parameter: plm.options.ImportOnDemand.DeleteOriginals.SLW
Delete original CAD files after successful import on demand.
Description: ATTENTION:
- It is strongly recommended to set this option to "false", otherwise other document structures that refer to
imported documents may be damaged!
- If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Delete original CAD files
Values:
"false" = Do not delete original CAD files
Default value: false
Parameter: plm.options.ImportOnDemand.CheckInAfterCreate.SLW
Description: Check-in documents after successful import on demand.
"true" = Documents will be checked in
Values:
"false" = Documents will not be checked in
Default value: true
Parameter: plm.options.save.loadDrawings.SLW
Determines whether drawings which have a reference to saved models will be saved or not.
Description:
ATTENTION:
This may decrease performance!
CIDEON Software & Services GmbH & Co. KG Page 24 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Save also drawings
Values:
"false" = Ignore drawings
Default value: false
Parameter: plm.options.save.saveExternalReferences.SLW
Determines whether external references and their structures will be saved or not.
Description:
ATTENTION:
This may decrease performance!
"true" = Save also external references and their structures
Values:
"false" = Ignore external references
Default value: false
Parameter: plm.options.save.updatePhysicalPropertiesDuringSave.SLW
Description: Determines whether physical properties will be updated during save or not.
"true" = Update physical properties
Values:
"false" = Use SOLIDWORKS setting
Default value: true
Parameter: plm.options.CreateDIRForNewDocument.SLW
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.CreateDirDuringMakeDrawingOrAssemblyFromPartOrAssembly.SLW
Determines which dialog appears when processing "Create drawing from part / assembly" and "Create assembly from part /
Description:
assembly" to DIS creation.
'0' = Use "Import" dialog (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.CreateDirDialogForDefeature.SLW
Within the SOLIDWORKS function "Defeature", a new document and a new DIS can be created. This parameter determines
Description:
which method or dialog is to be used for the DIS installation.
'0' = Use "Import" dialog (Import on demand)
Values:
'1' = Use "Create DIR" dialog
Default value: 0
Parameter: plm.options.CreateDirDialogForVirtualComponent.SLW
Specifies whether the dialog "Create DIS" or the function "Import on demand" should be used for the SOLIDWORKS function
Description:
"Save virtual components as external file".
'0' = Use "Import" dialog (Import on demand)
Values:
'1' = Use "Create DIR" dialog
Default value: 0
Parameter: plm.options.excludeFromBOM.ignoreSubcomponents.SLW
Determines whether subcomponents will be ignored when excluded from BOM.
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Ignore subcomponents
Values:
"false" = Do not ignore subcomponents
Default value: false
Parameter: plm.options.excludeFromBOM.ConsiderChildComponentDisplayInBOM.SLW
Determines whether to use the SOLIDWORKS BOM option "Child component display in BOM when used as a subassembly"
(to be found in the BOM options of the configuration properties) to determine the "Excluded from BOM" state. Is the
parameter set to "true" and the SOLIDWORKS functionality is set to "Promote" the instance in SAP will be marked as 'Not
relevant for bill of material' but its subcomponents will be aggregated (like sort string 'W').
Description:
ATTENTION:
- This option can decrease the performance specifically for SOLIDWORKS < 2018!
- If this option is changed SOLIDWORKS and ECTR must be restarted!
CIDEON Software & Services GmbH & Co. KG Page 25 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Use "Child component display in BOM when use as subassembly"
Values:
"false" = Do not use "Child component display in BOM when use as subassembly"
Default value: false
Parameter: plm.options.ConsiderChildComponentDisplayInBOM.LoadDocument.SLW
If the option "plm.options.excludeFromBOM.ConsiderChildComponentDisplayInBOM.SLW" is set to "true" and the
SOLIDWORKS BOM option "Child component display in BOM when used as a subassembly" with all setting values is to be
used, it is necessary in older SOLIDWORKS versions to load the document, no matter which setting was selected, although
this would actually only be necessary for "One level up". However, if only the "Show" and "Hide" settings are used, loading
the document is not necessary.
Description:
ATTENTION:
- If this option is set to "true", the SOLIDWORKS BOM option must NOT be set to "Promote"!
- This option is only effective if the setting "plm.options.excludeFromBOM.ConsiderChildComponentDisplayInBOM.SLW" is
set to "true".
- As of SOLIDWORKS 2018, this option is ignored.
"true" = The document is always loaded
Values:
"false" = The document is not loaded (Please notice the notes above!)
Default value: true
Parameter: plm.options.ChildComponentDisplayInBOM.Show.DissolveAssembly.SLW
If the SOLIDWORKS BOM option "Child component display in BOM when used as a subassembly" is set to "Show", it can be
Description:
specified whether the assembly is to be dissolved in the BOM or not.
"true" = Dissolve assembly in the BOM
Values:
"false" = Do not dissolve assembly in the BOM
Default value: false
Parameter: plm.option.ActiveConfigurationOnly.SLW
Description: Analyzing and publishing structure of active configuration only.
"true" =
For assemblies structure of active configuration only will be published during check in. Additional sort string of components
will be provided as
- 'C' for normal components
- 'W' or 'WU' for components that in SOLIDWORKS are marked as 'Excluded from BOM'
- 'W' in case that parameter plm.options.excludeFromBOM.ignoreSubcomponents = false: Sub components will be
Values:
aggregated
- 'WU' in case that plm.options.excludeFromBOM.ignoreSubcomponents = true:Sub components will be ignored
- 'S' for components that are suppressed in SOLIDWORKS
These sort strings will be provided in bill of documents (BOD).
"false" = Structure of all configurations will be published, sort string of all components will be set to 'C'.
Default value: false
Parameter: plm.options.bom.UsePrefixAsCategory.SLW
When Save (ModifyInstData) a document with virtual components, the property prefix of a metadata entry (entry in
Description:
DMU_TMXMETA) can optionally be set as CATEGORY.
"true" = Fill CATEGORY field with prefix
Values:
"false" = Fill CATEGORY field with CAD abbreviation
Default Value: false
Parameter: plm.options.closeDocumentForReopen.SLW
Determines whether files are closed and than opened again if reopen is required (e.g. if in sap a newer version of the file
exist).
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Close and reopen file
Values:
"false" = Release file handle and reload it
Default value: false
Parameter: plm.options.readComponentReferenceAlsoForLightweightAssemblyComponents.SLW
Determines whether the component reference transferred to SAP instance attribute even then when the component is only
opened in lightweight mode.
Description:
WARNING:
- If this option is changed SOLIDWORKS and ECTR must be restarted!
- This option may decrease performance!
"true" = Yes
Values:
"false" = No
CIDEON Software & Services GmbH & Co. KG Page 26 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Default value: false
Parameter: plm.options.structureAnalyze.showDialogForMissingReferences.SLW
Determines whether a dialog will be shown when find missing references during structure analyze.
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Yes
Values:
"false" = No
Default value: true
Parameter: plm.options.structureAnalyze.cacheDocumentKeysUsedForInstanceIDs.SLW
Determines that the document key (DIR), which is used to create the instance ID, is to be read and buffered only once.
Description:
WARNING:
Deactivating this option may decrease performance!
"true" = Yes
Values:
"false" = No
Default value: true
Parameter: plm.options.structureAnalyze.useAcceleratedConfigurationChange.SLW
Effects faster switching of the configuration during the structure analysis. The feature tree and the configuration tree are
Description:
deactivated during the structure analysis. In addition, the configuration is loaded before its components are fetched.
"true" = Accelerate configuration changes
Values:
"false = Use default configuration change
Default value: false
Parameter: plm.options.save.useTwoTierStructureAnalyze.SLW
This parameter activates a two-tier structure analysis when saving the document structure.
Description:
Hint:
Activating the two-tier structure analysis can improve performance.
"true" = Activate two-tier structure analysis
Values:
"false" = Deactivate two-tier structure analysis
Default value: false
Parameter: plm.convert.additional.SLW
CIDEON Software & Services GmbH & Co. KG Page 27 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Additional file formats are adapted via this parameter.
1) Definition of SOLIDWORKS document types for which additional file formats can be created:
plm.convert.additional.SLW = <DOCTYPE1>;<DOCTYPE2>
Example:
plm.convert.additional.SLW = SWA;SWP;SWD
2) Definition which additional file formats for which SW document type are to be generated:
plm.convert.additional.SLW.<DOCTYPE> = <CONVERT TYPE1>;<CONVERT TYPE2>
Example:
plm.convert.additional.SLW.SWP = JT
Examples:
- plm.convert.additional.SLW.JT.Options = STL2JT
- plm.convert.additional.SLW.PDF.Options = keepExtension
5) For each combination of document type - additional file format each of its options can be set:
plm.convert.additional.SLW.<DOCTYPE>.<CONVERT TYPE>.<OPTIONS> = <VALUE>
Examples:
- plm.convert.additional.SLW.SWA.JTM.STL2JT = C:\\Program Files (x86)\\SAP\\FrontEnd\\SAPgui\\Program\\stltojt.exe
- plm.convert.additional.SLW.SWD.PDF.keepExtension = false
Values: See Description!
Default value: These parameters are commented out by default!
Parameter: plm.convert.additional.SLW.JT.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
Values: String that can contain the allowed placeholders.
Default value: Number.$(DOCNUMBER)_Type.$(DOCTYPE)_Version.$(DOCVERSION)_Part.$(DOCPART)
Parameter: plm.options.maximumNumberOfGDIObjects.SLW
Sets the maximal amount of GDI objects.
Description: WARNING:
- If this option is changed SOLIDWORKS and ECTR must be restarted!
- This number shouldn't exceed 9990!
Values: Max. 9990
Default value: 8000
Parameter: plm.options.Thumbnail.SLW.jpg.<preference>
CIDEON Software & Services GmbH & Co. KG Page 28 of 102 2019-12-05
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.) "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)
Example:
plm.options.Thumbnail.SLW.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" in the name of 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".
2.) "keepExtension": Determines whether the token "$(ORIGINALFILENAME)" keeps the extension of the master original or
whether it is removed.
Example:
plm.options.Thumbnail.SLW.jpg.keepExtension = true
Values: See under Description!
plm.options.Thumbnail.SLW.jpg.fileformat = $(ORIGINALFILENAME).preview
Default value:
plm.options.Thumbnail.SLW.jpg.keepExtension = true
Parameter: plm.options.SapOpenForCadOpenDocument.SLW
Description: Determines whether a document will be loaded from SAP when clicked 'Open'.
'0' = Use SOLIDWORKS default dialog
Values: '1' = Use ECTR dialog
'2' = Ask user
Default value: 2
Parameter: plm.options.SapOpenForCadPlaceDocument.SLW
Description: Determines whether a document will be loaded from SAP when add component to assembly/reload model in drawing.
'0' = Use SOLIDWORKS default dialog
Values: '1' = Use ECTR dialog
'2' = Ask user
Default value: 2
Parameter: plm.options.SapOpenForLoadDrawing.SLW
Description: Determines whether document will be loaded from SAP when load drawing.
'0' = Use SOLIDWORKS default dialog
Values: '1' = Use ECTR dialog
'2' = Ask user
Default value: 0
Parameter: plm.options.MacroName.GetRelatedDrawings.SLW
CIDEON Software & Services GmbH & Co. KG Page 29 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Defines a macro that is executed when the "Open drawing" function is used in SOLIDWORKS. The default macro
"get_related_drawings.txt" ensures that master drawings are also loaded.
Description: IMPORTANT:
- Available from ECTR version 5.1.15.1 and interface version 2.20.83.0!
- The macro file entered here must be located in the directory
"%PLM_INSTDIR%\applications\slw\customize\scripts\macros"!
- The macro is only called if the parameter plm.options.SapOpenForLoadDrawing.SLW is set to the value '1' or '2'!
Values: Name of the macro file.
Default value: get_related_drawings.txt
Parameter: plm.options.open.UseMultiSearchForSapOpen.SLW
Choose which ECTR open dialog should be used when opening a document from SAP. Enabling this option will let you open
Description:
multiple documents at once.
"true" = Use multi search dialog
Values:
"false" = Use single search dialog
Default value: true
Parameter: plm.loadoptions.SLW.DocumentLoadMode
Description: Determines the document load mode.
"default" = Use SOLIDWORKS settings
"resolved" = Load model fully resolved
"lightweight" = Load model lightweight (assemblies and drawings only)
Values: "viewOnly" = Load in view only
"useSpeedpak" = Use Speedpak (assemblies and drawings only)
"ignoreHiddenComponents" = Do not load hidden components (assemblies only)
"showCadOpenDialog" = Show CAD open dialog
Default value: default
Parameter: plm.options.ShowComponentNameAndOrDescriptionInFeatureTree.SLW
Show component name and/or component description in SOLIDWORKS FeatureManager structure tree after loading
document.
Description:
ATTENTION: Since this setting of SOLIDWORKS is stored directly in the model file, the document can be dirty if a value
other than '0' is chosen here!
'0' = Use document settings
'1' = Show component name
Values:
'2' = Show component description
'3' = Show component name and component description
Default value: 0
Parameter: plm.options.ChangeFeatureTreeDisplayOnlyForWritableDocuments.SLW
Description: Specifies whether the SOLIDWORKS FeatureTree display should be changed for writable documents only.
"true" = Yes
Values:
"false" = Always change
Default value: true
Parameter: plm.options.MissingReferenceReloadOption.SLW
Description: Define behavior if SOLIDWORKS notices a missing component file when loading an assembly.
'0' = Use SOLIDWORKS behavior
'1' = Load component from SAP automatically
'2' = Ask user for loading the missing component from SAP
Values:
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.options.ActionWhenVirtualComponentWithReferencesToRealComponentsFound.SLW
Define the behavior if SOLIDWORKS notices a virtual component which has at least one reference to a real component.
Description: ATTENTION:
- The virtual component and its structure will be ignored anyway!
- If you change this option you have to restart SOLIDWORKS and ECTR!
CIDEON Software & Services GmbH & Co. KG Page 30 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
'0' = Only log the virtual component
'1' = Log the virtual component and ask user if he want to abort structure analyze
Values:
NOTE:
The option '1' will only take affect during operations "Save" and "Save and Display". If the user decide to abort structure
analysis the "Save" or "Save and Display" process will be aborted.
Default value: 1
Parameter: plm.options.handlingOfVirtualComponents.SLW
Description: Defines how virtual components should be handled during structural analysis.
'0' = Virtual parts and assemblies are ignored
'1' = Virtual parts are displayed in the Application Structure and saved in SAP. You can also link materials to them in the
application structure. However, virtual assemblies are ignored.
Values:
NOTE:
Virtual assemblies will be ignored, even with the value '1'!
Default value: 0
Parameter: plm.options.handlingOfCutlistItems.SLW
Defines how cutlist items in parts are handled during structural analysis.
Cutlist items are passed to SAP as virtual instances of the part. This mainly concerns weldment parts.
Description:
ATTENTION:
The inclusion of cutlist items in the structural analysis can reduce performance! Users who do not need to capture virtual
instances should set this parameter to '0'!
'0' = Ignore cutlist items
Values:
'1' = Consider cutlist items
Default value: 0
Parameter: plm.bom.create.Sxx
Description: Determines whether a bill of materials (BOM) should be generated for document types SWD, SDN, SWA, SWP und SWN
"true" = Generate BOM
Values:
"false" = Do not generate BOM
Default value: false
Parameter: plm.bom.createAtCheckin.Sxx
Determines whether a bill of materials (BOM) should be generated for document types SWD, SDN, SWA, SWP und SWN
Description:
during check-in
"true" = Generate BOM
Values:
"false" = Do not generate BOM
Default value: false
Parameter: plm.bom.updateAtCheckin.Sxx
Description: Determines whether an existing BOM should be updated during check-in
"true" = Update BOM
Values:
"false" = Do not update BOM
Default value: false
Parameter: plm.bom.update.Sxx
Description: Determines whether an existing BOM should be updated
"true" = Update BOM
Values:
"false" = Do not update BOM
Default value: false
Parameter: plm.document.SaveAsNewDocument.CheckOutTop.SLW
Description: Determines what should be done with the parent document during the function "Save as new document".
'0' = Do not check out
Values: '1' = Check out
'2' = Check out and save (intermediate)
Default value: 0
Parameter: plm.options.SaveAsNewDocument.Replace.SLW
Description: Defines the method for replacing references in the "Save as new document" function.
CIDEON Software & Services GmbH & Co. KG Page 31 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
'0' = Replace in all open views without warning dialog
'1' = Replace only in active and unavoidable other views without warning dialog
Values: '2' = Replace in all open views after displaying a warning dialog
'3' = Replace only in active and unavoidable other views without warning dialog
'4' = Do not replace references
Default value: 0
Parameter: plm.options.SaveAsNewDocument.CancelSourceFile.SLW
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.updateAttributes.useInteropPrefix.SLW
Determines whether the prefix "UDP-" will be used for user-defined properties ("UDP") This is necessary for interoperability
Description:
between CAD systems.
"true" = Use prefix
Values:
"false" = Do not use prefix
Default value: true
Parameter: plm.options.deliverOnlyRequestedAttributesToSAP.SLW
Determines whether deliver only requested attributes to SAP.
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Yes
Values:
"false" = No
Default value: true
Parameter: plm.options.UpdateAttributes.UpdateReadOnly.SLW
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.UpdateAttributes.RefreshContext.SLW
Description: Specify which documents will be affected during attribute refresh.
'0' = Complete structure of the complete assembly when executed from ribbon, complete structure of the component when
executed from context menu
Values:
'1' = Only the top assembly when running from ribbon, only the component when running from context menu
'2' = Ask user
Default value: 0
Parameter: plm.options.checkIn.UpdateAttributesFromSAP.SLW
Description: Determines whether attributes from SAP are updated before save (check-in) documents.
"true" = Update attributes before save
Values:
"false" = Do not update attributes before save
Default value: false
Parameter: plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW
Deliver physical properties configuration specifications.
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"true" = Yes
Values:
"false" = No (read physical properties of active configuration)
Default value: true
Parameter: plm.options.MacroName.MapAttributesMacroName.SLW
The name of the macro to map attributes of virtual components according to the "bod_mapping_section" of the parent
document. This macro is used e.g. for "Save" or "Save & Display".
Description:
IMPORTANT:
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: map_attributes.txt
CIDEON Software & Services GmbH & Co. KG Page 32 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameter: plm.options.DeliverSpecificSheetProperties.SLW
Determines if sheet specific properties will be transferred. It is possible to get the dimensions for all sheets and the scaling
for all sheets and drawing views. Dimensions wont be collected for drawing views only for sheets.
Description:
WARNING:
If this option is changed SOLIDWORKS and ECTR must be restarted!
"0" = Only for the active sheet
Values: "1" = For all sheets
"2" = For all sheets and the scaling of drawing views
Default value: 0
Parameter: plm.options.checkIn.AbortAnalysisOfCheckedInComponents.SLW
When an assembly is checked in, its entire structure is usually analyzed to find also checked out and / or modified
documents. This takes a long time, however. Assuming that a read-only, unmodified component file can not have been
modified (i.e., in its components and its contents), its structure analysis can optionally be dispensed with in order to speed
up the process.
Description:
ATTENTION:
This only works reliably if the CAD system reliably passes changes to sub-sub components to the top module. Otherwise
inconsistencies may occur! In case of uncertainty this option should not be activated! It is also necessary to check
whether the parameter
plm.options.DeselectCADOptionForPromptToSaveReadOnlyDocuments.SLW must be set to "true"!
"true" = Performance option is activated
Values:
"false" = Performance option is not used
Default value: true
Parameter: plm.options.DeselectCADOptionForPromptToSaveReadOnlyDocuments.SLW
If the SOLIDWORKS option "No prompt to save read-only referenced documents (reject changes)" in the "System Options"
under "External References" is activated and the function controlled with the parameter
Description:
plm.options.checkIn.AbortAnalysisOfCheckedInComponents.SLW is activated, sub-sub components won't be propagated to
the top module. However, this can be prevented with the parameter described here by deactivate this option at checkin.
"true" = Override SOLIDWORKS option on Checkin
Values:
"false" = Do not override SOLIDWORKS option on Checkin
Default value: false
Parameter: plm.options.DeselectCADOptionForPurgeCachedConfigurationData.SLW
This parameter controls whether the option "Purge cached configuration data" in the SOLIDWORKS settings under
"Performance" is activated or deactivated. Deactivating them results in fewer dirty flags.
Description:
ATTENTION:
If this option is changed, SOLIDWORKS and ECTR must be restarted!
"true" = Option is activivated
Values:
"false" = Option is deactivivated
Default value: true
Parameter: plm.doc.cancel.restore.files.SLW
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
Parameter: plm.options.checkForUpdates.before.CheckoutEdit.MultiLevel.SLW
Determines whether the complete structure or only the directly referenced documents should be checked using
Description:
CheckForUpdates before a 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.SLW
When using the MultiLevel-CheckForUpdate, this preference can be used to specify a explosion scenario that can be
Description:
customized using CDESK_CUS.
Values: Explosion scenario according to the values possible in CDESK_CUS
Default value: CAD_LOAD
Parameter: plm.options.import.standardPart.dark.SLW
Description: Determines whether standard parts imported dark.
CIDEON Software & Services GmbH & Co. KG Page 33 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Yes
Values:
"false" = No
Default value: false
Parameter: plm.library.SLW.<library name>
Specifies the access path to a standard part directory containing user-specific standard part libraries.
Description: ATTENTION:
- The prerequisite is that the standard part directory is accessible to all computers which should have access to it and is
located in the same location (this is usually a network drive)!
- If this option is changed SOLIDWORKS and ECTR must be restarted!
Values: Access path to the standard part directory (e.g.: "\\\\svr-standard-parts\\MyLib").
Default value: - none -
Parameter: plm.document.dtype.ToolboxPart.SLW
Determines the DType for SOLIDWORKS toolbox parts (standard parts).
Description:
WARNING:
The DType indicated here must be defined in the file "dtype.xml"!
Values: A DType defined in "dtype.xml"
Default value: SWNPR
Parameter: plm.structure.application.CollectEntries.SLW
Determines whether multiple built-up components in the structure overview of the ECTR will be displayed individually or
Description:
summarily.
"collectNone" = No summary. Every instance will be shown individually
Values: "collectAll" = Summarize all instances. Only depict and summarize a node with the total
"collectBySLWConfiguration" = All instances separately for each configuration
Default value: collectNone
Parameter: plm.structure.application.AdditionalAttributes.SLW
List of available file attributes that should additionally be displayed in the ECTR structure display. For configuration-specific
Description:
properties, "$(variant)-" can be used and must be placed before an attribute name, e.g: "$(variant)-MATNR".
List of file types, separated by ';'.
Values:
Prefix "$(variant)-" before the attribute name to mark configuration-specific attributes is possible.
Default value: - none -
Parameter: plm.structure.application.DisplayAdditionalAttributes.SLW
Description: Determines whether the file attributes given in the list should additionally be displayed or not in the ECTR structure display.
"true" = Display additional file attributes
Values:
"false" = Do not display additional file attributes
Default value: false
Parameter: plm.structure.application.HideStructureOfSpeedPaks.SLW
Determines whether the document structure of assemblies with a SpeedPak as active configuration will resolved and
Description:
displayed in the ECTR structure display or not.
"true" = Document structure of assembly with a SpeedPak as active configuration will not resolved
Values: "false" = If a SpeedPak is the active configuration of an assembly switch to SpeedPak's parent configuration and resolve
document structure
Default value: false
Parameter: plm.structure.application.show.drawing.SLW
Description: Specifies whether referenced drawings are to be displayed in the ECTR application structure.
"true" = Show drawings
Values:
"false" = Do not display drawings
Default value: false
Parameter: plm.structure.application.show.drawing.container.SLW
Specifies whether referenced drawings in the ECTR application structure are to be displayed in a separate folder within the
Description:
structure.
"true" = Display referenced drawings from the session directory in a separate folder
Values:
"false" = Add referenced drawings from the session directory below the document node
Default value: false
structure.view.SLW.generic.object.DRAW_CONTAINER.name = DEFAULT_NAME
Parameters:
structure.view.SLW.generic.object.DRAW_CONTAINER.icon = {0}/sap/folder_open
Description: Specifies default name and icon for folders in which drawings are to be displayed separately in the application structure.
CIDEON Software & Services GmbH & Co. KG Page 34 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Folder name as character string or DEFAULT_NAME,
Values:
Iconname in the file "images.jar" (see chapter "Icons for CAD originals in SAP ECTR").
Default value: See under Parameters!
Parameter: plm.structure.application.LoadDrawings.SLW
Description: Determines wether drawings which have reference to model should be displayed or not in the ECTR structure display.
"true" = Display drawings which have reference to model
Values:
"false" = Don't display drawings which have reference to model
Default value: false
Parameter: plm.structure.application.init.strategy.levels.SLW
Description: Number of levels which should be submitted to application structure.
"all" = Complete structure
Values:
<number> = Number of levels
Default value: 1
Parameter: plm.structure.application.DisplayExternalReferences.SLW
Description: Determines whether external references are to be displayed in the application structure of the ECTR.
"true" = Display external references
Values:
"false" = Don't display external references
Default value: false
Parameter: plm.structure.application.DisplaySuppressedComponents.SLW
Determines whether suppressed components are displayed in the application structure.
Description: NOTE:
This parameter is also included in the preference dialog "Application Structure" of the ECTR as option "Display suppressed
components".
"true" = Yes
Values:
"false" = No
Default value: false
structure.view.SLW.generic.object.SLW_VIRTUAL_NEW.name
Parameter:
structure.view.SLW.generic.object.SLW_VIRTUAL.name
Description: Property mapping for default node view.
Node view attribute.
Values:
Will be read from node attributes as follows: DEFAULT_NAME = "Customized I18N Text".
Default value: DEFAULT_NAME
Parameter: structure.view.SLW.generic.object.type
Description: Key name of property for different object types.
Key name.
Values: Will be read from node attributes as follows:
POS_TYPE = [ SLW_VIRTUAL_NEW | SLW_VIRTUAL ]
Default value: POS_TYPE
Parameter: plm.structure.application.UsePlmObjectContent.SLW
Decides whether to use PlmObjectContent or GenericContentObject for virtual component nodes. This controls whether
Description:
virtual components linked with materials are to be displayed as SAP objects (in this case material) ("true").
"true" = Use PlmObjectContent for virtual components
"false" = Use GenericContentObject for virtual components
Values:
NOTE:
Setting this option to "true" requires ECTR 5.1.12.0 or later.
Default value: false
plm.structure.node.CUAPOB_SLW_VIRTUAL_NEW.icon.1 = flag/flag_sign_off
Parameter:
plm.structure.node.CUAPOB_SLW_VIRTUAL.icon.1 = flag/has_material/SLW
Icon mappings for virtual component nodes.
Description:
NOTE:
Only required if "plm.structure.application.UsePlmObjectContent" is not set.
Values: The respective icon mapping.
Default value: See under Parameter!
Parameter: plm.structure.application.DisplayPosItem.SLW
Description: Display virtual components (e.g. cut-list items) in the Application Structure view of the ECTR.
CIDEON Software & Services GmbH & Co. KG Page 35 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Display
Values:
"false" = Do not display
Default value: false
Parameter: plm.options.bom.UseAutoBomItemGroup.SLW
Decides whether to use an automatically calculated value for the BOM_ITEM_GROUP field when transferring data from
Description:
virtual instances to SAP.
"true" = Calculate value per instance and use as BOM_ITEM_GROUP
Values:
"false" = Use attribute from CAD or empty value
Default value: false
Parameter: plm.options.Ballooning.BalloonContent.SLW
Description: Sets the content for balloons.
'0' = Material and BOM position number
'1' = material number
Values: '2' = BOM position number
'3' = SAP balloon content
'4' = CAD position number
Default value: 3
Parameter: plm.options.Ballooning.InitializeBalloonWith.SLW
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.BOMTable.Column.SLW.[CAD_COLUMN] = [SAP_FIELD]
If a BOM exists in a drawing and this contains a column [CAD_COLUMN], this determines which content from which SAP field
Description:
[SAP_FIELD] is stored there.
The following tags are possible for SAP fields. These identify the corresponding column of the return table "ET_BALLOONS":
IMPORTANT:
For <NAME> you can take the values from "ET_CUSTOMER_DATA", which the function module
"/DSCSAG/DOC_BALLOONING_PROVIDE" returns. However, this table must be filled in a BAdI implementation!
Default value: plm.options.BOMTable.Column.SLW.SAPMaterial = MATERIAL_EXT
Parameter: plm.options.BOMTable.AddNonExistingColumns.SLW
Determines whether a non-existing column [CAD_COLUMN] is to be added to a drawing in the CAD BOM and updated with
the contents of [SAP_FIELD] or not.
Description:
ATTENTION:
If this option is changed, SOLIDWORKS and ECTR must be restarted!
"true" = Add column
Values:
"false" = Do not add column
Default value: true
experimental.renamer.call.SLW = true
plm.application.SLW.cadRenamer.enable = true
Parameter:
plm.application.SLW.cadRenamer.components = MULTI_LEVEL
plm.application.SLW.cadRenamer.explosionScenario = CAD_RENAMER
Controls the call of the additional application "renamer3slw.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.SuppressAlwaysSaveAsDialogForReadOnlyConvertedDocuments.SLW
During local save of a document structure always suppress SaveAs-Dialog for read-only converted documents (documents
Description:
saved in previous SOLIDWORKS version).
CIDEON Software & Services GmbH & Co. KG Page 36 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"true" = Yes
Values:
"false" = No
Default value: true
Parameter: plm.options.localSave.AvoidRebuildOnSave.SLW
Defines whether a rebuild of the model should be avoided when saving locally.
Description:
ATTENTION:
If this option is changed, SOLIDWORKS and ECTR must be restarted!
"true" = Do not rebuild (local save sets "AvoidRebuildOnSave" flag)
Values:
"false" = Perform Rebuild
Default value: true
Parameter: plm.execute.additional.SLW
CIDEON Software & Services GmbH & Co. KG Page 37 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
It is possible to execute additional functions before or after a specific PLM process by starting either an executable file
(external tool) or a CAD macro (internal VBA or command routine) and powershell.
Examples:
plm.execute.additional.SLW.SWA.BeforeCheckIn
plm.execute.additional.SLW.SLDPRT.BeforeCreateDocuments
IMPORTANT:
In case of execution time "BeforeCreateDocuments" the wildcard <DOCTYPE1> must be replaced with the file extension.
For all other execution times the wildcard <DOCTYPE1> represents the document type!
Example:
plm.execute.additional.SLW.SWP.BeforeCheckIn.type = Executable
NOTE:
Executables need a valid file path with escaped backslashes!
Example: "D:\\Data\\Tools\\ExtractFormat64.exe"
Examples:
plm.execute.additional.SLW.SWD.AfterBallooning.module = Drawing_DeleteDuplicateBa
plm.execute.additional.SLW.SWD.AfterBallooning.function = main
NOTE:
For the version type "CADMacro" it is absolutely necessary to specify the options "module" and "function"!
The placeholder 'N' stands for the parameter number. The parameter number also determines the order in which the
parameters are passed!
Example:
plm.execute.additional.SLW.SWA.BeforeCheckIn.parameter1 = $(FILENAME)
plm.execute.additional.SLW.SWA.BeforeCheckIn.parameter2 = Test-User
Hint:
For executables and power shell calls, the parameters can also be given as arguments (only the parameter values).
For the parameter transfer, the XML file "parameters.xml" is generated, which can be evaluated by the called module. For
more information, see chapter Parameter transfer as XML file when calling external tools or macros!
Values: See in Description!
Default value: ---
CIDEON Software & Services GmbH & Co. KG Page 38 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Parameter transfer as XML file when calling external tools or
macros
C:\Users\User\AppData\Local\Temp\CIDEON\Macros\CdnECTRInterfaceSWx_64.dll\TestMacro.swp\parameters.x
ml
This must be evaluated by a called executable or macro if a parameter transfer is necessary. When calling
external applications and the Windows powershell, the parameters can also be given as arguments (only the
parameter values).
Return of macros
C:\Users\User\AppData\Local\Temp\CIDEON\Macros\CdnECTRInterfaceSWx_64.dll\TestMacro1.swp\return.xml
CIDEON Software & Services GmbH & Co. KG Page 39 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
On return codes != 0, the message is displayed as an error message. If return code = 0, the message is only
output in the log file.
The evaluation of the return messages takes place in the following sequence:
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
SOLIDWORKS contains definitions and settings for document types supported by SOLIDWORKS.
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 SOLIDWORKS are described here.
CIDEON Software & Services GmbH & Co. KG Page 40 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
DType definitions for SOLIDWORKS
With the installation of the SAP Engineering Control Center interface to SOLIDWORKS 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 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 SOLIDWORKS documents.
The generic definitions are templates with basic definitions that are valid for all SOLIDWORKS document types.
These are integrated in the other DType definitions. Two DType templates are defined for SOLIDWORKS:
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.
CIDEON Software & Services GmbH & Co. KG Page 41 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Generic DType definition for SOLIDWORKS parts and assemblies
<checkin_rules from_application_only="yes">
<save_direct>
<plmfile extension="jpg" workstation_application="EPJ" description="ECtr Preview (jpeg)"/>
<plmfile extension="edrw" workstation_application="EDW" description="$(FILENAME)"/>
<plmfile extension="eprt" workstation_application="EDW" description="$(FILENAME)"/>
<plmfile extension="easm" workstation_application="EDW" description="$(FILENAME)"/>
<plmfile extension="stp" workstation_application="STP" description="$(FILENAME)"/>
<plmfile extension="step" workstation_application="STP" description="$(FILENAME)"/>
<plmfile extension="igs" workstation_application="IGS" description="$(FILENAME)"/>
<plmfile extension="stl" workstation_application="STL" description="$(FILENAME)"/>
<plmfile extension="sat" workstation_application="SAT" description="$(FILENAME)"/>
<plmfile filename_pattern=".*_mono\.rh" workstation_application="RHM" description="Monolithic RH"/>
<plmfile filename_pattern=".*_mono\.vds" workstation_application="RHM" description="Monolithic VDS"/>
<plmfile extension="rh" workstation_application="RH" description="$(FILENAME)"/>
</save_direct>
<ignore>
<plmfile extension="bak"/>
<plmfile extension="tmp"/>
<plmfile extension="xml"/>
<plmfile filename_pattern="VEConverterResponse\.xml"/>
</ignore>
<delete_in_sap>
<plmfile workstation_application="EPG"/>
<plmfile workstation_application="EPJ"/>
<plmfile workstation_application="CGO"/>
<plmfile workstation_application="JT"/>
<plmfile workstation_application="EDW"/>
<plmfile workstation_application="STP"/>
<plmfile workstation_application="IGS"/>
<plmfile workstation_application="STL"/>
<plmfile workstation_application="SAT"/>
</delete_in_sap>
<delete_in_session>
<plmfile extension="jpg"/>
<plmfile extension="gif"/>
<plmfile extension="cgm"/>
<plmfile extension="rh"/>
<plmfile extension="vds"/>
</delete_in_session>
<scripts>
<script name="@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat">
<params>
<param name="convertfile"/>
<param name="$(masterfile)"/>
<param name="--output-directory"/>
<param name="$(add_dir)"/>
<param name="--output-format"/>
<param name="RH"/>
<param name="--sap-identifier"/>
<param name="DOCUMENT=$(doc_type)*$(doc_nr)*$(doc_part)*$(doc_vr)"/>
<param name="--sap-metadata"/>
<param name="DOCTYPE=$(doc_type)"/>
<param name="--sap-metadata"/>
<param name="DOCNUMBER=$(doc_nr)"/>
<param name="--sap-metadata"/>
<param name="DOCPART=$(doc_part)"/>
<param name="--sap-metadata"/>
<param name="DOCVERSION=$(doc_vr)"/>
<param name="--import-setting"/>
<param name="LoadExternalFiles=false"/>
</params>
</script>
</scripts>
</checkin_rules>
</primary_application>
<additional_files enable_additional_files="yes">
<ignore_files>
<plmfile workstation_application="EPJ"/>
<plmfile workstation_application="EPG"/>
<plmfile workstation_application="JT"/>
</ignore_files>
</additional_files>
<allowed_nonmaster DType="VWINM" max_count="99"/>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 42 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attribute to the element <DType> of template definition "SLWMDL"
Attribute Value Description
Determines the type of DType definition.
type "template"
"template" = This is a DType template definition.
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 "SLWMDL"
"SLWMDL" = ID of this template definition.
Determines which template definition should be integrated into this
definition.
include_template "DEFLT"
"DEFLT" = The DType template with ID "DEFLT" from the global
"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 "SLW" Center.
The sub-element <program_options> contains different settings, which control the behavior of the document
in the SAP Engineering Control Center.
CIDEON Software & Services GmbH & Co. KG Page 43 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines if change of status applies during
check in at SAP Engineering Control Center or if
SAP System conducts change of status.
attempt_status_change_on_checkin "yes"
"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, individual context
function_group "DOC_SLWMDL" menus can be defined.
The sub-element <copy_as> determines how the document behaves during a "CopyAs" action and how SAP
Engineering Control Center reacts to the document.
CIDEON Software & Services GmbH & Co. KG Page 44 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines if dirty flag of copy will be reset.
remove_dirty_flag "no"
"no" = The dirty flag of copy remains set.
The sub-element <document_create> contains settings that control the way in which a new document is
created in SAP.
CIDEON Software & Services GmbH & Co. KG Page 45 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
SAP document type for the newly created
document.
document_type "SWP"
"SWP" = SAP document type.
Sets the initial value of the part number
for documents.
initial_document_part "000"
"000" = Initial value of the doucment part
number.
Defines whether the default value or the
selected SAP partial document from the
"initial_document_part" attribute can be
changed in the input field in the
part_editable "no" documentation system dialog for SAP
Engineering Control Center.
"$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
= The file name consists of document
number, document type, and partial
document.
Determines the composition of the
document version in the file name for the
original of this document. The following
filename_template_version "" placeholder can be used: $(DOCVERSION)
for the document version.
The sub-element <material_create> contains settings for creating a new document from materials.
CIDEON Software & Services GmbH & Co. KG Page 46 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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 the same as that of the document number
material_number_assignment "internal" assignment.
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 <container_file> defines the characteristics of the ZIP archive, which is stored in the
document as a container file. It contains the <plmfile> sub-element, which defines the properties for the
container file.
CIDEON Software & Services GmbH & Co. KG Page 47 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the sub-element <plmfile> inherited from the sub-element <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 sub-element <checkout_rules> determines how to treat the original of 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
CIDEON Software & Services GmbH & Co. KG Page 48 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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 respective file name extensions of
additional files in the file system.
"jpg", "edrw", "eprt", "easm", "stp",
extension
"step", "igs", "stl", "sat", "rh", "jt" "jpg", "edrw", "eprt", "easm", "stp", "step",
"igs", "stl", "sat", "rh", "jt" = The respective file
name extensions
Workstation application identifiers for each
additional format.
"EPJ", "EDW", "STP", "IGS", "STL",
workstation_application
"SAT", "RHM", "JT", "RH" "EPJ", "EDW", "STP", "IGS", "STL", "SAT",
"RHM", "JT", "RH" = Identification of the
document types.
Description of the respective additional file.
"ECtr Preview (jpeg)",
description "$(FILENAME)", "Monolithic RH", "ECtr Preview (jpeg)", "$(FILENAME)",
"Monolithic VDS" "Monolithic RH", "Monolithic VDS"= Description
of the additional files.
Filters by file names and regular expressions.
filename_pattern ".*_mono\.rh", ".*_mono\.vds"
".*_mono\.rh", ".*_mono\.vds" = Filter masks.
The <ignore> sub-element determines which files will be ignored when saving. It includes multiple times the
sub-element<plmfile> that determines the additional file types to ignore.
The sub-element <delete_in_sap> determines which original in the document should be deleted during check
in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that
determine the additional file types to delete.
The <delete_in_session> sub-element determines which files should be deleted during check in. It includes
CIDEON Software & Services GmbH & Co. KG Page 49 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
multiple <plmfile> sub-elements that determine the additional file types to delete.
The sub-element <scripts> contains scripts that are run before checking in. The individual scripts are
contained in sub-element <script>
<script> contains the sub-element <params> which determines the parameters for running the script. This
includes one or more sub-elements <param>, which each define a parameter.
Attributes of the sub-elements <params>, sub-element <params>, sub-element <script>, sub-element <scripts> from
<checkin_rules>
Parameter Values Description
"convertfile", "$(masterfile)",
"--output-directory", "$(add_dir)",
"--output-format", "RH",
"--sap-identifier", Contains the name of each
"DOCUMENT=$(doc_type)*$(doc_nr)*$(doc_part)*$(doc_vr)", defined parameter. These partly
Name
"--sap-metadata", "DOCTYPE=$(doc_type)", contain mutable data in the form
"--sap-metadata", "DOCNUMBER=$(doc_nr)", of 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 will be displayed and
can be edited in the SAP Engineering Control Center.
The sub-element t <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 sub-items of
type <plmfile> which define the individual document types.
CIDEON Software & Services GmbH & Co. KG Page 50 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The identifiers of the types of documents that should not be
displayed.
workstation_application "EPJ", "EPG", "CGM"
"EPJ", "EPG", "JT" = Identification of the document types.
Thee sub-element <allowed_nonmaster> determines which types of document (Nonmaster documents) are
accepted as a dependent document.
Now follows the definition of the template for the DTYPE definition of Drawings:
CIDEON Software & Services GmbH & Co. KG Page 51 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Generic DType definition for SOLIDWORKS drawings
<nonmaster_options link_to_master_material="yes"/>
<container_file>
<plmfile extension="ecf" workstation_application="ECF" description="ECtr container file"/>
</container_file>
<checkin_rules from_application_only="yes">
<save_direct>
<plmfile extension="jpg" workstation_application="EPJ" description="ECtr Preview (jpeg)"/>
<plmfile extension="gif" workstation_application="EPG" description="ECtr Preview (gif)"/>
</save_direct>
<ignore>
<plmfile extension="bak"/>
<plmfile extension="tmp"/>
<plmfile extension="xml"/>
</ignore>
<delete_in_sap>
<plmfile workstation_application="EPG"/>
<plmfile workstation_application="EPJ"/>
</delete_in_sap>
<delete_in_session>
<plmfile extension="jpg"/>
<plmfile extension="gif"/>
</delete_in_session>
</checkin_rules>
</primary_application>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 52 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines the type of DType definition.
type "template"
"template" = This is a DType template definition.
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 "SLWDRW"
"SLWDRW" = ID of this template definition.
Determines which template definition should be integrated into this
definition.
include_template "DEFLT"
"DEFLT" = The DType template with ID "DEFLT" from the global
"dtype.xml" file is included.
Designates the application that is relevant for this document (Workstation
Applikation). This application opens the file from SAP Engineering Control
application_type "SLW" Center.
The sub-element <program_options> contains different settings, which control the behavior of the document
in the SAP Engineering Control Center.
CIDEON Software & Services GmbH & Co. KG Page 53 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Sets the Function Group to which the document
belongs. For documents with a common
Function Group, for example, specific context
function_group "DOC_SLWDRW" menus can be defined.
The sub-element <copy_as> determines how the document behaves during a "CopyAs" action and how SAP
Engineering Control Center reacts to the document.
CIDEON Software & Services GmbH & Co. KG Page 54 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines the type of document status that allows visioning of
documents. A list of document statuses can be given separateed by ";".
Status list "AC;IW;FR"
"AC;IW;FR" = With this type of document status new versions are allowed.
Determines which additional originals of the document will be accepted
during versioning but not into new version of document according to a
ignore_wsappl_list "ZIP" table of identifiers for the Workstation Application for additional originals
all of which are separated by semicolon.
"ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied.
Determines which depending documents will be omitted during versioning
of master documents. Depending documents to be omitted will be listed in
ignore_nm_dtype_list "" a table of DTypes, separated by semicolon.
The sub-element <nonmaster_option> determines whether a dependent document will be linked to the
material of the master document.
The sub-element <document_create> contains settings that control the way in which a new document is
created in SAP.
CIDEON Software & Services GmbH & Co. KG Page 55 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
In case of document_number_assignment
= "internal" and "master" the value of this
field has no meaning This value is entered
as a prefix in the input field of the
initial_document_number "*"
document system dialogue when the
number is externally assigned.
"$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
= The file name consists of document
number, document type, and partial
document.
Determines the composition of the
document version in the file name for the
original of this document. The following
filename_template_version "" placeholder can be used: $(DOCVERSION)
for the document version.
CIDEON Software & Services GmbH & Co. KG Page 56 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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 check in and check out of originals.
CIDEON Software & Services GmbH & Co. KG Page 57 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The sub-element<container_file> defines the characteristics of the ZIP archive, which is stored in the
document as a container file. It contains the <plmfile> sub-element, which defines the properties for the
container file.
Attributes of the sub-element <plmfile> inherited from the sub-element <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 sub-element <checkout_rules> determines how to treat the original of 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.
CIDEON Software & Services GmbH & Co. KG Page 58 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
"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.
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 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 paragraph style.
workstation_application "EPJ", "EPG"
"EPJ", "EPG" = Identification of the document types.
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> sub-element determines which files will be ignored when saving. It includes multiple times the
sub-element<plmfile> that determines the additional file types to ignore.
The sub-element <delete_in_sap> determines which original in the document should be deleted during check
in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that
determine the additional file types to delete.
The sub-element <delete_in_session> determines which files should be deleted during check in. It includes
multiple <plmfile> sub-elements that determine the additional file types to delete.
CIDEON Software & Services GmbH & Co. KG Page 59 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
DType definition for master documents
The SAP Engineering Control Center distinguishes between master documents and dependent documents. The
master document is the main 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 for master documents is divided up into DType definitions for parts ("SWP") and
assemblies ("SWA") as well as their standard parts ("SWN") and for drawings ("SWD").
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 the type "SWP" for SOLIDWORKS
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_part_$(FAMILY)16"/>
</icon>
<document_create document_type="SWP" document_number_assignment="internal"
rename_template_filename="yes">
<seedfile filename="modeltemplate.sldprt" type="template" default="yes"
extension_filter="*.sldprt">
<description language="EN" text="Standard part"/>
</seedfile>
<primary_application primary_workstation_application="SWP"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 60 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines which template definition should be integrated into this definition.
include_template "SLWMDL"
"SLWMDL" = The DType template with the ID "SLWMDL" from this "DType.xml"
file will be included. This is the generic definition.
Designates the application that is relevant for this document (Work Station
Application). This application opens the file from SAP engineering control
application_type "SLW" center.
The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP
Engineering Control Center. It also includes the sub-element <icondef>.
The sub-element <document_create> determines the way in which the document is created in SAP.
sub-element <seedfile> contains settings for the template file. Several template files can be assigned, i.e. the
<seedfile> may occur more than once. This includes the sub-element <description>, which defines each
CIDEON Software & Services GmbH & Co. KG Page 61 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
description text in different languages.
The sub-element<primary_application> determines which application is relevant for this master document
(primary application) and defines the rules for the checking in and out of the originals.
CIDEON Software & Services GmbH & Co. KG Page 62 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the sub-element<primary_application>
Attribute Value Description
"SWP" = Identification of the SAP workstation application for
primary_workstation_application "SWP"
SOLIDWORKS parts.
The sub-element <allowed_nonmaster> defines a certain document type, allowed as a nonmaster document.
Standard Parts from component libraries such as the SOLIDWORKS toolbox are aggregated and managed
under the document type "SWN", this being applicable for SOLIDWORKS Parts as well as for assemblies, insofar
as they function as standard parts. In that sense the DType definition for master documents of the type
SOLIDWORKS Standard Part organized under DType definitions for parts ("SWP") as standard parts and
modules ("SWA") as standard parts. The description of the DType definition for parts as standard part ("SWN"):
DType definition for master documents of the type "SWN" for SOLIDWORKS parts
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_part_$(FAMILY)16"/>
</icon>
<document_create document_type="SWN" document_number_assignment="internal"
rename_template_filename="no" change_to_after_create_status="AA">
CIDEON Software & Services GmbH & Co. KG Page 63 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Non-ambiguous ID string of this DType-definition in the entire XML document.
The ID has to be between one to five characters long.
identifier "SWNPR"
"SWNPR" = ID of this DType definition.
Determines which template definition should be integrated into this definition.
include_template "SLWMDL"
"SLWMDL" = The DType template with the ID "SLWMDL" 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 "SLW" Center.
the sub-element<icon> defines an acronym that will be used when determining the applicable symbol in SAP
Engineering Control Center. In addition it includes the sub-element <icondef>.
CIDEON Software & Services GmbH & Co. KG Page 64 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines whether, for the document attachment, the file name
of the original is renamed according to the established naming
rules or if the file name of the template file is assumed
rename_template_filename "no"
unchanged.
The sub-element <seedfile> contains settings of the template file. Several template files can be assigned, i.e.
<seedfile> may occur more than once. This includes the sub-element <description>, which defines each
description text in different languages.
The sub-element<primary_application> determines which application is relevant for this master document
(primary application) and defines the rules for the checking in and out of the originals.
CIDEON Software & Services GmbH & Co. KG Page 65 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Specifies the maximal number of nonmaster documents.
max_count "99"
"99" = Maximal number of nonmaster documents.
Now the DType definition for SOLIDWORKS assemblies ("SWA") as master document:
DType definition for master documents of the type "SWA" for SOLIDWORKS
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_assembly_$(FAMILY)16"/>
</icon>
<document_create document_type="SWA" document_number_assignment="internal"
rename_template_filename="yes">
<seedfile filename="modeltemplate.sldasm" type="template" default="yes"
extension_filter="*.sldasm">
<description language="EN" text="Standard assembly"/>
</seedfile>
<primary_application primary_workstation_application="SWA"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 66 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP
Engineering Control Center. In addition it includes the sub-element <icondef>.
The sub-element <seedfile> contains settings for the template file. Several template files can be assigned,
d.h. <seedfile> may occur more than once. This includes the sub-element <description>, which defines each
description text in different languages.
CIDEON Software & Services GmbH & Co. KG Page 67 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Determines how the original document will be generated.
type "template"
"template" = the attribute "filename" specifies the template file to
be used.
This determines whether the template file is preset in the dialog
"Create document".
default "yes"
"yes" = This template file is preset.
When selecting a template file with the type="select" this attribute
defines the filter for the file extension. In the file selection dialog
extension_filter "*.sldasm" you can select files that are matched by the filter.
the sub-element <primary_application> determines which application is relevant for this master document
(primary application) and defines the rules of this checking in and out of the originals.
The sub-element <allowed_nonmaster> defines a specific document type allowed as nonmaster document.
CIDEON Software & Services GmbH & Co. KG Page 68 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Specifies the DType allowed as nonmaster document.
DType "NSWDR"
"NSWDR" = DType.
Specifies the maximal number of possible nonmasterdocuments.
max_count "99"
"99" = Maximal number of nonmaster documents.
A description of the DType definition for SOLIDWORKS assemblies as standard parts ("SWN") follows:
DType definition for master documents of the type "SWN" for SOLIDWORKS assemblies
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_assembly_$(FAMILY)16"/>
</icon>
<document_create document_type="SWN" document_number_assignment="internal"
rename_template_filename="no">
<primary_application primary_workstation_application="SWN"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 69 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
the sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP
Engineering Control Center. In addition it includes the sub-element <icondef>.
The sub-element <document_create> determines settings, how the document is created in the SAP.
The sub-element <seedfile> contains settings for the template file. Several template files can be assigned, i.e.
<seedfile> may occur more than once. This includes the sub-element;description>, which defines each
description text in different languages.
CIDEON Software & Services GmbH & Co. KG Page 70 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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
extension_filter "*.sldasm" files that are matched by the filter.
The sub-element <primary_application> determines which application is relevant for this master document
(primary application) and defines the rules for the checking in and out of the originals.
the sub-element <allowed_nonmaster> defines a specific document type which is allowed as nonmaster
document.
DType definition for master documents of the type "SWD" for SOLIDWORKS
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_drawing_$(FAMILY)16"/>
</icon>
<document_create document_type="SWD" document_number_assignment="internal"
rename_template_filename="yes">
<seedfile filename="modeltemplate.slddrw" type="template" default="yes"
extension_filter="*.slddrw">
<description language="EN" text="Standard drawing"/>
</seedfile>
<primary_application primary_workstation_application="SWD"/>
</DType>
CIDEON Software & Services GmbH & Co. KG Page 71 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Attributes of the element <DType> of the definition "MSWDR"
Attribute Value Description
Determines the type of the DType definition.
type "master"
"master" = It’s a matter of a DType definition for master documents.
Non-ambiguous ID string of this DType-definition in the entire XML document.
The ID has to be between one to five characters long.
identifier "MSWDR"
"MSWDR" = ID of this DType definition.
Determines, which template definition iis implied in this definition.
include_template "SLWDRW" "SLWDRW" = The DType template with the ID "SLWDRW" from this
"DType.xml" file is being included. This is the generic definition for
SOLIDWORKS drawings.
Designates the application that is relevant for this document (Work Station
Application). This application opens the file from the SAP Engineering Control
application_type "SLW" Center.
The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP
Engineering Control Center. In addition it includes the sub-element <icondef>.
the sub-element <document_create> determines, how the document is created in the SAP.
CIDEON Software & Services GmbH & Co. KG Page 72 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Defines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = SAP automatically assigns the number.
Determines whether, for the document attachment, the file name
of the original is renamed according to the established naming
rules or if the file name of the template file is assumed
rename_template_filename "yes" unchanged.
The sub-element <seedfile> contains the settings for the template file. Several of template files can be
assigned, i.e. <seedfile> may occur more than once. This includes the sub-element <description> which
defines each description text in different languages.
CIDEON Software & Services GmbH & Co. KG Page 73 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
It can determine whether this template file is preset in the dialog
"Create document".
default "no"
"no" = This template file has not been preset.
When selecting a template file with the type="select" this attribute
determines the file extension filter that is used. In the file selection
extension_filter "*.slddrw" dialog you can select files that are matched by the filter.
The sub-element <primary_application> designates the application which is relevant for this master document
(primary application) and defines the rules for the checking in and out of the originals.
The SAP Engineering Control Center distinguishes between master documents and dependent documents. The
latter are designated nonmaster documents and are assigned to their master document.
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 is the DType definition of the nonmaster documents for SOLIDWORKS for the type "SDN" nonmaster:
CIDEON Software & Services GmbH & Co. KG Page 74 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
DType definition for nonmaster documents for SOLIDWORKS
<icon>
<icondef icon_position="1" icon_group="default"
icon_identifier="tree/slw/solidworks_drawing_16"/>
</icon>
<document_create document_type="SDN" rename_template_filename="yes">
<seedfile filename="modeltemplate.slddrw" type="template" default="yes"
extension_filter="*.slddrw">
<description language="EN" text="Standard drawing"/>
</seedfile>
<seedfile filename="modeltemplate.slddrw" type="select" default="no"
extension_filter="*.slddrw">
<description language="EN" text="select existing drawing"/>
</seedfile>
</document_create>
<primary_application primary_workstation_application="SWD"/>
</DType>
include_template "SLWDRW" "SLWDRW" = The DType template with the "SLWDRW" identification from this
"dtype.xml" file will be included. This is the generic definition for SOLIDWORKS
drawings.
Designation for the application that is relevant for this document (Workstation
Application). This application opens the file from the SAP Engineering Control
application_type "SLW" Center.
The <icon> sub-element defines an abbreviation that will be used when determining the applicable symbol in
the SAP Engineering Control Center. It also comprises the <icondef> sub-element.
CIDEON Software & Services GmbH & Co. KG Page 75 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Position of the symbol within the document entry
in the tree.
icon_position "1"
"1" = far left, "6" = 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 comprises
the applicable symbol for this symbol position.
icon_identifier "tree/slw/solidworks_drawing_$(FAMILY)16"
"tree/slw/solidworks_drawing_$(FAMILY)16" =
The icon-file.
The <document_create> sub-element determines the way in which the document is created in SAP.
The <seedfile> sub-element comprises settings for the template file. Several template files can be assigned,
i.e. the <seedfile> may occur more than once. This comprises the <description> sub-element, which defines
each description text in different languages.
CIDEON Software & Services GmbH & Co. KG Page 76 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
When selecting a template file with type="select", this attribute
defines the file extension filter that is used. In the file selection
dialog, the files that are matched by the filter will be offered for
extension_filter "*.slddrw"
selection.
The <primary_application> sub-element determines which application is assigned to this master document
(primary application) and defines the rules for the checking in and out of the originals.
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.
CIDEON Software & Services GmbH & Co. KG Page 77 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
ECTR menu "Settings"
There you will find setting options referring to interaction between dem 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 safed under "user.txt" for every user in their
specific ECTR work directory, under the sub-menue "preferences" (the exact path:
"%APPDATA%\SAP\ECTR\data\<<ECTR-Version>>\<<SAP-Server_Mandant_Username>>\preferences\user.txt").
CIDEON Software & Services GmbH & Co. KG Page 78 of 102 2019-12-05
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.
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:
<node label="SOLIDWORKS">
<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="...">
CIDEON Software & Services GmbH & Co. KG Page 79 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
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.
The sub-element <option> defines always 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 and SAP Engineering Control Center Interface to SOLIDWORKS after launch. As this
deals with a traditional batch file, command line instructions such as "set" and "if" can also be used here, as
CIDEON Software & Services GmbH & Co. KG Page 80 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
well as contents of already existing environment variables, with the notation "%<<Variable name>>%".
NOTE:
As the SAP Engineering Control Center Interface to SOLIDWORKS do not require any special
environment variables but the SAP Engineering Control Center does expect a CAD-specific
file "plm_setenv.bat", and this file does not contain any definitions of environment variables after
installation, and is therefore empty!
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 SOLIDWORKS 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 SOLIDWORKS 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:
/DSCSAG/MM_GETNONMASTER2
/DSCSAG/DOC_BOM_MAINTAIN3_MULT
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.
connector-macro-whitelist.txt
The configuration file "connector-macro-whitelist.txt" contains the names of all macro definition files that can
be called from the SAP Engineering Control Center Interface to SOLIDWORKS. This means that macro definition
files that are not listed here will not be called.
The specification of the application type (e.g. "SLW") is essential for the ECTR to access the
corresponding application directory!
All listed macro definition files must be located in the directory
"%PLM_INSTDIR%\applications\<Application>\customize\scripts\macros"!
slw:get_related_drawings.txt
slw:map_attributes.txt
CIDEON Software & Services GmbH & Co. KG Page 81 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version information
To gain an overview of the imported changes of the relevant releases of the SAP Engineering Control Center
Interface to SOLIDWORKS, 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.
CIDEON Software & Services GmbH & Co. KG Page 82 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
plm.options.bom.UsePrefixAsCategory.SLW
plm.options.thumbnailFilename.insertPreview.SLW
plm.options.Thumbnail.SLW.jpg.<preference>
plm.structure.application.UsePlmObjectContent.SLW
02.17.74.00
structure.view.SLW.generic.object.type
structure.view.SLW.generic.object.SLW_VIRTUAL_NEW.name
structure.view.SLW.generic.object.SLW_VIRTUAL.name
plm.options.handlingOfVirtualComponents.SLW
02.16.73.00 plm.structure.application.AdditionalAttributes.SLW
02.15.69.00 plm.options.thumbnailFilename.insertPreview.SLW
plm.options.ChildComponentDisplayInBOM.Show.DissolveAssembly.SLW
plm.options.ConsiderChildComponentDisplayInBOM.LoadDocument.SLW
02.15.68.00
plm.options.ImportOnDemand.DeleteOriginals.SLW
plm.options.ImportOnDemand.CheckInAfterCreate.SLW
02.14.68.00 plm.control.partnameRules.applExtension.SLW
plm.options.checkIn.UpdateAttributesFromSAP.SLW
plm.options.BOMTable.AddNonExistingColumns.SLW
02.14.65.00 plm.options.BOMTable.Column.SLW.[CAD_COLUMN]
plm.options.Ballooning.BalloonContent.SLW
plm.options.SaveAsNewDocument.Replace.SLW
02.13.64.00 plm.structure.application.DisplaySuppressedComponents.SLW
plm.execute.additional.SLW
02.12.62.00
plm.options.ActionWhenVirtualComponentWithReferencesToRealComponentsFound.SLW
plm.convert.additional.SLW
plm.options.MissingReferenceReloadOption.SLW
02.12.61.00
plm.options.ChangeFeatureTreeDisplayOnlyForWritableDocuments.SLW
plm.options.CreateDirDialogForVirtualComponent.SLW
02.11.59.00 plm.options.SuppressAlwaysSaveAsDialogForReadOnlyConvertedDocuments.SLW
02.10.55.00 plm.options.CreateDirDialogForDefeature.SLW
02.09.50.00 plm.library.SLW.<library name>
02.09.49.00 plm.options.CreateDirDuringMakeDrawingOrAssemblyFromPartOrAssembly.SLW
plm.options.DeselectCADOptionForPromptToSaveReadOnlyDocuments.SLW
02.09.48.00
plm.options.checkIn.DeselectCADOptionForPromptToSaveReadOnlyDocuments.SLW
02.09.46.00 plm.options.DeliverSpecificSheetProperties.SLW
plm.options.DeliverPhysicalPropertiesInDocumentUnit.SLW
plm.convert.additional.SLW
02.08.43.00 plm.options.structureAnalyze.cacheDocumentKeysUsedForInstanceIDs.SLW
plm.options.ApplicationStructure.AdditionalAttributes.SLW
plm.options.ApplicationStructure.CollectEntries.SLW
plm.options.checkIn.AbortAnalysisOfCheckedInComponents.SLW
plm.options.checkIn.DeselectCADOptionForPromptToSaveReadOnlyDocuments.SLW
plm.options.excludeFromBOM.LoadComponentsToReadChildComponentDisplayInBOM.SLW
02.07.39.00
plm.options.new.SaveActiveDocument.SLW
plm.options.ApplicationStructure.DisplayAdditionalAttributes.SLW
plm.options.ShowComponentNameAndOrDescriptionInFeatureTree.SLW
02.07.37.00 plm.options.importOnDemand.loadResolvedForSave.SLW
plm.option.ActiveConfigurationOnly.SLW
02.06.36.00 plm.options.maximumNumberOfGDIObjects.SLW
plm.options.structureAnalyze.showDialogForMissingReferences.SLW
CIDEON Software & Services GmbH & Co. KG Page 83 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Version Status Parameter
plm.options.SapOpenForLoadDrawing.SLW
02.05.32.00
plm.options.new.SaveActiveDocument.SLW
plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW
plm.options.importOnDemand.updateAttributes.SLW
plm.options.save.updatePhysicalPropertiesDuringSave.SLW
02.04.29.00
plm.loadoptions.SLW.DocumentLoadMode
plm.options.SapOpenForCadPlaceDocument.SLW
plm.structure.application.init.strategy.levels.SLW
plm.options.import.standardPart.dark.SLW
02.03.25.00
plm.options.SapOpenForCadOpenDocument.SLW
plm.document.dtype.ToolboxPart.SLW
plm.options.importOnDemand.loadDrawings.SLW
plm.options.save.loadDrawings.SLW
02.02.23.00 plm.options.save.saveExternalReferences.SLW
plm.options.ApplicationStructure.HideStructureOfSpeedPaks.SLW
plm.structure.application.sendInstancesForGeneric.SLW
plm.structure.application
plm.options.ApplicationStructure.CollectEntries.SLW
02.01.21.00 plm.options.ApplicationStructure.DisplayAdditionalAttributes.SLW
plm.options.ApplicationStructure.AdditionalAttributes.SLW
01.03.18.00 plm.document.SaveAsNewDocument.CheckOutTop.SLW
plm.options.CreateDIRForNewDocument.SLW
01.00.14.00
plm.options.importOnDemand.updateAttributes.SLW
02.09.52.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.07.37.00
of DTypes and Seedfiles. All elements <description language="XY"> are omitted except English
which are used as fallback.
CIDEON Software & Services GmbH & Co. KG Page 84 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Configuration examples
In the following chapter, various configuration options in the ECTR environment are presented using process-
related examples based on the SOLIDWORKS interface. The intention is to illustrate how the various
requirements can be implemented. This chapter should be used just as an aid. The values to be configured are
described using placeholders and should be replaced, in actual use, according to customer requirements.
Since the information displayed in the message window may be quite extensive and can change quickly, this
can be perceived as annoying. Therefore it is possible to display only the message "Please wait..." instead.
For this the environment variable "USE_SIMPLE_DIALOG" must be set to the value "true":
CIDEON Software & Services GmbH & Co. KG Page 85 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Set environment variable
If the original message window has to be displayed again, the environment variable "USE_SIMPLE_DIALOG"
must be set to "false" or completely deleted.
After setting or deleting the environment variable, SOLIDWORKS and ECTR must be restarted!
The configuration itself can be made in the files "attributes-to-sap.xml" and "attributes-from-sap.xml". A
detailed description of the structure of these files can be found in the corresponding section "attributes-from-
sap.xml and attributes-to-sap.xml".
On the part of the SAP Engineering Control Center Interface to SOLIDWORKS, two so-called "metainf" XML files
are provided in the user working directory, specifically in the subfolder of the appropriate document info
record. The file "plm_metainf-cad.xml" contains all properties from the CAD and the file "plm_metainf-sap.xml"
contains all properties transferred through SAP with current values. If the file "plm_metainf-cad.xml" doesn't
contain all data, you need to check the parameters described in section "Available properties" that are used
for all properties and not only for the requested ones.
CIDEON Software & Services GmbH & Co. KG Page 86 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Path of "metainf" files
Example of a "plm_metainf-cad.xml"
CIDEON Software & Services GmbH & Co. KG Page 87 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Please note that material-specific properties in SOLIDWORKS can be read and written to the
desired SAP field. However, these properties are firmly defined in SOLIDWORKS and therefore
should not be overridden by values from SAP!
Available properties
If the properties are not listed in the following table, all properties transferred with the current settings can be
read from the log files. For this to be possible, the following radio buttons must be changed in the file
"default.txt":
plm.options.deliverOnlyRequestedAttributesToSAP.SLW
This parameter must be set to "false" further on. After that, all available parameters can be read in the user
directory of the ECTR. Please note that drawings, components and assemblies all have different characteristics
and thus the related subfolders must be checked for all document types. The specific log files are written in
subfolders with the name of the document and include all properties that are available for a document. The
file "plm_metainf-cad.xml" must be checked for properties that should be transferred to SAP from
SOLIDWORKS . The file "plm_metainf-sap.xml" must be checked for all information read from SAP. An
appropriate block for an attribute in this file has the following structure:
<ATTRIBUTE NAME="DP-SW_Last_Saved_Version">
<VALUE>SOLIDWORKS 2016</VALUE>
</ATTRIBUTE>
The attribute name in the configuration files can be used here to map the properties. The properties that are
not available for all documents are listed only in these associated XML files. This function should be changed
only during the configuration and should be set to "true" after the successful setting of desired parameters in
order to avoid an unnecessary overhead during data transfer.
CIDEON Software & Services GmbH & Co. KG Page 88 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
PP-Weight Material weight
PP-WeightUnit Weight unit used
PP-CenterOfMassX
PP-CenterOfMassY Coordinates of the center of mass
PP-CenterOfMassZ
PP-MomXX
PP-MomXY
PP-MomYY
Main axes of inertia
PP-MomYZ
PP-MomZZ
PP-MomZX
Properties of a drawing Description
DP-Sheetsize Format of sheets in a drawing
DP-Sheets Number of sheets in a drawing
General document properties Description
DP-SW_Last_Saved_Version SOLIDWORKS version used when saved last
DP-SW_Lastest_Version Version information of the installed SOLIDWORKS version
DSI-SumInfoAuthor Author of the document
DSI-SumInfoComment Comment in the file information
DSI-SumInfoSubject Subject in the file information
DSI-SumInfoTitle Title in the file information
DSI-SumInfoKeywords Keywords in the file information
DSI-SumInfoCreateDate Creation date
DSI-SumInfoSaveDate Date of the last save operation
DSI-SumInfoSavedBy User that saved the document last
When transferring properties from SAP objects to SOLIDWORKS document properties please note that some
properties cannot be changed and therefore cannot be overwritten in this direction. These include all material
properties, the properties of a drawing and the following document properties:
DP-SW_Last_Saved_Version
DP-SW_Lastest_Version
DSI-SumInfoCreateDate
DSI-SumInfoSaveDate
DSI-SumInfoSavedBy
Within SOLIDWORKS, it is possible to create different user-defined properties. All newly defined property
names can also be found in the configuration files "attributes-to-sap.xml" and "attributes-from-sap.xml" be
used. If user-defined properties are not present in the concrete document, all mapping instructions are
ignored.
The following example shows the definition of a new addition property, which is written in the corresponding
document classification, then changed from the SAP object and loaded in a modified form in the CAD.
CIDEON Software & Services GmbH & Co. KG Page 89 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Property in SOLIDWORKS
Customised properties can be found in the SOLIDWORKS, document-related, via the menu item
"File\Properties" can be achieved. To define a new property, an entry can be inserted within the table.
Properties transferred from SAP that have not yet been created are created automatically.
Menu Item
CIDEON Software & Services GmbH & Co. KG Page 90 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Summary Information
To be able to transfer the new property to SAP, the "attributes-to-sap.xml" Can be configured accordingly. In
the example, a mapping is listed in an SAP document class. The property previously defined in the
SOLIDWORKS is shown in the following example "CAD_Eigenschaft" respectively.
<DIR_CLS
class="[SAP-classname]"
classtype="[SAP-classtype]"
characteristic="[SAP-characteristic]">
<APPL_ATTRIBUTE name="CAD_Attribute" />
</DIR_CLS>
To transfer a value from SAP to a SOLIDWORKS property, the "attributes-from-sap.xml" can be configured
accordingly. In the following example, "CAD_Eigenschaft" for the SOLIDWORKS attribute.
<APPL_ATTRIBUTE
name="CAD_Eigenschaft"
hidden="false">
<DIR_CLS
class="[SAP-classname]"
classtype="[SAP-classtype]"
characteristic="[SAP-characteristic]"/>
</APPL_ATTRIBTUE>
If the document is now stored in SOLIDWORKS, via the functions of the ECTR interface, the properties are
transferred to SAP. Transferring the values from SAP to SOLIDWORKS takes place when you open it for editing
CIDEON Software & Services GmbH & Co. KG Page 91 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
or via the menu entry "SAP PLM\Attribute update".
Material-specific mapping
plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW
It should also be noted that when variant-independent mapping is activated, material properties cannot be
written in the document class. For this case, the mapping methodology must be altered or a definite user-
defined property must be created for the document in SOLIDWORKS, which is valid for the document in
general and not just for a specific configuration.
Variant-independent
It is possible to write attributes from SOLIDWORKS into SAP objects, without taking different configurations into
CIDEON Software & Services GmbH & Co. KG Page 92 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
account. To do this, the following parameters must be set:
plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW = false
If no configurations have been created (for example, only a standard configuration exists), this option can still
be used. With variant-independent mapping, it is not necessary to create material links to existing
configurations. They are not taken into account in this case. Only the document, the document class and the
related properties of the material marked as exclusive to the document and its material class are used.
Material-specific data are defined as in the following example.
"PP-WeightUnit" can be replaced here by any property available in SOLIDWORKS. The user-defined properties
created in the file information can be configured this way. Configuration specific properties are not taken into
account when using variant-independent mapping, and cannot be accessed.
Another difference from variant-dependent mapping is that it is possible to write material properties in a
document class. The reason for this is the unambiguous assignment of a material to a document.
Variant-specific
Should variant-specific data be transferred, the following parameter must be set in "default.txt".
plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW = true
All material properties or user-defined variant-specific properties must have "$(variant)-" as a prefix so that
they can be transferred to the correct configurations in the ECTR. A corresponding mapping in the
configuration file "attributes-to-sap.xml" is defined as follows.
CIDEON Software & Services GmbH & Co. KG Page 93 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Example for variant-specific mapping of the weight unit
in the corresponding SAP field of a material
The weight unit can also be written in the material class of the material.
"PP-WeightUnit" can be replaced by any property available in SOLIDWORKS here. User-defined properties
defined in the file information can be configured the same way.
Please note that variant-specific properties cannot be written into document classes. If such properties should
be transferred into document classes, you must create custom variant-independent properties in the
SOLIDWORKS file data for this purpose. All variant-independent document attributes (e.g., editor, CAD
version, creation date or user-defined properties) will further be specified without the aforementioned prefix
"$(variant)-" .
Variant-specific data can only be transferred from SAP to SOLIDWORKS by using a BAdI extension
and is otherwise not supported.
Configuration in ECTR
You can create the materials or link the already existing materials using the context menu functions for the
document. An existing material can be stored directly within the document info record in the "Object Links"
tab.
CIDEON Software & Services GmbH & Co. KG Page 94 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
CIDEON Software & Services GmbH & Co. KG Page 95 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Creating materials by using the ECTR context menu
Material links are displayed in the ECTR with a material symbol. An existing material link can also be tested in
the "Object Browser" when selecting a document.
CIDEON Software & Services GmbH & Co. KG Page 96 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Material link to documents available
CIDEON Software & Services GmbH & Co. KG Page 97 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Material linking in the ECTR "Object Browser"
If you want to transfer values to a class of materials, these must be already assigned to the material. If the
classification is missing, no data can be written. This is true also for document classes.
CIDEON Software & Services GmbH & Co. KG Page 98 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
The material has a material class
As the last step, the linked materials need to be assigned to the appropriate configurations. This can be done
by a simple "Drag & Drop".
CIDEON Software & Services GmbH & Co. KG Page 99 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Adding material link for a configuration
This action must be repeated for multiple configurations. At the end, the document in the ECTR should have
the following structure. Each configuration will have a correspondingly linked material. Under these conditions,
material properties can be transferred depending on the variant.
CIDEON Software & Services GmbH & Co. KG Page 100 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com
Fully configured component in the "Desktop" window
Even if only the standard/default CAD variant is available, it is necessary to link the material with
the variant when configuring the variant-specific mapping. Otherwise, no properties can be
transferred.
CIDEON Software & Services GmbH & Co. KG Page 101 of 102 2019-12-05
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.
www.cideon.de
Copyright (C) 2019 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 102 of 102 2019-12-05
Peterstrasse 1 : D-02826 Goerlitz
Web: https://www.cideon.com