0% found this document useful (0 votes)
1K views102 pages

CIDEON ECTR Interface To SolidWorks Configuration Manual PDF

Uploaded by

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

CIDEON ECTR Interface To SolidWorks Configuration Manual PDF

Uploaded by

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

Configuration manual

Management of CAD data and documents in SAP

SAP Engineering Control Center Interface to


SOLIDWORKS

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 directory "appdata"

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.

The directory "basis"

Here, the following directories are included:

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

The directory "documentation"

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

The directories "templates" and "template-templates"

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.

The directory "customize\config"

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.

The directory "customize\scripts"

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

The directory "customize\scripts\macros"

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 directory "template-customize\config"

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!

Icons for CAD originals in SAP ECTR


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

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:

Icons for SOLIDWORKS supplied as standard


Symbol Description File name in "images.jar"
SOLIDWORKS single part document
DType: Document symbol position 1
tree\slw\solidworks_part_16.png
tree/slw/solidworks_part_$(FAMILY)16 with
$(FAMILY) = <leer>
SOLIDWORKS assembly document
DType: Document symbol position 1
tree\slw\solidworks_assembly_16.png
tree/slw/solidworks_assembly_$(FAMILY)16 with
$(FAMILY) = <leer>
SOLIDWORKS drawing master document
DType: Document symbol position 1 tree\slw\solidworks_drawing_16.png
tree/slw/solidworks_drawing_16
Replacement is done in file "standard_icons.txt".
SOLIDWORKS drawing dependent document
tree/slw/solidworks_drawing_160 =
(Document is up-to-date compared to the master)
tree/slw/solidworks_drawing_16
DType: Document symbol position 1
Thus the file
tree/slw/solidworks_drawing_16$(NM_OLD) with
"tree\slw\solidworks_drawing_16.png" from the
$(NM_OLD)= 0
archive "images. jar" is used.
Replacement is done in file "standard_icons.txt".
tree/slw/solidworks_drawing_161 =
SOLIDWORKS drawing dependent document tree/slw/solidworks_drawing_16
(Document is outdated compared to the master) <<{0}/sap/o_outdated
DType: Document symbol position 1 The file
tree/slw/solidworks_drawing_16$(NM_OLD) with "tree\slw\slw\solidworks_drawing_16.png" is
$(NM_OLD)= 1 overlaid with {0}\sap\o_outdated.
{0} stands for the size. Possible values are
small, medium, large.
SOLIDWORKS document - single part
tree\file\obr_tree_file_swp.png
Workstation Application SWP
SOLIDWORKS document – assembly
tree\file\obr_tree_file_swa.png
Workstation Application SWA
SOLIDWORKS document – drawing
tree\file\obr_tree_file_swd.png
Workstation Application SWD

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

Manual installation of SAP Engineering Control Center


Interface to SOLIDWORKS
Integration of SAP Engineering Control Center Interface to SOLIDWORKS in the user interface of SOLIDWORKS
happens during the automatic installation without the requirement of the interference of user. Prerequisite for
a manual installation is the availability of file "CdnEctrInterfaceSWx64.zip" Manual instillationis executed as
follows:

Unpack the content of the file "CdnEctrInterfaceSWx64.zip" completely as


per %PLM_INSTDIR%\applications\slw\basis\sys\win\bin.
Register the module "CdnECTRInterfaceSWx_64.dll" with the Microsoft tool "regsvr32.exe".
Start the SOLIDWORKS and search in the dialog "additional applications" as per the entry "SAP
Engineering Control Center Interface to SOLIDWORKS" and activate both corresponding control check
boxes. If this entry should not be available, end the SOLIDWORKS and execute the registration of
"CdnEctrInterfaceSWx64.zip" again.

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).

Starting SOLIDWORKS from ECTR in the SAP logon language


After its start, the SAP Engineering Control Center sets the environment variable "%PLM_LANGUAGE%" to the
SAP logon language. Their purpose is to be evaluated by other processes so that the CAD system to be started
appears in the corresponding language.
However, SOLIDWORKS does not support this!
Unfortunately, there is currently no possibility to realize this technically. SOLIDWORKS is therefore always
started in the currently configurated language.

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.

Construction of a menu definition

Each individual menu definition begins with a plus sign ('+') in the first column of the line, followed by
the menu identification.
The individual functions that appear in the menu are arranged one after the other, in which each menu
function is preceded by an equal sign ('=').
In each menu definition, macros, which are defined in the file "menu_macros.txt" or in the general
macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt", are referenced by their

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.

Definition of the context menu for cloning

A context menu is provided for the "Clone" functionality of the SAP Engineering Control Center. Its range of
functions are defined using the parameters "om.popup.menu.CLONEPOS.DOC_SLWMDL" (for SOLIDWORKS
models) and "om.popup.menu.CLONEPOS.DOC_SLWDRW" (for SOLIDWORKS drawings):

Definition of the context menu for "Cloning"

###############################################################################
# SOLIDWORKS Cloning Menu
+ om.popup.menu.CLONEPOS.DOC_SLWMDL = ? DOCUMENT_SLW_GENERAL_CLONING

+ om.popup.menu.CLONEPOS.DOC_SLWDRW = ? DOCUMENT_SLW_GENERAL_CLONING

The macro "DOCUMENT_SLW_GENERAL_CLONING" defined in the file "menu_macros.txt" is used, which


defines the scope of functions:

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

? 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

The following functions are possible:

Possible functions in the context menu for "Cloning"


Parameter Function
fnc.doc.clone.option.NO_ACTION "No Action"
fnc.doc.clone.option.NEWINTNR_OPTION "New internal Number"
fnc.doc.clone.option.NEWEXTNR_OPTION "Extended Clon Options"
fnc.doc.clone.option.INSERT_OPTION "Add Component"
fnc.doc.clone.option.REPLACE_OPTION "Replace Component"
fnc.doc.clone.option.DELETE_OPTION "Delete Component"
fnc.doc.clone.option.NEWVERS_OPTION "New Version"
fnc.doc.clone.option.CHANGE_OPTION "Change Details"

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."

Structure of a macro definition

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

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

attributes-from-sap.xml and attributes-to-sap.xml


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

For more information on this topic, see the file "Operations Guide_EN.pdf", chapter: "Attribute
Transfer Between the SAP System and an Application", which is part of the ECTR documentation.

Diverse attribute mappings are included in the general configuration files

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".

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

attributes-from-sap.xml

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

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".

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


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

CIDEON Software & Services GmbH & Co. KG Page 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>

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

Attribute of element <section>


Attribute Values Description
Name of
DTypes are referenced to this attribute segment with this name in the
name="..." attribute
file "dtypes.xml".
division
Name of
section: Determines which section will be included from the global "attributes-
include_section="..." "STANDARD", from-sap.xml" file (%PLM_INSTDIR%/customize/config/attributes-from-
"STDMOD" or sap.xml) in the section defined here.
"default"
Description of
description="..." attribute This is a comprehensive description of an attribute section.
sections

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

Attributes of the sub-element <APPL_ATTRIBUTE>


Attribute Values Description
name="..." Attribute name Document-side name of the attribute.
Determines whether this is a helper attribute ("true") or a regular document
hidden="..." true, false
attribute ("false").

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

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.

Attributes of subelements <DIR> and <MA>


Attribute Values Description
Name of a field in SAP from which the value for the attribute should be read
out.

field="..." Field Name ATTENTION:


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

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

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

Example for subelement <CUTLEADING>

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

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

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

Example for subelement <XFORMAT>

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

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

Both subelements can be combined:

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

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

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

CIDEON Software & Services GmbH & Co. KG Page 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.

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

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

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

Attribute of element <section>


Attribute Values Description
Name of DTypes are referenced to this attribute section with this name in the
name="..."
attribute section file "dtypes.xml".
Name of the
section: Specifies which section from the global file
include_section="..." "STANDARD", "%PLM_INSTDIR%/customize/config/attributes-to-sap.xml" is to be
"STDMOD", included in the section defined here.
"default", etc.
Description of
description="..." attribute This is a comprehensive description of an attribute section.
sections

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

Attributes of subelements <DIR> and <MA>


Attribute Values Description

CIDEON Software & Services GmbH & Co. KG Page 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.

field="..." Field Name ATTENTION:


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

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

Attributes of the sub-element <APPL_ATTRIBUTE>


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

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"!

Mapping of filenames and folder names

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:

DSI-SumInfoFileName (file name without extension)


DSI-SumInfoFileNameWithExt (file name with extension)
DSI-SumInfoFolderName (directory of the file)

Mapping virtual components (DMUCAD data)

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

In the file "attributes-to-sap.xml" an attribute section can be defined:

Attribute section for mapping virtual components

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

The following categories of properties exist:

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

Overview of SOLIDWORKS properties

Category: Document properties


Prefix: DP-

SOLIDWORKS Document properties


Example
Name ReadOnly property Comment
value
SOLIDWORKS
DP-SW_Last_Saved_Version X
2018
DP-SW_Latest_Version X 11000[2018/1] Technical version
For drawings only. Can also be read sheet-
specifically.
DP-Height X 0,841
Example:
DP-Height#<Sheet-Name> --> "DP-
Height#Sheet1"
For drawings only. Can also be read sheet-
specifically and viewspecific.
DP-Scale1 X 2
Example:
DP-Scale1#<Sheet-Name>[<View-Name>] -->
"DP-Scale1#Blatt1[Drawing View1]"
For drawings only. Can also be read sheet-
specifically and viewspecific.
DP-Scale2 X 1
Example:
DP-Scale2#<Sheet-Name>[<View-Name>] -->
"DP-Scale2#Blatt1[Drawing View1]"
DP-Sheets X 1 Number of sheets. For drawings only.
DP-Sheetsize X A0 For drawings only
For drawings only. Can also be read sheet-
specifically.
DP-Width X 1,189
Example:
DP-Width#<Sheet-Name> --> "DP-
Width#Sheet1"

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-

SOLIDWORKS Document summary information properties


Name ReadOnly Example property value Comment
DSI-SumInfoAuthor
DSI-SumInfoComment
DSI-SumInfoCreateDate X Donnerstag, 1. Juni 2017 10:11:34
DSI-SumInfoFileName X 1000075307sdn000
DSI-SumInfoFileNameWithExt X 1000075307sdn000.SLDDRW
DSI-SumInfoFolderName X c:\users\max.mustermann\appdata\roaming\sap\ectr\filespace\ectr51\q18_202_zz14stra\sess\zz14stra\
DSI-SumInfoKeywords
DSI-SumInfoSaveDate X Freitag, 15. Juni 2018 10:44:38
DSI-SumInfoSavedBy X max.mustermann
DSI-SumInfoSubject
DSI-SumInfoTitle

Category: Custom properties (user defined properties)


Prefix: None or UDP-

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"

Category: Configuration specific custom properties


Prefix: None or UDP-

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!

Category: Physical properties


Prefix: PP-

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"

The parameter "plm.options.deliverPhysicalPropertiesConfigurationSpecific.SLW" in the


configuration file "default.txt" can be used to determine whether the physical properties of the
configuration with the specified ID (= true) or the active configuration (= false) are to be read.
Example:
PP-<Propertyname> --> "PP-Accuracy"

SOLIDWORKS Physical properties


Name ReadOnly Example property value Comment
PP-CenterOfMassX X 6,97026022304834E-03
PP-CenterOfMassY X 0,025
PP-CenterOfMassZ X -1,57992565055761E-03
PP-Volume X 0,000125
PP-VolumeUnit X m3
PP-Surface X 0,015
PP-SurfaceUnit X m2
PP-Weight X 0,125
PP-WeightUnit X kg
PP-Density X 1000
PP-DensityUnit X g/mm3
PP-MomXX X 5,20833333333333E-05
PP-MomYY X 5,20833333333333E-05
PP-MomZZ X 5,20833333333333E-05
PP-MomXY X -0
PP-MomZX X -7,05860789378584E-22
PP-MomYZ X -0
PP-Accuracy X 0
Only if material is
PP-Material X SOLIDWORKS Materials/AISI 1020 Steel, Cold Rolled
customized
Only if material is
PP-Material_Only X AISI 1020 Steel, Cold Rolled
customized

Deliver physical units in DocumentUnit

In SOLIDWORKS, units can be selected for specific documents:

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>".

SOLIDWORKS physical properties


Name ReadOnly Example Property Value Comment
PP-WeightInDocumentUnit X 0,125
PP-WeightUnitInDocumentUnit X kg
PP-VolumeInDocumentUnit X 0,000125
PP-VolumeUnitInDocumentUnit X m3
PP-SurfaceInDocumentUnit X 0,015
PP-SurfaceUnitInDocumentUnit X m2

Using the DocumentUnit properties in the configuration file "attribute-to-sap.xml":

<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:

Conversion factors and text values for units


Setting in SOLIDWORKS Conversion factor (from kg) Unit

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:

Parameters of the file "default.txt" for SOLIDWORKS


Parameter: plm.control.popwin.name.SLW
Name (caption text), which the main window of the workstation application identifies to bring it to the foreground. The wild
Description:
card '*' can be used to output a substring.
Name of main window of the workstation application and substring, which is a component of the window name (driven by
Values:
the wild card '*').
Default value: SOLIDWORKS 20*
Parameter: plm.adv.clone.renamerProgram.SLW
During cloning, it is necessary to rename the individual components as well as their references. This will be carried out by
an external program which must be specified here.
Description:
NOTE:
Parts enclosed by '@' are placeholders for values that are taken from the global file "default.txt".
Values: Full path of the program to be renamed
Default value: @PLM_BINDIR_SLW@\\renamer3slw.exe
Parameter: plm.document.explode.hiddenExternalReferencesSortf

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".

Description: Example: plm.cad_variant.fgroup.forVariantType.SPK = SLW_VIEW_CADVAR

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.

Example: plm.cad_variant.dgroup.forVariantType.SPK = SLW_DGROUP

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.

The parameter has the following characteristics:

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

3) Set the file extension for each additional file:


plm.convert.additional.SLW.<DOCTYPE>.<CONVERT TYPE>.extension = <File extension> Example:
plm.convert.additional.SLW.SWP.JT.extension = jt
Description:
4) Define specific options for generating each <CONVERT TYPE>:
plm.convert.additional.SLW.<CONVERT TYPE>.Options = <OPTION1>;<OPTION2>

Possible known options are:


- STL2JT: Full path to the "stltojt.exe" file of the SAPGUI installation to create "JT" files.
- KeepExtension: Sets the rule for the file name of the additional format file:
Value = true (or 'keepExtension' not defined): At filename of additional file the extension of desired file format will be
appended
Value = false: At filename of additional file the extension of the CAD file will be replaced by extension of desired file format

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.

Possible values are:


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

Example:
plm.options.Thumbnail.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":

"MATERIAL" = Internal material number


"MATERIAL_EXT" = External material number
"POSTEXT1" = Value from column "POSTEXT1"
"POSTEXT2" = Value from column "POSTEXT2"
"QUANTITY" = Value returned in return table "ET_BALLOONS", column "MENGE"
Values: "UNIT" = Value returned in return table "ET_BALLOONS", column "MEINS"
<NAME> = Value returned in return table "ET_CUSTOMER_DATA", columns which are filled in enhancement
implementation of "/DSCSAG/DOC_BALLOONING_PROVIDE"

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.

The following specifications are possible:

1.) Specifies the time of execution per document type:


plm.execute.additional.SLW.<DOCTYPE>.<EXEC TIME>

Possible options for <EXEC TIME> are:


- "BeforeCheckIn": Execute before checkin
- "BeforeCreateDocuments": Execute before import
- "AfterCheckOut": Execute after checkin
- "AfterBallooning": Execute after ballooning

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!

2.) Specifies the type of additional function:


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

Possible options for are:


- "Executable": External tool
- "CADMacro": CAD macro (VBA)
- "Powershell": Starts the Windows powershell

Example:
plm.execute.additional.SLW.SWP.BeforeCheckIn.type = Executable

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


plm.execute.additional.SLW.<DOCTYPE>.<EXEC TIME>.commandLine = [CMDLINE]
Description:
Example:
plm.execute.additional.SLW.SWA.BeforeCheckIn.commandLine = D:\\Data\\Tools\\ExternalTool.exe

NOTE:
Executables need a valid file path with escaped backslashes!
Example: "D:\\Data\\Tools\\ExtractFormat64.exe"

4.) Options for executable type "CADMacro":


plm.execute.additional.SLW.<DOCTYPE>.<EXEC TIME>.module = [Module in macro]
plm.execute.additional.SLW.<DOCTYPE1>.<EXEC TIME>.function = [Function name in module]

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"!

5.) Specifies the parameters to pass:


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

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

Parameter transfer as XML file

To set up calls to external tools or macros, the parameters plm.execute.additional.SLW exist in


the configuration file "default.txt"!

Input parameters for external applications and macros

A file "parameters.xml" is always created in the path "%TEMP%\CIDEON\Macros\<CAD-


Modulename>\<Macroname>", e.g.:

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).

The file "parameters.xml" has the following structure:

Structure of the file "parameters.xml"

<?xml version="1.0" encoding="UTF-8" ?>


<parameters>
<parameter>
<name>FUNCTION</name>
<value>main</value>
</parameter>
<parameter>
<name>MODULE</name>
<value>Testmacro1</value>
</parameter>
</parameters>

Return of macros

If a macro in this path "%TEMP%\CIDEON\Macros\<CAD module name>\<Macroname>" stores a file


"return.xml", this is evaluated by the interface. e.g.:

C:\Users\User\AppData\Local\Temp\CIDEON\Macros\CdnECTRInterfaceSWx_64.dll\TestMacro1.swp\return.xml

The file "return.xml" must have the following structure:

Structure of file "return.xml"

<?xml version="1.0" encoding="UTF-8" ?>


<return>
<code>1</code>
<message>Error 4711!</message>
</return>

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 sequence of the return messages

The evaluation of the return messages takes place in the following sequence:

1. HRESULT of executable, powershell or macro (indicator for successful execution).


2. Check if there is a file "return.xml" in "%TEMP%\CIDEON\Macros\<CAD module name>\<Macroname>"
if so, evaluate it.
3. If there is no file "return.xml", only the exit code of executable, powershell or macro is returned.

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 file "dtype.xml" has the following basic structure:

File structure of "dtype.xml"

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


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

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 definition is divided into three areas:

Generic functions (template definition)


Master document definitions
Nonmaster document definitions

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

Overview about DType definitions for SOLIDWORKS

DType-ID Type App type Description


----------------------------------------------------------------------------------------
DEFLT Template Base template from SAP/DSC
| +- SLWMDL Template SLW Base template for 3D documents (SWP/SWA/SWN)
| | +- SWPRT Master SLW 3D Part
| | +- SWNPR Master SLW 3D Standard part (not renaming) (Toolbox-Parts)
| | +- SWPAS Master SLW 3D Assembly
| | +- SWNAS Master SLW 3D Standard assembly (not renaming)
| +- SLWDRW Template SLW Base template for "2D" documents (SWD/SDN)
| +- MSWDR Master SLW Drawings as Master
| +- NSWDR NonMaster SLW Drawings as NonMaster

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

Generic DType definitions

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:

"SLWMDL" for parts and assemblies


"SLWDRW" for drawings

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

First, we will explain the definition for parts and assemblies:

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

<DType type="template" identifier="SLWMDL" include_template="DEFLT" application_type="SLW" group="SOLIDWORKS">


<description language="EN" text="SOLIDWORKS Documents"/>
<program_options show_for_create="yes" has_primary_application="yes" dirty_flag="yes"
attempt_status_change_on_checkin="yes" function_group="DOC_SLWMDL"
customer_data_section="SLWMDL" auto_adjust_application_role="no">

<copy_as allowed="yes" ignore_wsappl_list="ZIP" use_initial_version="yes"


copy_material="no" remove_dirty_flag="no">
</copy_as>
<new_version status_list="AC;IW;FR" ignore_wsappl_list="ZIP" ignore_nm_dtype_list=""
rename_master_original="yes" remove_dirty_flag="no"/>
</program_options>

<document_create create_with_SAP_GUI="no" create_multi_allowed="no" document_number_assignment="internal"


initial_document_number="*" document_type="SWP" initial_document_part="000"
part_editable="no" initial_document_version="00" version_editable="no"
change_to_after_create_status="AC" filename_template_base="$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
filename_template_version="">
</document_create>

<material_create material_creation_method="deferred" material_number_assignment="internal"


material_type="FERT;HALB" material_template=""
material_plant_assignment="" material_default_class=""/>

<primary_application primary_workstation_application="SWP" attribute_section="SLWMDL"


update_attributes_for_rw="yes" update_attributes_for_ro="no"
update_attributes_for_dirty="yes">
<container_file>
<plmfile extension="ecf" workstation_application="ECF" description="ECtr container file"/>
</container_file>

<checkout_rules rename_master_original_at_checkout="no" one_version_in_session_only="no"


hardlink_in_session="no" read_structure="flag" check_references_on_edit="yes">
</checkout_rules>

<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.

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


Defines the group designation for master documents. The group
designation helps to organize DTypes within the dialog "create
group "SOLIDWORKS" document".

"SOLIDWORKS" = Document belongs to this group.

The sub-element <program_options> contains different settings, which control the behavior of the document
in the SAP Engineering Control Center.

Attributes of the sub-element <program_options>


Attribute Value Description
Determines whether in dialogue "create
document " this DType is visible in the combo
show_for_create "yes" box for accessible document types.

"yes" = Document is visible.


Determines if document is normal document
with original and assigned Workstation
Application or container object for additional
has_primary_application "yes" originals without explicit original.

"yes" = The document has an original with the


designated Workstation application
Determines if the newly created document has a
dirty flag.
dirty_flag "yes"
"yes" = The document has a dirty flag.

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.

"DOC_SLWMDL" = Identifier of the Function


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

"SLWMDL" = Name of section.


Turns the automatic adaptation of the
"application role" in RES4 in SAP on or off.
auto_adjust_application_role "no"
"no" = No automatic adaptation.
Optional: Name of the section in the
configuration file "attributes-to-sap.xml" for
mapping virtual components.
bod_mapping_section "VIRT_COMP_SLWMDL"
"VIRT_COMP_SLWMDL" = Name of the section in
the configuration file "attributes-to-sap.xml".

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

Attributes of the sub-element <copy_as> from sub-element <program_options>


Attribute Value Description
Determines if a CopyAs is permitted for this DType.
allowed "yes"
"yes" = "CopyAs" - operation permitted.
Determines which additional originals of the document will be accepted during
copy but not into copy of document according to a table of identifiers for the
Workstation Application for additional originals all of which are separated by
ignore_wsappl_list "ZIP"
semicolon.

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


Determines whether the version number of the copy should be set on the original
or on the initial value (normally "00").
use_initial_version "yes"
"yes" = Version number of the copy on which the initial value will be set.
Determines if designated material will also be copied during copy of master
document. This attribute has no influence on depending documents, which are
copy_material "no" copied onto the master documents during copy process.

"no" = Material will not be copied.

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 <new_version> contains settings for the versioning of documents.

Attributes of the sub-element <new_version> from sub-element <program_options>


Attribute Value Description
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 not be
accepted into a new version of document during versioning, according to a
list of identifiers for the Workstation Application which are separated by
ignore_wsappl_list "ZIP"
semicolons.

"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.

"" = No ignorable document types defined.


Determines if dirty flag of new version will be reset.
remove_dirty_flag "no"
"no" = The dirty flag of new version remains set.

The sub-element <document_create> contains settings that control the way in which a new document is
created in SAP.

Attributes to the sub-element <document_create>


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

"*" = Due to internal number assignment


without meaning.

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.

"no" = The default value cannot be


changed.
Sets the initial value of the version
number for documents.
initial_document_version "00"
"00" = Initial value of the version number
Defines whether the default value for the
document version can be changed in the
documentation system dialog of SAP
version_editable "no" Engineering Control Center.

"no" = No changes in default values are


allowed.
The initial status of newly created
document can be set here.
change_to_after_create_status ""
"" = Standard status will be used.
Determines composition of file name of
original document. The following place
holders are possible: $(DOCNUMBER) for
the document number, $(DOCTYPE) for
the document type and $(DOCPART) for
filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" partial document.

"$(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.

"" = No version number in the file name.

The sub-element <material_create> contains settings for creating a new document from materials.

Attributes of the sub-element <material_create>


Attribute Value Description

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.

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


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

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.

Attribute of the sub-element <primary_application>


Attribute Value Description
"SWP" = Identification of the SAP workstation application for the
primary_workstation_application "SWP"
original.
Name of the section within the Attribute Mapping File, in which
attribute exchanges between SAP and the application
attribute_section "SLWMDL" (SOLIDWORKS) are defined.

"SLWMDL" = Name of section within the Attribute Mapping file


Defines the attribute update for the action "Open for editing"
update_attributes_for_rw "yes"
"yes" = Perform attribute update.
Defines the attribute update with the action "Open as read-
only".
update_attributes_for_ro "no"
"no" = Do not perform an attribute update.
Defines if to update the attributes when dirty flag was set.
update_attributes_for_dirty "yes"
"yes" = Perform attribute update.

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.

Attribute of the <checkout_rules> sub-element from the <primary_application> sub-element


Parameter Values Description
Defines if the original is renamed during opening according to
rules for component names.
rename_master_original_at_checkout "no"
"no" = Keep file name during opening.
Determines if this document must have only one version in
the session directory.
one_version_in_session_only "no"
"no" = Multiple versions of the document are allowed in the
session directory.
Determines if hard link may be used for original document in
the session directory or if a copy must always be created.
hardlink_in_session "no"
"no" = Always create a copy.
Determines whether a structure resolution will be performed
upon opening a document.
read_structure "flag"
"flag" = Only perform a structure resolution if "Structure"-Flag
is set.
Defines if under function "Open for Edit" all files for
referenced components were provided in the session
directory. Test has been done If not, operation will be
check_references_on_edit "yes"
abandoned.

"yes" = Run test

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.

Attribute of the sub-element <checkin_rules> from <primary_application>


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

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.

Attribute of the sub-element <plmfile> of sub-element <ignore> by <checkin_rules>


Parameter Values Description
The respective file name extensions of the
additional files to ignore in the file system.
extension "bak", "tmp", "xml""bak", "tmp", "bat"
"bak", "tmp", "xml" = File name extensions of the
additional file types.
Filters by file names and regular expressions.
filename_pattern "VEConverterResponse\.xml"
"VEConverterResponse\.xml" = Filter mask.

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.

Attributes of sub-element <plmfile> of sub-element <delete_in_sap> by <checkin_rules>


Parameter Values Description
Workstation application identifiers for each paragraph
"EPJ", "EDW", "STP", "IGS", style.
workstation_application "STL", "SAT", "RHM", "JT",
"RH" "EPG", "EPJ", "CGO", "JT", "EDW", "STP", "IGS", "STL",
"SAT" = Identifications of the workstation application.

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.

Attributes of the sub-element <plmfile> of sub-element <delete_in_session> by <checkin_rules>


Parameter Values Description
The file name extensions of the files to be deleted in the file
system.
"jpg", "gif", "cgm", "rh",
extension
"vds"
"jpg", "gif", "cgm", "rh", "vds" = File name extensions of the
additional file types.

The sub-element <scripts> contains scripts that are run before checking in. The individual scripts are
contained in sub-element <script>

Attributes of the sub-element <script> of sub-element <scripts> by <checkin_rules>


Parameter Values Description
Sets the entire call path of the executing program.
"@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat"
Name
= script call path "VEConverter.bat". "@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat"
= script call path "VEConverter.bat".

<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.

Attribute of the sub-element <additional_files>


Parameter Values Description
Determines whether the additional originals are permissable for this
document.
enable_additional_files "yes"
"yes" = additional originals are permissible.

The 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.

Attributes of the subelements <plmfile> of the subelement <ignore_files> from <additional_files>


Parameter Values Description

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.

Attributes of the sub-element <allowed_nonmaster>


Parameter Values Description
The non-ambiguous DType ID of the definition of the dependent document.
DType "VWINM"
"VWINM" = DType of allowed dependent documents.
Allowable number of dependent documents for this master document.
max_count "99"
"99" = Max. number of possible dependent documents of this type.

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

<DType type="template" identifier="SLWDRW" include_template="DEFLT" application_type="SLW"


group="SOLIDWORKS">
<description language="EN" text="SOLIDWORKS 2D Documents"/>

<program_options show_for_create="yes" has_primary_application="yes" dirty_flag="yes"


attempt_status_change_on_checkin="yes" function_group="DOC_SLWDRW"
customer_data_section="SLWDRW" auto_adjust_application_role="no">
<copy_as allowed="yes" ignore_wsappl_list="ZIP" use_initial_version="yes" remove_dirty_flag="no"/>
<new_version status_list="AC;IW;FR" ignore_wsappl_list="ZIP" ignore_nm_dtype_list=""
remove_dirty_flag="no"/>
</program_options>

<nonmaster_options link_to_master_material="yes"/>

<document_create create_with_SAP_GUI="no" create_multi_allowed="no"


document_number_assignment="master"
initial_document_number="*" document_type="SWD" initial_document_part="000"
part_editable="no" initial_document_version="00" version_editable="no"
change_to_after_create_status="AC"
filename_template_base="$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"
filename_template_version="">
</document_create>

<material_create material_creation_method="deferred" material_number_assignment="master"


material_type="FERT;HALB" material_template=""
material_plant_assignment="" material_default_class=""/>

<primary_application primary_workstation_application="SWD" update_attributes_for_dirty="yes"


update_attributes_for_rw="yes" update_attributes_for_ro="no"
ttribute_section="SLWDRW">

<container_file>
<plmfile extension="ecf" workstation_application="ECF" description="ECtr container file"/>
</container_file>

<checkout_rules rename_master_original_at_checkout="no" one_version_in_session_only="no"


hardlink_in_session="no" read_structure="flag" check_references_on_edit="yes">
</checkout_rules>

<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>

Attributes of the element <DType> of template definition "SLWDRW"


Attribute Value Description

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.

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


Defines the group designation for master documents. The group
designation helps to organize DTypes within the dialog "create
group "SOLIDWORKS" document".

"SOLIDWORKS" = Document belongs to this group.

The sub-element <program_options> contains different settings, which control the behavior of the document
in the SAP Engineering Control Center.

Attributes of the <program_options> sub-element


Attribute Value Description
Determines whether in dialogue "create
document " this DType is visible in the combo
show_for_create "yes" box for accessible document types.

"yes" = Document is visible.


Determines if document is normal document
with original and designated Workstation
Application or container object for additional
has_primary_application "yes" originals without explicit original.

"yes" = the document has an original with the


designated Workstation application.
Determines if the newly created document has a
dirty flag.
dirty_flag "yes"
"yes" = The document has a dirty flag.
Determines if change of status applies during
check in at SAP Engineering Control Center or if
SAP System conducts change of status.
attempt_status_change_on_checkin "yes"
"yes" = Change of status by 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.

"DOC_SLWDRW" = Identifier of the Function


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

"SLWDRW" = Name of section.


Turns the automatic adaptation of the
"application role" in RES4 in SAP on or off.
auto_adjust_application_role "no"
"no" = No automatic adaptation.
Optional: Name of the section in the
configuration file "attributes-to-sap.xml" for
mapping virtual components.
bod_mapping_section "VIRT_COMP_SLWMDL"
"VIRT_COMP_SLWMDL" = Name of the section in
the configuration file "attributes-to-sap.xml".

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

Attribute to the sub-element <copy_as> from sub-element <program_options>


Attribute Value Description
Determines if a CopyAs is permitted for this DType.
allowed "yes"
"yes" = "CopyAs" - operation permitted.
Determines which additional originals of the document will be accepted during
copy but not into copy of document according to a table of identifiers for the
Workstation Application for additional originals all of which are separated by
ignore_wsappl_list "ZIP"
semicolon.

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


Determines whether the version number of the copy should be set on the original
or on the initial value. (as a rule "00")
use_initial_version "yes"
"yes" = Version number of the copy on which the initial value will be set.
Determines if dirty flag of copy will be reset.
remove_dirty_flag "no"
"no" = The dirty flag of copy remains set.

The sub-element <new_version> contains settings for versioning of documents.

Attribute to the sub-element <program_options>


Attribute Value Description

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.

"" = No ignorable document types defined.


Determines if dirty flag of new version will be reset.
remove_dirty_flag "no"
"no" = The dirty flag of new version remains set.

The sub-element <nonmaster_option> determines whether a dependent document will be linked to the
material of the master document.

Attribute of the <nonmaster_options> sub-element


Attribute Value Description
Determines whether the dependent document receives an object link to the
master document material.
link_to_master_material "yes"
"yes" = An object link is created by the master document material to the
dependent document.

The sub-element <document_create> contains settings that control the way in which a new document is
created in SAP.

Attributes to the sub-element <document_create>


Attribute Value Description
Determines if SAP GUI should be opened
when creating a document.
create_with_SAP_GUI "no"
"no" = Do not open SAP GUI.
Determines if the mass creation of this
document is allowed.
create_multi_allowed "no"
"no" = Mass creation of this document is
not permitted.
Determines the document number
assignment in SAP.
document_number_assignment "master"
"master" = The document version number
is taken from the master document.

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.

"*" = Wg. "master" without meaning.


SAP document type for the newly created
document.
document_type "SWD"
"SWD" = 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.

"no" = The default value cannot be


changed.
Sets the initial value of the version
number for documents.
initial_document_version "00"
"00" = Initial value of the version number.
Defines whether the default value for the
document version can be changed in the
documentation system dialog of SAP
version_editable "no" Engineering Control Center.

"no" = No changes in default values are


allowed.
The initial status of newly created
document can be set here.
change_to_after_create_status "AC"
"AC" = The initial status.
Determines composition of file name of
original document. The following place
holders are possible: $(DOCNUMBER) for
the document number, $(DOCTYPE) for
the document type and $(DOCPART) for
filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" partial document.

"$(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.

"" = no version number in the file name.

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.

Attributes of the sub-element <material_create>


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

"master" = The number of the master document is adopted.


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

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.

Attribute of the sub-element <primary_application>


Attribute Value Description
"SWD" = Identification of the SAP workstation application for
primary_workstation_application "SWD"
the original.
Defines if to update the attributes when dirty flag was set.
update_attributes_for_dirty "yes"
"yes" = Perform attribute update.
Defines the attribute update for the action "Open for editing"
update_attributes_for_rw "yes"
"yes" = Perform attribute update.
Defines the attribute update with the action "Open as read-
only".
update_attributes_for_ro "no"
"no" = Do not perform an attribute update.
Name of the section within the Attribute Mapping File, in which
attribute exchanges between SAP and the application
attribute_section "SLWDRW" (SOLIDWORKS) are defined.

"SLWDRW" = Name of section within the Attribute Mapping file.

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.

Attribute of the <checkout_rules> sub-element from the <primary_application> sub-element


Parameter Values Description
Defines if the original is renamed during opening according to
rules for component names.
rename_master_original_at_checkout "no"
"no" = Keep file name during opening.
Determines if this document must have only one version in
the session directory.
one_version_in_session_only "no"
"no" = Multiple versions of the document are allowed in the
session directory.
Determines if hard link may be used for original document in
the session directory or if a copy must always be created.
hardlink_in_session "no"
"no" = Always create a copy.
Determines whether a structure resolution will be performed
upon opening a document.
read_structure "flag"
"flag" = Only perform a structure resolution if "Structure"-Flag
is set.
Defines if under function "Open for Edit" all files for
referenced components were provided in the session
directory. Test has been done at If not, operation will be
check_references_on_edit "yes"
abandoned.

"yes" = Run test.

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.

Attribute of the sub-element <checkin_rules> from <primary_application>


Attribute Value Description

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.

Attributes of the sub-elements <plmfile> of the sub-element <ignore> of <checkin_rules>


Parameter Values Description
The respective file name extensions of the additional files to
ignore in the file system.
"bak", "tmp", "xml""bak", "tmp",
extension
"bat"
"bak", "tmp", "bat" = File name extensions of the additional
file types.

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.

Attributes of sub-element <plmfile> of sub-element <delete_in_sap> by <checkin_rules>


Parameter Values Description
Workstation application identifiers for each additional format.
workstation_application "EPJ", "EPG"
"EPG", "EPJ" = Identification of the workstation application.

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.

Attributes of the sub-element <plmfile> of sub-element <delete_in_session> by <checkin_rules>


Parameter Values Description
The file name extensions of the files to be deleted in the file system.
extension "jpg", "gif"
"jpg", "gif" = File name extensions of the additional file types.

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

<DType type="master" identifier="SWPRT" include_template="SLWMDL" application_type="SLW"


application_role="P">
<description language="EN" text="SolidWorks Model SWP"/>

<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>

<seedfile filename="modeltemplate.sldprt" type="select" default="no"


extension_filter="*.sldprt">
<description language="EN" text="select existing partfile"/>
</seedfile>
</document_create>

<primary_application primary_workstation_application="SWP"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>

Attributes of the component <DType> of the definition "SWPRT"


Attribute Value Description
Sets the type of DType definition.
type "master"
"master" = It’s a matter of 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 "SWPRT"
"SWPRT" = ID of this DType definition.

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.

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


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "P"
"P" = Identification of the object type for parts.

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>.

Attributes of the sub-element<icondef> of the sub-element<icon>


Attribute Value Description
Position of the symbol within the document entry in
the tree.
icon_position "1"
"1" = Leftmost, "6" = rightmost.
Identification of a symbol group. Status-depending,
other symbols can be represented.
icon_group "default"
"default" = This is the standard icon.
Path to determine the icon file, which contains the
applicable symbol for this symbol position.
icon_identifier "tree/slw/solidworks_part_$(FAMILY)16"
"tree/slw/solidworks_part_$(FAMILY)16" = The icon
file.

The sub-element <document_create> determines the way in which the document is created in SAP.

Attributes to the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "SWP"
"SWP" = SOLIDWORKS part document.
Determines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = SAP assigns the number automatically.
Determines whether, for the document attachment, the filename
of the original is renamed according to the established naming
rules or if the filename of the template file is assumed
rename_template_filename "yes" unchanged.

"yes" = The filename of the original is renamed in creating the


document.

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.

Attributes of the first sub-element<seedfile> of sub-element<document_create>


Attribute Value Description
When using type="template", this attribute defines the filename of
the template files that is used. There must be a file with this name,
filename "modeltemplate.sldprt" or the process will terminate with an error.

"modeltemplate.sldprt" = Filename of the template file to be used.


Determines how the original document will be generated.
type "template"
"template" = The "filename" attribute is used to specify the
template file that is to be used.
This determines whether this template file should be used as a
preset in the "Create document" dialog.
default "yes"
"yes" = The template file is preset.
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 "*.sldprt" dialog you can select files that are matched by the filter.

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

Attributes of the 2. sub-element <seedfile> of sub-element <document_create>


Attribute Value Description
The "filename" attribute is used to specify the template file that is
to be used. You can create a document within the dialog, select a
filename "modeltemplate.sldprt" template file via a file selection dialog.

"modeltemplate.sldprt" = Data filename of the template file.


Determines how the original document will be generated. The
"filename" attribute is used to specify the template file that is to be
used. A template file can be selected within the dialog "Create
type "select" document" via a file selection dialog.

"select" = Selection of a template file in the dialog "Create


document" possible.
This helps 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
defines the filter for file extension. In the file selection dialog you
extension_filter "*.sldprt" can select files that are matched by the filter.

"*.sldprt" = Filter for file extension.

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.

Attributes of the sub-element <allowed_nonmaster>


Attribute Value Description
Specifies the DType allowed as nonmaster document.
DType "NSWDR"
"NSWDR" = DType.
Determines the maximal amount of possible nonmaster-documents.
max_count "99"
"99" = Maximal number of nonmaster documents.

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

<DType type="master" identifier="SWNPR" include_template="SLWMDL" application_type="SLW"


application_role="P">
<description language="EN" text="SolidWorks Model SWN"/>

<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">

<seedfile filename="modeltemplate.sldprt" type="select" default="no"


extension_filter="*.sldprt">
<description language="EN" text="select existing partfile"/>
</seedfile>
</document_create>

<primary_application primary_workstation_application="SWN" use_relative_path="yes"/>


<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>

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


Attribute Value Description
Sets the type of DType defintion.
type "master"
"master" = It’s a matter of a DType definition for master documents.

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.

"SLW" = This is the work station application (WSAppl) for SOLIDWORKS.


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "P"
"P" = Identification of the object type for parts.

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>.

Attributes of the sub-element <icondef> of the sub-element <icon>


Attribute Value Description
Position of the symbol within the document entry in
the tree.
icon_position "1"
"1" = leftmost, "6" = rightmost.
Identification of a symbol group. Status-depending,
other symbols can be represented.
icon_group "default"
"default" = This is the standard symbol.
Path to determine the icon file, which contains the
applicable symbol for this symbol position.
icon_identifier "tree/slw/solidworks_part_$(FAMILY)16"
"tree/slw/solidworks_part_$(FAMILY)16" = The icon
file.

The sub-element <document_create> determines the positioning of the document in SAP.

Attribute of the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "SWN"
"SWN" = SOLIDWORKS part document as standard part.
Defines the document number assignment in SAP.
document_number_assignment "internal"
"internal" = SAP automatically assigns the number.

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.

"no" = The filename of the original is assumed unchanged.


Determines the original SAP status in the newly created
document.
change_to_after_create_status "AA"
"AA" = SAP status identification.

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.

Attributes of the sub-element <seedfile> of the sub-element <document_create>


Attribute Value Description
Determines how the original document will be generated. The "filename" attribute
is used to specify the template file that is to be used. A template file can be
type "select" selected within the dialog "Create document" via a file selection dialog.

"select" = Selection of a template file in the dialog "Create document" is possible.


This helps 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 defines the
filter for the file extension. In the file selection dialog you can select files that are
extension_filter "*.sldprt" matched by the filter.

"*.sldprt" = Filter for file extension.

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.

Attributes of the sub-element<primary_application>


Attribute Value Description
"SWN" = Identification of the SAP workstation application for
primary_workstation_application "SWN"
SOLIDWORKS standard parts.
Determines whether for addressing a document of this type a
relative path is to be used.
use_relative_path "yes"
"yes" = use of relative paths.

The sub-element defines a specific document type allowed as non-master document.

Attributes of the sub-element <allowed_nonmaster>


Attribute Value Description
Specifies the DType allowed as nonmaster document.
DType "NSWDR"
"NSWDR" = DType.

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

<DType type="master" identifier="SWPAS" include_template="SLWMDL" application_type="SLW"


application_role="A">
<description language="EN" text="SolidWorks assembly SWA"/>

<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>

<seedfile filename="modeltemplate.sldasm" type="select" default="no"


extension_filter="*.sldasm">
<description language="EN" text="select existing assembly"/>
</seedfile>
</document_create>

<primary_application primary_workstation_application="SWA"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>

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


Attribute Value Description
Sets the type of 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.
This ID has to measure one to five characters.
identifier "SWPAS"
"SWPAS" = ID of this DType-definition.
Specifies which template definition is implied in 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.
Identifier for the application relevant for this document (workstation
application). This application opens the file from the SAP Engineering Control
application_type "SLW" Center.

"SLW" = This is the work station application (WSAppl) for SOLIDWORKS.


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "A"
"A" = Identification of the object type for SOLIDWORKS assemblies.

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>.

Attributes of the sub-elementes <icondef> of the sub-element <icon>


Attribute Value Description
Icon position within the document entry in the
tree.
icon_position "1"
"1" = Leftmost, "6" = rightmost.
Identification of a symbol group. Status-
depending, other symbols can be represented.
icon_group "default"
"default" = This is the standard icon.
Path to determine the icon file, which contains
the applicable symbol for this symbol position.
icon_identifier "tree/slw/solidworks_assembly_$(FAMILY)16"
"tree/slw/solidworks_assembly_$(FAMILY)16" =
The icon file.

The sub-element <document_create>determines the position of the document in the SAP.

Attributes of the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "SWA"
"SWA" = SOLIDWORKS assembly document.
Defines the document number assignment in the 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.

"yes" = the filename of the original is renamed in creating the


document.

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.

Attributes of the 1. sub-element <seedfile> of sub-element <document_create>


Attribute Value Description
In using the type="template" this attribute defines the filename of
the template file that is used. There must be a file with this name,
or the process will terminate with an error.
filename "modeltemplate.sldasm"
"modeltemplate.sldasm" = Filename of the template file to be
used.

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.

"*.sldasm" = Filter for file extension.

Attributes of the 2. sub-element <seedfile> of sub-element <document_create>


Attribute Value Description
The attribute "filename" specifies the template file to be used. You
can create a document in the dialog, select a template file via a
filename "modeltemplate.sldasm" file selection dialog.

"modeltemplate.sldasm" = Filename of the template file


Determines how the original document will be generated. The
"filename" attribute is used to specify the template file that is to
be used. A template file can be selected in the dialog "Create
type "select" document" via a file selection dialog.

"select" = Selection of a template file in the dialog "Create


document" possible.
This helps determine whether a template file is preset in the dialog
"Create document".
default "no"
"no" = This template file is not 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 "*.sldasm" dialog you can select files that are matched by the filter.

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

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.

Attributes of the sub-element <primary_application>


Attribute Value Description
"SWA" = identification of the SAP work station application for
primary_workstation_application "SWA"
SOLIDWORKS assemblies.

The sub-element <allowed_nonmaster> defines a specific document type allowed as nonmaster document.

Attributes of the sub-element <allowed_nonmaster>


Attribute Value Description

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

<DType type="master" identifier="SWNAS" include_template="SLWMDL" application_type="SLW"


application_role="A">
<description language="EN" text="SolidWorks assembly SWN"/>

<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">

<seedfile filename="modeltemplate.sldasm" type="select" default="no"


extension_filter="*.sldasm">
<description language="EN" text="select existing assembly"/>
</seedfile>
</document_create>

<primary_application primary_workstation_application="SWN"/>
<allowed_nonmaster DType="NSWDR" max_count="99"/>
</DType>

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


Attribute Value Description
Sets the type of 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.
This ID has to be one to five characters long.
identifier "SWNAS"
"SWNAS" = ID of this DType definition.
Specifies which template definition is implied in 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.
Identifier for this application relevant for this document (work station
application). This application opens the file from the SAP Engineering Control
application_type "SLW" Center.

"SLW" = For SOLIDWORKS this is the work station application (WSAppl).


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "A"
"A" = Identification of the object type for SOLIDWORKS assemblies.

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>.

Attributes of the sub-element <icondef> of the sub-element <icon>


Attribute Value Description
Icon position within the document entry in the
tree.
icon_position "1"
"1" = Leftmost, "6" = rightmost.
Identification of a symbol group. Status-
depending, other symbols can be represented.
icon_group "default"
"default" = This is the standard icon.
Path to determine the icon file, which contains
the applicable symbol for this symbol position.
icon_identifier "tree/slw/solidworks_assembly_$(FAMILY)16"
"tree/slw/solidworks_assembly_$(FAMILY)16" =
The icon file.

The sub-element <document_create> determines settings, how the document is created in the SAP.

Attributes of the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "SWN"
"SWN" = SOLIDWORKS assembly document as standard part.
Defines the document number assignment in the 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 "no"
unchanged.

"no" = The filename of the original is assumed unchanged.

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.

Attributes of the sub-element <seedfile> of the sub-element <document_create>


Attribute Value Description
Determines how the original document will be generated . The "filename"
attribute is used to specify the template file that is to be used. A template file
type "select" can be selected in the dialog "Create document" via a file selection dialog.

"select" = Selection of a template file in the dialog "Create document" possible.


It can determine whether this template file is preset in the dialog "Create
document".
default "no"
"no" = This template file has not been preset.

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.

"*.sldasm" = File extension 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.

Attributs of the sub-element <primary_application>


Attribute Value Description
"SWN" = Identification of the SAP work station application for
primary_workstation_application "SWN"
SOLIDWORKS standard parts.

the sub-element <allowed_nonmaster> defines a specific document type which is allowed as nonmaster
document.

Attributes of the sub-element <allowed_nonmaster>


Attribute Value Description
Specifies the DType allowed as nonmaster document.
DType "NSWDR"
"NSWDR" = DType.
Determines the maximal amount of possible nonmaster documents.
max_count "99"
"99" = Maximal number of nonmaster documents.

Now we come to the DType definition of SOLIDWORKS-Drawings ("SWD") as master document:

DType definition for master documents of the type "SWD" for SOLIDWORKS

<DType type="master" identifier="MSWDR" include_template="SLWDRW" application_type="SLW"


application_role="D">
<description language="EN" text="SolidWorks Drawing SWD"/>

<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>

<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>

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.

"SLW" = this is the work station application for SOLIDWORKS (WSAppl).


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "D"
"D" = identification of the object type for SOLIDWORKS drawings.

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>.

Attributes of the sub-element <icondef> of the sub-element <icon>


Attribute Value Description
Icon position within the document entry in the
tree.
icon_position "1"
"1" = Leftmost, "6" = rightmost.
Identification of a symbol group. Status-
depending, other symbols can be represented.
icon_group "default"
"default" = This is the standard icon.
Path to determine the icon file, which contains
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 sub-element <document_create> determines, how the document is created in the SAP.

Attributes of the sub-element <document_create>


Attribute Value Description
SAP document type for the newly created document.
document_type "SWD"
"SWD" = SOLIDWORKS drawing doument.

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.

"yes" = The filename of the original is renamed in creating the


document.

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.

Attributes of the first sub-elementes <seedfile> of the sub-element <document_create>


Attribute Value Description
In applying the type="template" this attribute defines the
filenames of the template file to be used. There must be a file with
filename "modeltemplate.slddrw" this name, or the process will terminate with an error.

"modeltemplate.slddrw" = filename of the template file to be used.


Determines how the original document will be generated.
type "template"
"template" = The attribute "filename" indicates the template file to
be used.
Hereby it can be determined whether this 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
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.

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

Attributes of the 2. sub-element <seedfile> of the sub-element <document_create>


Attribute Value Description
The "filename" attribute is used to specify the template file that is
to be used. They can create a document in the dialog, select a
filename "modeltemplate.slddrw" template file via the file selection dialog.

"modeltemplate.slddrw" = data file of the file template.


Determines how the original document will be generated . The
"filename" attribute is used to specify the template file that is to be
used. A template file can be selected in the dialog "Create
type "select" document" via a file selection dialog.

"select" = Selection of a template file in the dialog "Create


document" possible.

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.

"*.slddrw" = File extension 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.

Attributes of the sub-element <primary_application>


Attribute Value Description
"SWD" = Identification of the SAP work station application for
primary_workstation_application "SWD"
SOLIDWORKS drawings.

DType definition for nonmaster documents

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

<DType type="nonmaster" identifier="NSWDR" include_template="SLWDRW" application_type="SLW"


application_role="D">
<description language="EN" text="SolidWorks Drawing SDN NonMaster"/>

<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>

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


Attribute Value Description
Determines the kind of DType definition.
type "master"
"master" = Involves a DType definition for master documents.
Non-ambiguous ID string for this DType definition within the entire XML
document. The ID has to be between one and five characters long.
identifier "NSWDR"
"NSWDR" = Identification of this DType definition.
Determines which template definition will be incorporated into this definition.

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.

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


Here you can adjust the object type setting in the RES4 field of the SAP table
DRAW.
application_role "D"
"D" = Identification of the object type for drawings.

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.

Attributes of the <icondef> sub-element from the <icon> sub-element


Attribute Value Description

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.

Attributes of the <document_create> sub-element


Attribute Value Description
SAP document type for the newly created document.
document_type "SDN"
"SDN" = SOLIDWORKS drawing document as nonmaster document.
Determines whether, for the document attachment, the file name of the
original will be renamed according to the established naming rules or if
the file name of the template file will be assumed as is.
rename_template_filename "yes"
"yes" = the filename of the original will be renamed in creating the
document.

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.

Attributes of the first <seedfile> sub-element from the <document_create> sub-element


Attribute Value Description
When type="template" is used, this attribute defines the file name
of the template file that will be used. There must be a file with this
name, or the process will terminate with an error.
filename "modeltemplate.slddrw"
"modeltemplate.slddrw" = File name of the template file that will
be used.
Determines how the original document will be created.
type "template"
"template" = The "filename" attribute is used to specify the
template file that is to be used.
This determines whether this template file should be used as a
preset in the "Create Document" dialog.
default "yes"
"yes" = This template file is preset.

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.

"*.slddrw" = File extension filter.

Attributes of the second <seedfile> sub-element from the <document_create> sub-element


Attribute Value Description
The "filename" attribute will be used to specify the template file
that is to be used. You can create a template file in the document
filename "modeltemplate.slddrw" dialog with the help of a file selection dialog.

"modeltemplate.slddrw" = File name of the template file.


Determines how the original document will be created. The
"filename" attribute will be used to specify the template file that is
to be used. In the "Create Document" dialog, you can select a
type "select" template file with the help of a file selection dialog.

"select" = Makes it possible to select a template file in the "Create


document" dialog.
This determines whether this template file should be preset in the
"Create Document" dialog.
default "no"
"no" = This template file is not preset.
When selecting a template file with type="select", this attribute
defines the file extension filter. In the file selection dialog, you are
extension_filter "*.slddrw" offered the files that are matched by the filter.

"*.slddrw" = File extension filter.

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.

Attributes of the <primary_application> sub-element


Attribute Value Description
"SWD" = Identification of the SAP Workstation Application for
primary_workstation_application "SWD"
SOLIDWORKS drawings.

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:

ECTR dialog "Preferences"

The CAD-specific data file "options.xml" determines the options that are given for the particular CAD system.
We are talking about parameters, which a part of the CAD-specific data file "default.txt" and which are pre-
allocated with a standard value.

Settings made under "Settings -> Preferences" in the menu will be 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").

The file "options.xml" has the following structure:

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.

Attributs of elemtent <node>


Attribute Value Description
(Optional) If attribut exists, a folder icon with the given name will appear. Below
label="..." Name
you will find the cards arranged under a branch, defined as in the following.
Defines an entry in the tree diagram, which contains changeable parameters
Card
card="..." (preferences), and which will appear on the right when clicked. The adjustable
identifier
parameter will be defined in the corresponding element <card>.

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.

Attribut of element <card>


Attribute Value Description
name="..." Name Name of Card, like in the element <node>

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.

Attributs of sub-element <option>


Attribute Value Description
Name or description of Description of the option as appears on the card under
label="..."
the option "Description"
file type of the option. The following are possible:
type="..." Data type
"string", "boolean", "long"
prefname="..." Parameter name The complete name of the preference from file "default.txt"
(Optional) Description of the option. Appears as tooltip, when
tooltip="..." Description of the option
mouse cursor is positioned on the option
(Optional) Maximum possible number of signes or characters
maxchars="..." Number
within an editing field

If you want to present a list of possible values, you have to enter the sub-element <entry> which might occur
repeatedly.

Attributs of sub-element <entry>


Attribute Value Description
name="..." Name Name of value in the list
Value accordung to attribute "type" from
value="..." Value, which is given to parameter at choice
element <option>

If you place the attribute "maxchars" within the element <option> and at the same time you put values over
<entry>, an edit field appears. But for entries, which are identical to the values that are connected to the
attribute "name", the values set in the attribute "value" will be given to the parameter.

ATTENTION:
When adding new settings to this file, note the following: Some preferences are cached by the
interface, so that an update of the value is not guaranteed during operation! However, all settings
in the standard delivery of the file "options. xml" can be changed during operation.

plm_setenv.bat
The file "plm_setenv.bat" serves to set environment variables. These can then be evaluated from the SAP
Engineering Control Center 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 entries have the following structure:

Application type:Macro definition filename

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"!

The default configuration for SOLIDWORKS contains the following entries:

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.

Changes in configuration file "default.txt"


Version Status Parameter
plm.structure.application.show.drawing.SLW
plm.structure.application.show.drawing.container.SLW
02.21.87.00
structure.view.SLW.generic.object.DRAW_CONTAINER.name
structure.view.SLW.generic.object.DRAW_CONTAINER.icon
plm.options.DeselectCADOptionForPurgeCachedConfigurationData.SLW
plm.mat.create.variant.types.hidden
plm.cad_variant.fgroup.forVariantType.<variantType>
plm.cad_variant.dgroup.forVariantType.<variantType>
02.21.85.00 plm.options.save.useTwoTierStructureAnalyze.SLW
plm.options.SaveAsNewDocument.CancelSourceFile.SLW
plm.options.MacroName.MapAttributesMacroName.SLW
plm.options.checkForUpdates.before.CheckoutEdit.MultiLevel.SLW
plm.options.checkForUpdates.before.CheckoutEdit.ExplosionScenario.SLW
plm.options.structureAnalyze.useAcceleratedConfigurationChange.SLW
02.20.84.00
plm.options.Logging.LogPerformanceTrace.SLW
plm.options.localSave.AvoidRebuildOnSave.SLW
plm.options.handlingOfCutlistItems.SLW
02.20.83.00
plm.options.MacroName.GetRelatedDrawings.SLW
plm.execute.additional.SLW
plm.options.DeliverPhysicalPropertiesInDocumentUnit.SLW
02.19.80.00
plm.options.UpdateAttributes.RefreshContext.SLW
plm.options.variantType.SLW.SpeedPak
plm.options.variantType.SLW.derivedConfiguration
plm.options.variantType.SLW.<VARIANT_GROUP_NAME>
plm.options.variantType.SLW.<VARIANT_GROUP_NAME>.namePattern
plm.options.variantType.SLW.<VARIANT_GROUP_NAME>.property.<PROPERTY_NAME>
02.19.79.00
plm.options.variantType.BOMRelevant.SLW
sap.plm.document.variant.cdesk_variant.SLW
plm.cad_variant.fgroup.forDocType.SWP
plm.cad_variant.fgroup.forDocType.SWA
plm.cad_variant.fgroup.forDocType.SWN
plm.options.Ballooning.InitializeBalloonWith.SLW
02.19.78.00
plm.options.structureAnalyze.useAcceleratedConfigurationChange.SLW
02.17.77.00 plm.options.UpdateAttributes.UpdateReadOnly.SLW
02.17.76.00 plm.options.bom.UseAutoBomItemGroup.SLW
02.17.75.00 plm.options.BOMTable.Column.SLW.[CAD_COLUMN]

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

The following table contains changes in the configuration file "dtype.xml":

Changes in configuration file "dtype.xml"


Version Description
The template definitions for "SLWMDL" and "SLWDRW" have got the attribute
from_application_only="yes" in their checkin_rules.

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.

Activate simple pop-up message


If a function is triggered using the SAP Engineering Control Center Interface to SOLIDWORKS, a message will
be displayed in the center of the working range of SOLIDWORKS, which provides information about the current
action which is being implemented by ECTR:

Information about running ECTR processes

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!

Mapping the properties


The mapping (transfer) of properties displays how values can be transferred from SOLIDWORKS to fields in SAP
and vice versa. There are several options on both sides how values are read and where these are written.
Basically, we distinguish between document-, material- and user-specific properties in SOLIDWORKS. These
properties are listed in chapter "Available properties". Fields of the document info record and the material are
provided in SAP. Document and material classes can be filled or read further on. With SOLIDWORKS, material
properties can also be transferred depending on the variant.

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:

Example of a read property in "plm_metainf-cad.xml"

<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.

All properties provided by default in SLW are listed below.

Default properties for SOLIDWORKS components, assemblies, drawings and materials


Material property Description
Material code in the form
PP-Material
[[SOLIDWORKS material collection]/[Material name]]
PP-Material_Only Material code
PP-Density Material density
PP-DensityUnit Unit of material density used
PP-Surface Surface size
PP-SurfaceUnit Surface unit used
PP-Volume Material volume
PP-VolumeUnit Unit of material volume used

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

Use custom properties

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

Create the appropriate configurations

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.

Sample configuration attributes-to-sap.xml

<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.

Sample configuration attributes-to-sap.xml

<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".

ECTR - Display of Classification

Material-specific mapping

In SOLIDWORKS a distinction is made between variant-dependent and variant-independent mapping of


material properties. This configuration is always set globally and any change to the methodology absolutely
requires the ECTR to be restarted. The changeover from variant-dependent to variant-independent mapping is
performed with the aid of the following parameters.

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.

Example of variant-independent mapping of the unit of weight


in the appropriate SAP field of a material.

<MA field="[SAP-Field name]">


<APPL_ATTRIBUTE name="PP-WeightUnit" />
</MA>

The same goes for the configuration of material classes.

Example of variant-independent mapping of the unit of weight


to a material class

<MA_CLS class="[SAP class name]" classtype="[SAP class type]" characteristic="[SAP


characteristic]">
<APPL_ATTRIBUTE name="PP-WeightUnit" />
</MA_CLS>

"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

<MA field="[SAP-Field name]">


<APPL_ATTRIBUTE name="$(variant)-PP-WeightUnit" />
</MA>

The weight unit can also be written in the material class of the material.

Example for variant-specific mapping of the weight unit to a material class

<MA_CLS class="[SAP-Class name]" classtype="[SAP-Class type]" characteristic="[SAP-


Property]">
<APPL_ATTRIBUTE name="$(variant)-PP-WeightUnit" />
</MA_CLS>

"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

To ensure a correct mapping of material-specific properties, it is necessary to make additional configurations


in the ECTR . A material must always be linked to a configuration so that the specific properties can be written
to this SAP material .The link can be created by a simple Drag & Drop of the material to the appropriate
configuration. Should only a default configuration of the document exist, the already mentioned material link
must be created. The material link can be created as follows.

Creating or assigning materials to documents

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

Linking materials to the document info record

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.

On our homepage you will find further information and news!

CIDEON Software & Services GmbH & Co. KG

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

You might also like