sap engineering control center interface to solid edge ... · cideon software & services gmbh...

CIDEON Software & Services GmbH & Co. KG SAP Engineering Control Center Interface to Solid Edge - Configuration Manual Peterstrasse 1 • D-02826 Görlitz 2018-07-02 14:42 Web: https://www.cideon.com

Configuration Manual

Management of CAD data and documents in SAP

SAP Engineering Control Center Interface to Solid Edge

SAP Engineering Control Center Interface to Solid Edge manages design data in SAP.

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

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

The current version of the manual can be found in the CIDEON Software Portal.

https://support.cideon-software.com/en/SAPECCSE-en


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

- 2 / 70 -


1 Folder structure and directories ............................................................................................................................ 4

1.1 Icons for CAD originals in SAP ECTR ................................................................................................................ 5

1.2 Starting Solid Edge from ECTR in the SAP logon language .............................................................................. 7

2 The configuration files ............................................................................................................................................ 8

2.1 Menu definitions .................................................................................................................................................. 8

2.1.1 menu.guidef ................................................................................................................................................. 8

2.1.2 menu_macros.txt ......................................................................................................................................... 9

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

2.3 default.txt .......................................................................................................................................................... 14

2.4 dtype.xml .......................................................................................................................................................... 23

2.4.1 DType definitions for Solid Edge ............................................................................................................... 24

2.4.1.1 Generic DType definitions .................................................................................................................. 24

2.4.1.2 The DType definitions for master documents .................................................................................... 41

2.4.1.3 The DType definition for nonmaster documents ................................................................................ 60

2.5 options.xml ........................................................................................................................................................ 63

2.6 plm_setenv.bat ................................................................................................................................................. 66

2.7 Version information ........................................................................................................................................... 67

3 Final Remark .......................................................................................................................................................... 70

- 3 / 70 -


1 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\sle is the installation directory of the SAP Engineering Control Center Interface to Solid Edge. It contains the following subdirectories which are significant for configuration:

▪ %PLM_INSTDIR%\applications\sle\appdata ▪ %PLM_INSTDIR%\applications\sle\basis ▪ %PLM_INSTDIR%\applications\sle\documentation ▪ %PLM_INSTDIR%\applications\sle\templates ▪ %PLM_INSTDIR%\applications\sle\template-templates ▪ %PLM_INSTDIR%\applications\sle\customize\config ▪ %PLM_INSTDIR%\applications\sle\template-customize\config

The directory appdata

The SAP Engineering Control Center Interface to Solid Edge 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 CAD-specific actions can be performed from the SAP Engineering Control Center.

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

- 4 / 70 -


The directory customize\config

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

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

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

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!

1.1 Icons for CAD originals in SAP ECTR

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

Detailed information on icons in the SAP Engineering Control Center can be found in the help file "SAP Implementation Guide Icons_EN.pdf", which can be found in the directory "%PLM_INSTDIR%\documentation\Manuals\en".

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.

In the "Application Structure" view, the ECTR may add overlay icons to the displayed icons to visualize certain states in which the displayed objects are located. For the meaning of these symbols, please refer to SAP's ECTR documentation.

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

- 5 / 70 -


Icons for Solid Edge supplied as standard

Symbol Description File name in "images.jar"

Solid Edge single part document DType: Document symbol position 1 tree/sle/solid_edge_part_$(FAMILY)16 with $(FAMILY) = <leer>

tree\sle\solid_edge_part_16.png

Solid Edge family of parts document DType: Document symbol position 1 tree/sle/solid_edge_part_$(FAMILY)16 with $(FAMILY) = g

tree\sle\solid_edge_part_g16.png

Solid Edge alternative part document DType: Document symbol position 1 tree/sle/solid_edge_part_$(FAMILY)16 with $(FAMILY) = i

tree\sle\solid_edge_part_i16.png

Solid Edge sheet metal part document DType: Document symbol position 1 tree/sle/solid_edge_sheet_metal_16

tree\sle\solid_edge_sheet_metal_16.png

Solid Edge assembly document DType: Document symbol position 1 tree/sle/solid_edge_assembly_$(FAMILY)16 with $(FAMILY) = <leer>

tree\sle\solid_edge_assembly_16.pngg

Solid Edge family of assemblies document DType: Document symbol position 1 tree/sle/solid_edge_assembly_$(FAMILY)16 with $(FAMILY) = g

tree\sle\solid_edge_assembly_g16.png

Solid Edge alternative assembly document DType: Document symbol position 1 tree/sle/solid_edge_assembly_$(FAMILY)16 with $(FAMILY) = i

tree\sle\solid_edge_assembly_i16.png

Solid Edge weldment assembly DType: Document symbol position 1 tree/sle/solid_edge_weldment_16

tree\sle\solid_edge_weldment_16.png

Solid Edge drawing master document DType: Document symbol position 1 tree/sle/solid_edge_draft_16

tree\sle\solid_edge_draft_16.png

Solid Edge drawing dependent document DType: Document symbol position 1 (Document is up-to-date compared to the master) tree/sle/solid_edge_draft_16$(NM_OLD) with $(NM_OLD)= 0

Replacement is done in the file "standard_icons.txt". tree/sle/solid_edge_draft_160 = tree/sle/solid_edge_draft_16 Thus the file "tree\sle\solid_edge_draft_16.png" from the archive "images. jar" is used.

Solid Edge drawing dependent document DType: Document symbol position 1 (Document is outdated compared to the master) tree/sle/solid_edge_draft_16$(NM_OLD) with $(NM_OLD)= 1

Replacement is done in the file "standard_icons.txt". tree/sle/solid_edge_draft_161 = tree/sle/solid_edge_draft_16 <<{0}/sap/o_outdated The file "tree\sle\solid_edge_draft_16.png" is overlaid with {0}\sap\o_outdated. {0} stands for the size. Possible values are small, medium, large.

Solid Edge document - single part Workstation Application SEP

tree\file\obr_tree_file_sep.png

Solid Edge document – sheet metal part Workstation Application SES

tree\file\obr_tree_file_ses.png

Solid Edge document – assembly Workstation Application SEA

tree\file\obr_tree_file_sea.png

Solid Edge document – alternative assembly Workstation Application SEM

tree\file\obr_tree_file_sem.png

Solid Edge document – drawing Workstation Application SED

tree\file\obr_tree_file_sed.png

Solid Edge document – drawing Workstation Application SEU

tree\file\obr_tree_file_seu.png

Solid Edge document – weldment assembly Workstation Application SEW

tree\file\obr_tree_file_sew.png

- 6 / 70 -


Picture document Workstation Application BMP

tree\file\obr_tree_file_bmp.png

Configuration document Workstation Application CFG

tree\file\obr_tree_file_cfg.png

Configuration document Workstation Application SEC

tree\file\obr_tree_file_sec.png

Monolithic JT document Workstation Application JTM

tree\file\obr_tree_file_jtm.png

Dynamic JT document Workstation Application JTS

tree\file\obr_tree_file_jtm.png

3D PDF document Workstation Application P3D

tree\file\obr_tree_file_p3d.png

PDF document Workstation Application PDE

tree\file\obr_tree_file_pde.png

Solid Edge Application Menu: System\Start application\Solid Edge

small\app_solid_edge.png

1.2 Starting Solid Edge 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, Solid Edge does not support this!

Unfortunately, there is currently no possibility to realize this technically. Solid Edge is always started in the language in which it was installed.

- 7 / 70 -


2 The configuration files

The files contained in the %PLM_INSTDIR%\applications\slw\customize\config directory serve the CAD-specific configurations of the SAP Engineering Control Center. These files are also marked as preference files and are simple text files that can be edited with a simple ANSI-text editor, i.e. the Windows-specific text editor "Notepad.exe". They are filed there during the installation of the SAP Engineering Control Center Interface to Solid Edge 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 %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!

2.1 Menu definitions

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

2.1.1 menu.guidef

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

Construction of a menu definition

▪ Each individual menu definition begins with a plus sign ('+') in the first column of the line, followed by the menu identification.

▪ The individual functions that appear in the menu are arranged one after the other, in which each menu function is preceded by an equal sign ('=').

▪ In each menu definition, macros, which are defined in the file "menu_macros.txt" or in the general macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt", are referenced by their names which are preceded by a question mark ('?').

▪ Sub-menus in the menu are designated by indentation of the associated menu entries, for which only blank spaces may be used.

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

- 8 / 70 -


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

Definition of the context menu for "Cloning"

# Cloning

+ om.popup.menu.CLONEPOS.DOC_SLEMDL = fnc.doc.clone.option.NO_ACTION

= fnc.doc.clone.option.NEWINTNR_OPTION

= fnc.doc.clone.option.NEWEXTNR_OPTION

= fnc.doc.clone.option.NEWVERS_OPTION

= fnc.doc.clone.option.CHANGE_OPTION

= -----------------------------

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

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.

2.1.2 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

- 9 / 70 -


▪ Each individual macro definition begins with a question mark at the beginning of the line, followed by the macro name. This should be typed using capital letters, to designate it as a macro name.

▪ The individual menu functions belonging to a macro are arranged one after the other, with each menu function being preceded by an equal sign ('=').

▪ Other macros can also be referenced by name within a macro definition, and names should be preceded by a question mark ('?'). These macros can either come from this file itself or from the general macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt".

▪ Sub-menus in the menu are designated by indentation of the associated menu entries, for which only blank spaces may be used.

▪ Tabs are not allowed! ▪ Separators within the menu are represented by a line consisting of dashes ('-'). ▪ Commentaries can be inserted. These are preceded by a '#' at the beginning of the line.

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

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

For each document type (DType), one can define which attributes are trasmitted 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.

Diverse attribute mappings are included in the general configuration files

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

and

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

Should this not be sufficient, however, more CAD-specific attribute mappings can be made.

The file attributes-from-sap.xml

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\acd\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". Here, each DType within the element <primary_application ...> of a section defined in the file "attributes-from-sap.xml" can be ordered by their section name to attribute configuration:

- 10 / 70 -


<primary_application attribute_section="%Name of section%"...>

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="..." Name of attribute division

DTypes are referenced to this attribute segment with this name in the file "dtypes.xml".

include_section="..."

Name of section: "STANDARD", "STDMOD" or "default"

Determines which section will be included from the global "attributes-from-sap.xml" file (%PLM_INSTDIR%/customize/config/attributes-from-sap.xml) in the section defined here.

description="..." Description of attribute sections

This is a comprehensive description of an attribute section.

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

Attributes of the sub-element <APPL_ATTRIBUTE>


name="..." Attribute name Document-side name of the attribute.

hidden="..." true, false Determines whether this is a helper attribute ("true") or a regular document attribute ("false").

- 11 / 70 -


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

Attributes of subelements <DIR> and <MA>


field="..." Field Name

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

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.

row="…" Number 0 - x (Optional) There may be a line of SAP long text to be transferred together. The value indicates the row, starting with 0. If the specified line is not present, an error message is generated.

language="…" SAP language code

Identifier of the language in which the long text is stored in SAP, for 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>

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>

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

Both subelements can be combined:

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




</CUTLEADING>


</XFORMAT>

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

A full description of formatting possiblities is available in the Operations Guide (file "Operations Guide_EN.pdf") in the SAP Engineering Control Center!

- 12 / 70 -


The file 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\acd\customize\config\attributes-to-sap.xml.

Upon saving a CAD document, all atributes 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"

default_section="true">

<DIR field="LONGTEXT" language="EN"> <APPL_ATTRIBUTE name="DESCRIPTION_EN"/>

</DIR>

</section>

<section name="STDMOD" description="Material attribs from CAD to SAP"

default_section="true">

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


name="..." Name of attribute section

DTypes are referenced to this attribute section with this name in the file "dtypes.xml".

default_section="..." true, false Determines if this attribute division describes a default attribute ("true"). The attributes of the division defaults are available in the document. Default segments are always processed.

description="..." Description of attribute sections

This is a comprehensive description of an attribute section.

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

Attributes of subelements <DIR> and <MA>


field="..." Field Name

Name of the document or material field which can be changed in SAP.

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.

language="…" SAP language code

(Optional) If field="LONGTEXT", the identifier of the language will be given in long text to be stored in SAP. Example "EN" = English, "DE" = German, etc.

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

- 13 / 70 -


Attributes of the sub-element <APPL_ATTRIBUTE>


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

Information regarding further possibilities for attribute mapping and the file structure of "attributes-from-sap.xml" and "attributes-to-sap.xml" can be found in the "Operations Guide_EN.pdf" in the SAP Engineering Control Center, which can be found in folder "%PLM_INSTDIR%\documentation\Manuals\en".

2.3 default.txt

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

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

It is to be noted that the parameters of the character string ".SLE" listed here must be included for Solid Edge in order to be assigned to the appropriate CAD system from the SAP Engineering Control Center!

The following table contains all parameters included in the file "default.txt" in delivery status, as well as their default settings:

Parameters of file "default.txt" for Solid Edge

Parameters:

plm.control.partnameRules.applExtension.SLE = par plm.control.partnameRules.applExtension.SLE = asm plm.control.partnameRules.applExtension.SLE = dft plm.control.partnameRules.applExtension.SLE = psm plm.control.partnameRules.applExtension.SLE = pwd

Description: Specifies the file name extension (extension) for an application type

Values: File name extension

Default value:

See under Parameter

Parameter:

Parameter construction: plm.control.empty.dtype.<DOKAR> = <DTYPE> plm.control.empty.dtype.SEA = SEA plm.control.empty.dtype.SEP = SEP plm.control.empty.dtype.SED = SED plm.control.empty.dtype.SES = SES plm.control.empty.dtype.SEW = SEW

Description: Necessary for the parallel operation CDESK / ECTR. As the documents created with CDESK have no DType, a DType can be allocated to every type of document here.

Values: DType identifier

Default value:

See under Parameters

Parameter: plm.document.genericDTypes.SLE

- 14 / 70 -


Description: Specifies the generic DTypes

Values: A list of DTypes, separated by ';'

Default value:

SEP;SEA

Parameter: plm.document.variantDType.SEP

Description: Specifies the variant DTypes


Default value:

See under Parameter

Parameter: plm.control.popwin.name.SLE

Description: Name (caption text), which the main window of the Workstation application identifies to bring it to the foreground. The wild card '*' can be used to output a substring.

Values: Name of main window of the Workstation application and substring, which is a component of the window name (driven by the wild card '*').

Default value:

*Solid Edge*

Parameter: plm.adv.clone.renamerProgram.SLE

Description: During cloning, renaming is necessary through an external program, which must be specified here.

Values: Full path of the program to be renamed

Default value:

@PLM_BINDIR_SLE@\\renamer3sle.exe

Parameter: plm.options.importOnDemand.TransferAttributesToSAP.SLE

Description: If you use an attribute_section for <document_create/> you have to set this option.

Values: "true" = Use an attribute_section for <document_create/> "false" = No using of an attribute_section for <document_create/>

Default value:

false

Parameter: plm.convert.additional.SLE

Description: Specifies to which Solid Edge document types additional formats can be generated.


Default value:

SEA;SEP;SED;SES;SEW;SDM

Parameters:

Parameter construction: plm.convert.additional.SLE.<DOCTYPE1> = <CONVERT TYPE1>;<CONVERT TYPE2> plm.convert.additional.SLE.SEA = jt plm.convert.additional.SLE.SEP = jt plm.convert.additional.SLE.SES = jt plm.convert.additional.SLE.SEW = jt plm.convert.additional.SLE.SED = pdf plm.convert.additional.SLE.SDM = pdf

Description: Specifies which additional file formats should be generated for which Solid Edge document types.

Values:

A list of additional file formats, separated by ';'. The additional format type "3dpdf" creates a simple 3D-PDF of the model.

ATTENTION: The creation of additional 3D-PDF formats is only possible if the corresponding documents are opened in Solid Edge. Otherwise no export is performed and an error message will be written to the log!

Default value:


Parameter: plm.convert.additional.SLE.JT.filenameFormat

- 15 / 70 -


Description:

The names for neutral formats can be configured. The following placeholders are available, which are replaced by the corresponding SAP values: "$ (DOCNUMBER)" : SAP name "$ (DOCTYPE)" : Document category "$ (DOCVERSION)": Document version "$ (DOCPART)" : Document section

Value: String that can contain the allowed placeholders.

Default value:

Number.$(DOCNUMBER)_Type.$(DOCTYPE)_Version.$(DOCVERSION)_Part.$(DOCPART)

Parameter:

Parameter construction: plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.extension = destination Extension plm.convert.additional.SLE.SEA.JT.extension

Description: Specifies which file name extension should have an additional format ("JT" here)

Value: File extension

Default value:

jt

Parameter:

Parameter construction: plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.options = <VALUE> plm.convert.additional.SLE.JT.options

Description: The option exists to set specific options for additional formats (here for "JT"). These can then be assigned a value.

Values: The name of an assigned option

Default value:

Version

Parameter:

Parameter construction: plm.convert.additional.SLE.<DOCTYPE1>.<CONVERT TYPE1>.<OPTION> = <VALUE> plm.convert.additional.SLE.SEA.JT.Version

Description: If a specific option is set for an additional format, this can also be given a value for a Solid Edge document type (here, the document type "SEA").

Values: The value that the option should be assigned

Default value:

9

Parameter: plm.options.CreateDIRForNewDocument.SLE

Description: Determines whether and how a document info record (DIR) should be created in a newly generated document.

Values: '0' = never generate a document info record '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.SaveDIRAfterCreation.SLE

Description:

Save DIR in SAP after creation for New Assembly of Active Model and New Drawing of Active Model.

ATTENTION: When you create a draft from a part, it is saved after positioning the first view, so you cannot insert more than one!

Values: "true" = Save DIR "false" = Do not save

Default value:

false

Parameter: plm.bom.create.SED

Description: Determines whether a bill of materials (BOM) should be generated for drawings (document type SED).

- 16 / 70 -


Values: "true" = Generate BOM "false" = Do not generate BOM

Default value:

false

Parameter: plm.bom.createAtCheckin.SED

Description: Determines whether a bill of materials (BOM) should be generated for drawings (document type SED).

Values: "true" = Generate BOM "false" = Do not generate BOM

Default value:

false

Parameter: plm.bom.updateAtCheckin.SED

Description: Determines whether an existing BOM should be updated during checkin.

Values: "true" = Update BOM "false" = Do not update BOM

Default value:

false

Parameter: plm.bom.update.SED

Description: Determines whether an existing BOM should be updated


Default value:

false

Parameter: plm.document.save.alwaysUpdateStructures

Description: Determines whether an existing BOM should be updated when a connected document is being saved.


Default value:

true

Parameter:

Parameter construction: sap.plm.attributesmapping.CAD_GET_TITLE_BLOCK_DATA.<DOCTYPE1> = <TRUE, FALSE> sap.plm.attributesmapping.CAD_GET_TITLE_BLOCK_DATA.SEA

Description: Determines whether the function module "CAD_GET_TITLE_BLOCK_DATA" should be called up during the update of attributes for a specific document type (here, "SEA").

Values: "true" = Call up function module "false" = Do not call up function module

Default value:

true

Parameter: plm.document.importondemand.searchAlso.SLE

Description: Specifies which paragraph formats belonging to documents should be searched for and imported during the function "Import On Demand."


Default value:

XLS

Parameter: plm.options.updateAttributes.useInteropPrefix.SLE

Description: Determines whether the prefix "UDP-" will be used for user-defined properties ("UDP").

Values: "true" = Use prefix "false" = Do not use prefix

Default value:

true

Parameter: plm.document.SaveAsNewDocument.CheckOutTop.SLE

- 17 / 70 -


Description:

Determines how the parent document should be moved during the functions "save as new document" and "save as new version".

WARNING: Checking out before "save as new document" and "save as new version" does not work with all parent documents in Solid Edge! Therefore this has been disabled by default.

Values: '0' = Do not check out '1' = Check out '2' = Check out and save (intermediate)

Default value:

0

Parameter: plm.document.FOA.Handling.SLE

Description:

Determines whether "Family of Assemblies" (FOA) is supported using MaintainGeneric.

ATTENTION: - Do not use the value '1' in productive environment! - After change Solid Edge and the ECTR has to be restarted!

Values: '0' = No special handling for FOAs '1' = Use MaintainGeneric

Default value:

0

Parameter: plm.doc.checkout.allowedFamilyMembersApplTypes

Description: Specifies which members of Family of Assemblies (FOA) should be able to check out.

Values: List of Application Types

Default value:

SLE;@plm.doc.checkout.allowedFamilyMembersApplTypes@

Parameter: plm.document.variantKeepVersion.SLE

Description: Specifies whether Generic Factories should keep its members during versioning.

Values: "true" = Yes "false" = No

Default value:

true

Parameter: plm.convert.additional.FamilyMembers.SLE

Description: Specifies whether additional formats should be created for members of FOAs.


Default value:

true

Parameter: plm.document.variants.importOnDemand.SAPDescription.SLE

Description: Defines the SAP description for members of FOAs.

Values: '1' = Member name in Solid Edge '2' = SAP description of Template/Generic DIR '3' = SAP description of Template/Generic DIR and member name in Solid Edge

Default value:

3

Parameter: plm.options.importOnDemand.loadDrawings.SLE

Description:

Determines whether drawings with reference to the actual model will be imported too.

ATTENTION: This option may decrease performance if activated!

Values: "true" = Import "false" = Do not import

- 18 / 70 -


Default value:

false

Parameter: plm.options.save.loadDrawings.SLE

Description:

Determines whether drawings with reference to the actual model will be saved too.

ATTENTION: This option may decrease performance if activated!

Values: "true" = Save "false" = Don't save

Default value:

false

Parameter: plm.doc.cancel.restore.files.SLE

Description: Determines the action during the function "Cancel, discard changes."

Values: "true" = Reset the local copy to the last check-in point "false" = Delete the local copy from the session directory

Default value:

false

Parameter: plm.structure.application.CollectEntries.SLE

Description: Determines whether multiple built-up components in the structure overview of the ECTR will be displayed individually or summarily.

Values: "collectNone" = No summary. Every instance will be shown individually "collectAll" = Summarize all instances. Represent only a node with the total number

Default value:

collectNone

Parameter: plm.structure.application.LoadDrawings.SLE

Description: Determines whether drawings which have reference to model will be displayed on "Load"

Values: "true" = Display drawings which have reference to model "false" = Don't display drawings which have reference to model

Default value:

false

Parameter: plm.structure.application.init.strategy.levels.SLE

Description: Number of levels which should be submitted to application structure.

Values: <Number> 1-n = Number of levels "all" = Complete structure

Default value:

1

Parameter: plm.control.waitForSessionInMs.SLE

Description: Maximum wait time for an application to send a request to ECTR once it has been contacted successfully.

Values: Time in ms.

Default value:

15000

Parameter: plm.Occurrence.IncludeInBOM.SLE

Description:

Specify the SORTF for occurrences which are not included in assembly reports (Reports/Parts List = No).

ATTENTION: If changed this option Solid Edge and the ECTR must restarted!

Values: SORTF string

Default value:

WU

Parameter: plm.Occurrence.UserDefinedQuantity.SLE

- 19 / 70 -


Description:

Specifiy the SORTF for occurrences with UserDefinedQuantity = 0. The SAP Engineering Control Center to Solid Edge doesn't consider "UserDefinedQuantity" for excluded occurrences, if you set Reports/Parts List = No and UserDefinedQuantity = 0 you will get the SORTF defined with this parameter.


Values: SORTF string

Default value:

@plm.Occurrence.IncludeInBOM.SLE@

Parameter: plm.document.explode.hiddenExternalReferencesSortf.SLE

Description: For cloning: Explode external references.

Values: Y, N

Default value:

Y

Parameter: plm.options.SapOpenForCadOpenDocument.SLE

Description: Decides which open file dialog will be used.

Values: '0' = Use CAD default dialog '1' = Use SAP engineering control center dialog '2' = Ask user

Default value:

2

Parameter: plm.loadoptions.SLE.ShowCADOpenDialog

Description: Defines whether the CAD dialog will be used for open during "Load".


Default value:

true

Parameters:

plm.document.dtype.Default.SEA.SLE = SEA plm.document.dtype.Default.SEP.SLE = SEP plm.document.dtype.Default.SES.SLE = SES plm.document.dtype.Default.SEW.SLE = SEW plm.document.dtype.Default.SDM.SLE = SEDM

Description: Defines the default DType assignment

Values: DType

Default value:


Parameter: plm.options.open.UseMultiSearchForSapOpen.SLE

Description: Choose which ECTR open dialog should be used when opening a document from SAP. Enabling this option will let you open multiple documents at once.

Values: "true" = Use multi search dialog "false" = Use single search dialog

Default value:

true

Parameter: plm.options.structureAnalyze.showDialogForMissingReferences.SLE

Description:

Defines whether a dialog will be shown when find a missing reference during structure analysis.


Values: "true" = Show dialog "false" = Don't show dialog

- 20 / 70 -


Default value:

true

Parameter: plm.options.deliverOnlyRequestedAttributesToSAP.SLE

Description:

Defines wether all existing or only requested attributes will be transferred.


Values: "true" = transfer only requested attributes "false" = transfer all existing attributes

Default value:

true

Parameter: plm.options.checkIn.AbortAnalysisOfCheckedInComponents.SLE

Description:

Defines the check in strategy.

ATTENTION: - Can greatly influence the performance for complex document structures! - If changed this option Solid Edge and the ECTR must restarted!

Values: "true" = Only check in components, which have documents in their structure or are themselves locally modified and/or checked out. "false" = Always analyse and check in the complete document structure wether components were modified or not.

Default value:

true

Parameter: plm.options.Thumbnail.Size.SLE

Description: Sets the size of thumbnails for the ECTR preview.

Value: Size of the thumbnails in pixels. Applies to height and width.

Default value:

180

Parameters:

Parameter structure: plm.options.BOMTable.Column.SLE.[CAD_COLUMN] = [SAP_FIELD] plm.options.BOMTable.Column.SLE.Material = MATERIAL_EXT plm.options.BOMTable.Column.SLE.Postext1 = POSTEXT1 plm.options.BOMTable.Column.SLE.Postext2 = POSTEXT2 plm.options.BOMTable.Column.SLE.OtherColumn = POSTEXT2

Description:

If a BOM table exists and it contains a column with the name [CAD_COLUMN] values within this column will be updated with the content of [SAP_FIELD].

ATTENTION: These configuration options are available from patch 12 of the interface!

Values:

Implemented values (tags) for [SAP_FIELD]. Possible values are: "MATERIAL" = Internal material number, returned in return table "ET_BALLOONS", column "MATERIAL" "MATERIAL_EXT" = External material number, returned in return table "ET_BALLOONS", column "MATERIAL_EXT" "POSTEXT1" = Value returned in return table "ET_BALLOONS", column "POSTEXT1" "POSTEXT2" = Value returned in return table "ET_BALLOONS", column "POSTEXT2"

Default value:

See under "Parameters"!

Parameter: plm.options.BOMTable.AddNonExistingColumns.SLE

Description:

Add non existing columns to BOM Table If a column of name [CAD_COLUMN] does not exist in the BOM table add this column and update the value with the content of [SAP_FIELD].


- 21 / 70 -


Values: "true" = Add Columns "false" = Do not add columns

Default value:

true

Parameters:

Parameter structure: plm.tree.workdir.unknown.files.exclude.SLE.[Category] = [Regular Expression] plm.tree.workdir.unknown.files.exclude.SLE.CFG = .*\.(?i)(cfg) plm.tree.workdir.unknown.files.exclude.SLE.CadCache = .*\.(?i)(db) plm.tree.workdir.unknown.files.exclude.SLE.LogFiles = .*\.(?i)(log) plm.tree.workdir.unknown.files.exclude.SLE.CollectionOfExtensions = .*\.(?i)(jt|jpg|jpeg|bmp)

Description: With this setting you can hide unknown files that are located in the working directory.

Values: The filter expression is specified as Regular Expression.

Default value:

See under "Parameters"!

Parameters: plm.execute.additional.SLE

Description:

It is possible to execute additional functions before or after a specific PLM process by starting either an executable file (external tool) or the powershell. The following specifications are possible: 1.) Specifies the time of execution per document type: plm.execute.additional.SLE.<DOCTYPE>.<EXEC TIME> Possible options for <EXEC TIME> are: - "BeforeCheckIn": Execute before checkin - "AfterCheckOut": Execute after checkin - "AfterBallooning": Execute after ballooning Example: plm.execute.additional.SLE.SEA.BeforeCheckIn 2.) Specifies the type of additional function: plm.execute.additional.SLE.<DOCTYPE>.<EXEC TIME>.type = [EXEC TYPE] Possible options for are: - "Executable": External tool - "Powershell": Starts the Windows powershell Example: plm.execute.additional.SLE.SEP.BeforeCheckIn.type = Executable 3.) Specifies the name of the external program, macro or command: plm.execute.additional.SLE.<DOCTYPE>.<EXEC TIME>.commandLine = [CMDLINE] Example: plm.execute.additional.SLE.SEA.BeforeCheckIn.commandLine = D:\\Data\\Tools\\ExternalTool.exe

NOTE: Executables need a valid file path with escaped backslashes! Example: "D:\\Data\\Tools\\ExternalTool64.exe" 4.) 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.SLE.SEA.BeforeCheckIn.parameter1 = $(FILENAME) plm.execute.additional.SLE.SEA.BeforeCheckIn.parameter2 = Test-User

Hint: For executables and power shell calls, the parameters can also be given as arguments (only the parameter values).

- 22 / 70 -


Values: See "Description"!

Default value:

---

Parameter: plm.loadoptions.versionConflictResolveMode.SLE

Description:

Resolves version conflicts when multiple versions of the same DIR are required.

NOTE: - Only works when filenames include versions! - Use "auto" if the file name contains version numbers and the loading option "As last saved" is used!

Values: "all" = Always load all versions for all documents. "auto" = Load only necessary versions.

Default value:

auto

Parameter: plm.options.checkIn.UpdateAttributesFromSAP.SLE

Description: During Save, update attributes of documents to checkin from SAP before transferring them to SAP.

Values: "true" = Update attributes before save "false" = Do not update attributes before save

Default value:

false

Parameter:

plm.document.AS.Selection.SLE = true plm.document.AS.Selection.ScrollTo.SLE = false plm.structure.application.CollectEntries.SLE = collectNone plm.structure.application.LoadDrawings.SLE = true plm.structure.application.init.strategy.levels.SLE = -1

Description:

Defines default settings for the display in the application structure.

These settings can be accessed in the ECTR preferences for Solid Edge under "Application structure".

Values: The values are stored in the configuration file "options.xml". For information on which values are possible for the individual parameters, see the documentation for the SAP Engineering Control Center.

Default value:

See under Parameter!

2.4 dtype.xml

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

Structure

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

- 23 / 70 -


.

.

.

</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 Solid Edge are described here.

2.4.1 DType definitions for Solid Edge

With the installation of the SAP Engineering Control Center interface to Solid Edge 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 following are the descriptions of the individual definitions for Solid Edge documents.

2.4.1.1 Generic DType definitions

The generic definitions are templates with basic definitions that are valid for all Solid Edge document types. Templates are integrated in the other DType definitions. Two DType templates are defined for Solid Edge:

▪ "SLEMDL" for parts and assemblies ▪ "SLEDRW" 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:

Generic DType definition for Solid Edge parts and assemblies

<DType type="template" identifier="SLEMDL" include_template="DEFLT"

application_type="SLE" group="Solid Edge">

<description language="EN" text="Solid Edge 3D Documents"/>

- 24 / 70 -


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

dirty_flag="yes"

attempt_status_change_on_checkin="yes" function_group="DOC_SLEMDL"

customer_data_section="SLEMDL" auto_adjust_application_role="no">

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

<new_version status_list="AC;FR;PR;IW;SW" ignore_wsappl_list="ZIP"

ignore_nm_dtype_list=""/>

</program_options>

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

document_number_assignment="internal"

initial_document_number="*" document_type="SEA"

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

attribute_section="SLEMDL"

update_attributes_for_dirty="yes"

update_attributes_for_rw="yes"

update_attributes_for_ro="no">

<container_file>

<plmfile extension="ecf" workstation_application="ECF" description="ECtr

container file"/>

</container_file>

<checkout_rules check_references_on_edit="yes"

rename_master_original_at_checkout="no"

one_version_in_session_only="no" hardlink_in_session="no">

</checkout_rules>

<checkin_rules from_application_only="yes">

<save_direct>

<plmfile extension="jpg" workstation_application="EPJ" description="Preview

(jpeg)"/>

<plmfile extension="gif" workstation_application="EPG" description="Preview

(gif)"/>

<plmfile extension="jt" workstation_application="JT" description="3D

Preview"/>

<plmfile extension="bmp" workstation_application="BMP" description="BMP"/>

<plmfile extension="pdf" workstation_application="PDF" description="PDF"/>

<plmfile filename_pattern=".*_mono\.rh" workstation_application="RHM"

description="Monolithic RH"/>

<plmfile filename_pattern=".*_mono\.vds" workstation_application="RHM"

description="Monolithic VDS"/>

- 25 / 70 -


<plmfile extension="rh" workstation_application="RH"

description="$(FILENAME)"/>

</save_direct>

<ignore>

<plmfile extension="bak"/>

<plmfile extension="xml"/>

<plmfile extension="tmp"/>

<plmfile filename_pattern="VEConverterResponse\.xml"/>

</ignore>

<delete_in_sap>

<plmfile workstation_application="EPG"/>

<plmfile workstation_application="EPJ"/>

<plmfile workstation_application="JT"/>

</delete_in_sap>

<delete_in_session>

<plmfile extension="jpg"/>

<plmfile extension="gif"/>

<plmfile extension="jt" />

<plmfile extension="bmp"/>

<plmfile extension="pdf"/>

<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="DOCNUMBER=$(doc_nr)"/>


<param name="DOCPART=$(doc_part)"/>


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

<view_files>

<plmfile workstation_application="XLS"/>

</view_files>

- 26 / 70 -


<ignore_files>



<plmfile workstation_application="JT"/>

</ignore_files>

</additional_files>

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

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

</DType>

Attribute of the element <DType>

Attribute Value Description

type "template" Determines the type of DType definition. "template" = This is a DType template definition.

identifier "SLEMDL"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID must be between one to five characters long. "SLEMDL" = ID of this template definition.

include_template "DEFLT" Determines which template definition should be integrated into this definition. "DEFLT" = The DType template with ID "DEFLT" from the global "dtype.xml" file is included.

application_type "SLE"

Designates the application that is relevant for this document (Workstation Applikation). This application opens the file from SAP Engineering Control Center. "SLE" = This is the Workstation Application for (WSAppl) for Solid Edge.

group "Solid Edge"

Defines the group designation for master documents. The group designation helps to organize DTypes within the dialog "Create document". "Solid Edge" = 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


show_for_create "yes"

Determines whether in dialogue "Create document " this DType is visible in the combo box for accessible document types. "yes" = Document is visible.

has_primary_application "yes"

Determines if document is normal document with original and designated Workstation Application or container object for additional originals without explicit original. "yes" = the document has an original with the designated Workstation application

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

- 27 / 70 -


attempt_status_change_on_checkin "yes"

Determines if change of status applies during check in at SAP Engineering Control Center or if SAP System conducts change of status. "yes" = Change of status by SAP Engineering Control Center.

function_group "DOC_SLEMDL"

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

customer_data_section "SLEMDL"

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 ECTR under the tab "Customer data". "SLEMDL" = Name of section.

auto_adjust_application_role "no" Turns the automatic adaptation of the "application role" in RES4 in SAP on or off. "no" = No automatic adaptation.

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>


allowed "yes" Determines if a CopyAs action is permitted for this DType. "yes" = "CopyAs" - operation permitted.

ignore_wsappl_list "ZIP"

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 semicolon. "ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied.

use_initial_version "yes"

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

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

Attribute to the sub-element <program_options>


status_list "AC;FR;PR;IW;SW"

Determines the type of document status that allows versioning of documents. A list of document statuses can be given separated by ";". "AC;FR;PR;IW;SW" = 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 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.

ignore_nm_dtype_list ""

Determines which depending documents will be ommitted during versioning of master documents. Depending documents to be omitted will be listed in a table of DTypes, separated by semicolon. "" = No document types will be ignored.

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>

- 28 / 70 -



create_with_SAP_GUI "no"

Determines if SAP GUI should be opened when creating a document. "no" = Do not open SAP GUI.

create_multi_allowed "no"

Determines if the mass creation of this document is allowed. "no" = Mass creation of this document is not permitted.

document_number_assignment "internal" Determines the document number assignment in SAP. "internal" = SAP assigns the number automatically.

initial_document_number "*"

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 dialogue when the number is externally assigned. "*" = Due to internal number assignment without meaning.

document_type "SEA" SAP document type for the newly created document. "SEA" = SAP document type.

initial_document_part "000" Sets the initial value of the part number for documents. "000" = Initial value of the doucment part number.

part_editable "no"

Defines whether the the default value or the selected SAP partial document from the "initial_document_part" attribute can be changed in the input field in the documentation system dialog for SAP Engineering Control Center. "no" = Default value cannot be changed.

initial_document_version "00" Sets the initial value of the part number for documents. "00" = Initial value of the version number.

version_editable "no"

Defines whether the the default value for the document version can be changed in the documentation system dialog of SAP Engineering Control Center. "no" = No changes in default values are allowed.

change_to_after_create_status "AC" Initial status of newly created document can be set here. "AC" = Identification of the initial status.

filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"

Determines composition of file name of the original of a document. The following place holders are possible: $(DOCNUMBER) for the document number, $(DOCTYPE) for the document type and $(DOCPART) for the partial document. "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" = The file name consists of document number, document type, and partial document.

filename_template_version ""

Determines the composition of the document version in the file name for the original of this document. The following 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>

- 29 / 70 -



material_creation_method "deferred"

Determines whether and how a new document is created from materials. "deferred" = No material is applied to the document. You can attach materials subsequently to this document.

material_number_assignment "internal"

Defines material number assignment in the SAP system. The values are the same as that of the document number assignment. "internal" = The SAP system assigns the number automatically.

material_type "FERT;HALB" Material type or a ';'-separated list of material types for the new material that is to be created. "FERT;HALB" = List of SAP material types.

material_template "" Template material with which the material attachments can be processed. "" = No material template specified.

material_plant_assignment "" Initial value for the assigned plant. "" = No initial work assigned.

material_default_class "" Indicates the standard class for the material. "" = 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.

Attributes of the sub-element <primary_application>


primary_workstation_application "SED" "SED" = Identification of the SAP workstation application for the original.

attribute_section "SLEMDL"

Name of the section within the Attribute Mapping File in which attribute exchanges between SAP and the application (Solid Edge) are defined. "SLEMDL" = Name of section within the Attribute Mapping file.

update_attributes_for_dirty "yes" Defines whether to update the attributes when the dirty flag is set. "yes" = Perform attribute update.

update_attributes_for_rw "yes" Defines the attribute update for the action "Open for editing". "yes" = Perform attribute update.

update_attributes_for_ro "no" Defines the attribute update with the action "Open as read-only". "no" = Do not perform an attribute update.

The <container_file> sub-element 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>


extension "ecf" Filters by file name extensions in the file system. "ecf" = File name extension.

workstation_application "ECF" Filters original documents according to the workstation application. "ECF" = Identification of the workstation application.

description "ECtr container file" Filters original documents according to their description. "ECtr container file" = Description of originals that will be used for filtering.

- 30 / 70 -


The sub-element <checkout_rules> determines how to treat the original of document at checkout.

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

Parameter Values Description

check_references_on_edit "yes"

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 abandoned. "yes" = Run test.

rename_master_original_at_checkout "no" Defines if the original is renamed during opening according to rules for component names. "no" = Keep file name during opening.

one_version_in_session_only "no" Determines if this document must have only one version in the session directory. "no" = Multiple versions of the document are allowed in the session directory.

hardlink_in_session "no"

Determines if hard link may be used for original document in the session directory or if a copy must always be created. "no" = Always create a copy.

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>


from_application_only "yes" "yes" = Prevents a document from being checked in without CAD in the 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>


extension "jpg", "gif", "jt", "bmp", "pdf", "rh"

The respective file name extensions of additional files in the file system. "jpg", "gif", "jt", "bmp", "pdf", "rh" = The respective file name extensions.

workstation_application "EPJ", "EPG", "JT", "BMP", "PDF", "RHM", "RH"

Workstation application identifiers for each additional format. "EPJ", "EPG", "JT", "BMP", "PDF", "RHM", "RH" = Identification of the document types.

description "Preview (jpeg)", "Preview (gif)", "3D Preview", "BMP", "PDF", "Monolithic RH", "Monolithic VDS", "$(FILENAME)"

Description of each respective additional file. "Preview (jpeg)", "Preview (gif)", "3D Preview", "BMP", "PDF", "Monolithic RH", "Monolithic VDS", "$(FILENAME)" = Description of the additional files.

filename_pattern ".*_mono\.rh", ".*_mono\.vds" Filters by file names and regular expressions. ".*_mono\.rh", ".*_mono\.vds" = Filter masks.

The <ignore> sub-element determines which files will be ignored when saving. It includes multiple of the <plmfile> sub-elements that determine the additional file types to ignore.

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

- 31 / 70 -



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

filename_pattern "VEConverterResponse\.xml" Filters by file names and regular expressions. "VEConverterResponse\.xml" = Filter mask.

The sub-element <delete_in_sap> determines which original documents should be deleted during check in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that determine the additional file types to delete.

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


workstation_application "EPJ", "EPG", "JT" Workstation application identifiers for each paragraph style. "EPG", "EPJ", "JT" = Identifiers for workstation application.

The <delete_in_session> sub-element 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 <plmfile> sub-elements, of the <delete_in_session> sub-element from <checkin_rules>


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

The sub-element <scripts> contains scripts that are executed before checking in. Individual scripts are included in the sub-element <script>.

Attributes of the <plmfile> sub-elements, of the <delete_in_session> sub-element from <checkin_rules>


name "@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat"

Sets the entire call path of the script to run. "@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat" = script call path "VEConverter.bat".

<script> contains the sub-element <params>, which determins parameters to be passed to the running script. For this purpose, it includes one or more sub-elements <param>, each of which defines a parameter.

Attributes of the sub-elements <param>, sub-element <params>, sub-element <script>, sub-element <scripts> from <checkin_rules>


Name

"convertfile", "$(masterfile)", "--output-directory", "$(add_dir)", "--output-format", "RH", "--sap-identifier", "DOCUMENT=$(doc_type)*$(doc_nr)*$(doc_part)*$(doc_vr)", "--sap-metadata", "DOCTYPE=$(doc_type)", "--sap-metadata", "DOCNUMBER=$(doc_nr)", "--sap-metadata", "DOCPART=$(doc_part)", "--sap-metadata", "DOCVERSION=$(doc_vr)", "--import-setting", "LoadExternalFiles=false"

Contains the name of each parameter defined. This partly contain variable data in the form of placeholders ("$ (...)").

- 32 / 70 -


The sub-element <additional_files> determines which additional formats display a document in SAP Engineering Control Center for editing.

Attributes of the <additional_files> sub-element


enable_additional_files "yes" Determines if additional originals are permitted for this document. "yes" = Additional originals are permitted.

The sub-element <view_files> determines which of the additional originals on the document displayed in the original container cannot be processed. This original can only be displayed. For this purpose it contains lt subelements of type <plmfile>, which define the individual document types.

Attributes of the sub-elements <plmfile> of the subelement <view_files> from <additional_files>


workstation_application "XLS" The identification of the document type can not be edited. "XLS" = Identification of the document types.

The sub-element <ignore files> is determined, which additional originals are NOT displayed on the document in its original container of a document in SAP Engineering Control Center. For this purpose it contains lt subelements of type <plmfile>, which define the individual document types.

Attributes of the sub-elements <plmfile> of the sub-element <view_files> from <additional_files>


workstation_application "EPJ", "EPG", "JT" The identifiers of the document types that should not be displayed. "EPJ", "EPG", "JT" = Identification of the document types.

The sub-element <allowed_nonmaster> determines the type of document (Nonmaster document) that is accepted as a dependent document.

Attribute of the sub-element <allowed_nonmaster>


DType "SED", "VWINM" The unique ID of the DType definition of the dependent document. "SED", "VWINM" = DTypes of the allowed dependent documents.

max_count "99" Allowable number of dependent documents for this master document. "99" = Maximum possible number of dependent documents for this document type.

Below, you can find the definition of the templates for the DType definition of Drawings:

Generic DType definition for Solid Edge drawings

<DType type="template" identifier="SLEDRW" include_template="DEFLT"

application_type="SLE" group="Solid Edge">

<description language="EN" text="Solid Edge 2D Documents"/>

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

dirty_flag="yes"

attempt_status_change_on_checkin="yes" function_group="DOC_SLEDRW"

customer_data_section="SLEDRW" auto_adjust_application_role="no">

- 33 / 70 -


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

copy_material="no" remove_dirty_flag="no"/>


ignore_nm_dtype_list=""

remove_dirty_flag="no"/>

</program_options>

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

document_number_assignment="internal"

document_type="SED" initial_document_part="000"

part_editable="yes"

initial_document_version="00" version_editable="yes"

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

attribute_section="SLEDRW"

update_attributes_for_dirty="yes"

update_attributes_for_rw="yes"

update_attributes_for_ro="no">

<container_file>

<plmfile extension="ecf" workstation_application="ECF" description="ECtr

container file"/>

</container_file>

<checkout_rules check_references_on_edit="yes"

rename_master_original_at_checkout="no"

one_version_in_session_only="no" hardlink_in_session="no">

</checkout_rules>

<checkin_rules from_application_only="yes">

<save_direct>

<plmfile extension="jpg" workstation_application="EPJ" description="Preview

(jpeg)"/>

<plmfile extension="gif" workstation_application="EPG" description="Preview

(gif)"/>

<plmfile extension="bmp" workstation_application="BMP" description="BMP"/>

<plmfile extension="pdf" workstation_application="PDF" description="PDF"/>

</save_direct>

<ignore>

<plmfile extension="bak"/>

<plmfile extension="xml"/>

<plmfile extension="tmp"/>

</ignore>

<delete_in_sap>

- 34 / 70 -




</delete_in_sap>

<delete_in_session>

<plmfile extension="jpg"/>

<plmfile extension="gif"/>

<plmfile extension="bmp"/>

<plmfile extension="pdf"/>

</delete_in_session>

</checkin_rules>


<additional_files enable_additional_files="yes">

<view_files>

<plmfile workstation_application="XLS"/>

</view_files>

<ignore_files>



</ignore_files>

</additional_files>

</DType>

Attributes of the <DType> element


type "template" Determines the type of DType definition. "template" = This is a DType template definition.

identifier "SLEDRW"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SLEDRW" = ID of this template definition.

include_template "DEFLT" Determines which template definition should be integrated into this definition. "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 Center. "SLE" = This is the Workstation Application (WSAppl) for Solid Edge.

group "Solid Edge"

Defines the group designation for master documents. The group designation helps to organize DTypes within the dialog "Create document". "Solid Edge" = 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


- 35 / 70 -


show_for_create "yes"

Determines whether in dialogue "Create document " this DType is visible in the combo box for accessible document types. "yes" = Document is visible.

has_primary_application "yes"

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

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

attempt_status_change_on_checkin "yes"

Determines if change of status applies during check in at SAP Engineering Control Center or if SAP System conducts change of status. "yes" = Change of status by SAP Engineering Control Center.

function_group "DOC_SLEDRW"

Sets the Function Group to which the document belongs. For documents with a common Function Group, for example, specific context menus can be defined. "DOC_SLEDRW" = Identifier of the function group.

customer_data_section "SLEDRW"

Name of a section in the attribute mapping file that is defined in customer-specific data. The data is displayed in the Object Browser ECTR under the tab"Customer information". "SLEDRW" = Name of the section.

auto_adjust_application_role "no" Turns automatic adjustment of "application role" in RES4 in SAP on or off. "no" = No automatic adjustment.

The sub-element <copy_as> specifies how the document behaves with a "CopyAs" action, and how the SAP Engineering Control Center reacts on this document.

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


allowed "yes" Determines if a CopyAs is permitted for this DType. "yes" = "CopyAs" - Action is allowed.


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 semicolon. "ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied.

use_initial_version "yes"

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

copy_material "no" Determines whether the assigned material is copied when copying the master document. "no" = Material is not copied.

remove_dirty_flag "no" Determines if dirty flag of copy will be reset. "no" = The dirty flag in the copy remains set.

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

Attributes to the sub-element <program_options>


- 36 / 70 -


status_list "AC;FR;PR;IW;SW"

Determines the type of document status that allows visioning of documents. A list of document statuses can be set, delimited by durch ";". "AC;FR;PR;IW;SW" = New versions are allowed with this document status.


Determines which additional originals of the document will be accepted during versioning but not into new version of document according to a 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 ommitted during versioning of master documents. Depending documents to be omitted will be listed in a table of DTypes, separated by semicolon. "" = No document types to ignore are specified.

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

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



create_with_SAP_GUI "no"

Determines if SAP GUI should be opened when creating a document. "no" = Do not open SAP GUI.

create_multi_allowed "no"

Determines if the mass creation of this document is allowed. "no" = Mass creation for this document is not allowed.

document_number_assignment "internal"

Defines material number assignment in the SAP system. The values are the same as that of the document number assignment. "internal" = SAP assigns the number automatically.

document_type "SED" SAP document type for the newly created document. "SED" = SAP dokument type.

initial_document_part "000" Sets the initial value of the part number for documents. "000" = Initial value of the document part number.

part_editable "yes"

Defines whether the system dialog of SAP Engineering Control Center can use the preset value or the attribute "initial_document_part" of the selected SAP Document part in the entry field. "yes" = The initial value can be changed.

initial_document_version "00" Sets the initial value of the part number for documents. "00" = Initial value of the version number.

version_editable "yes"

Determines whether the default value for the document version can be changed in the document creation dialog of the SAP Engineering Control Center. "yes" = Changes in default values are allowed.

change_to_after_create_status "AC" Initial status of newly created document can be set here. "AC" = The initial status.

- 37 / 70 -


filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)"

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 partial document. "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" = The file name consists of the document number, document type, and document part.

filename_template_version ""

Determines the composition of the document version in the file name for the original of this document. The following placeholder can be used: $(DOCVERSION) for the document version. "" = No version in the file name.




material_creation_method "deferred"

Determines whether and how a new document is created from Materials. "deferred" = No material is applied to the document. You can attach Materials subsequently to this document.

material_number_assignment "internal"

Defines material number assignment in the SAP system. The values are the same as that of the document number assignment. "internal" = SAP assigns the number automatically.

material_type "FERT;HALB" Material type or a ';'-separated list of material types for the new material to be created. "FERT;HALB" = List of SAP material types.

material_template "" The material template with which the creation of material will be performed. "" = No material template specified.

material_plant_assignment "" Initial value for the assigned work. "" = No initial assigned work.

material_default_class "" Indicates the standard class for the material. "" = No standard class for the material.


Attribute of the sub-element <primary_application>


primary_workstation_application "SED" "SED" = Identification of the SAP Workstation Application for the original.

attribute_section "SLEDRW"

Name of section within the Attribute Mapping File, in which attribute exchanges between SAP and the application (Solid Edge) are defined. "SLEDRW" = Name of the section in the Attribute Mapping File.

update_attributes_for_dirty "yes" Defines if to update the attributes when dirty flag was set. "yes" = Perform attribute update.

update_attributes_for_rw "yes" Defines the attribute update with the action "Open for edit". "yes" = Perform attribute update.

- 38 / 70 -


update_attributes_for_ro "no" Defines the attribute update with the action "open for read-only viewing". "yes" = Don't perform attribute update.

The <container_file> sub-element 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>


extension "ecf" Filters by file name extensions in the file system. "ecf" = File name extension.

workstation_application "ECF" Filters original documents according to the workstation application. "ECF" = Identification of the workstation application.

description "ECtr container file" Filters original documents according to their description. "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


check_references_on_edit "yes"

Defines whether with the function "open for editing" for all referenced components, the files can be provided in the session directory. Test has been done with it. If not, operation will be abandoned. "yes" = Perform check.

rename_master_original_at_checkout "no" Defines if the original is renamed during opening according to rules for component names. "no" = Keep file name during opening.

one_version_in_session_only "no" Determines if this document must have only one version in the session directory. "no" = Multiple versions of the document are allowed in the session directory.

hardlink_in_session "no"

Determines if hard link may be used for original document in the session directory or if a copy must always be created. "no" = Always create a copy.

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>


from_application_only "yes" "yes" = Prevents a document from being checked in without CAD in the 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.



- 39 / 70 -


extension "jpg", "gif", "bmp", "pdf" The respective file name extensions of additional files in the file system. "jpg", "gif", "bmp", "pdf" = Each file name extension.

workstation_application "EPJ", "EPG", "BMP", "PDF"

Identification of the Workstation application for the individual additional formats. "EPJ", "EPG", "BMP", "PDF" = Identification of the document types.

description "Preview (jpeg)", "Preview (gif)", "BMP", "PDF"

Description of the respective additional file. "Preview (jpeg)", "Preview (gif)", "BMP", "PDF" = Identification of additional file types.

The <ignore> sub-element determines which files will be ignored when saving. It includes multiple <plmfile> sub-elements that determine the additional file types to ignore.

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


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

The sub-element <delete_in_sap> determines which original documents should be deleted during check in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that determine the additional file types to delete.

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


workstation_application "EPG", "EPJ" Identification of the Workstation application for the individual additional formats. "EPG", "EPJ" = Identifiers for workstation application.

The <delete_in_session> sub-element 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 sub-element <plmfile> of sub-element <delete_in_session> by <checkin_rules>


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

The sub-element <additional_files> determines which additional formats display a document in SAP Engineering Control Center for editing.

Attributes of the <additional_files> sub-element


enable_additional_files "yes" Determines if additional originals are permitted for this document. "yes" = Additional originals are permitted.

The sub-element <view_files> determines which of the additional originals on the document displayed in the original container cannot be processed. This original can only be displayed. For this purpose it contains lt subelements of type <plmfile>, which define the individual document types.

- 40 / 70 -




workstation_application "XLS" The identification of the document type can not be edited. "XLS" = Identification of the document types.

The sub-element <ignore files> is determined, which additional originals are NOT displayed on the document in its original container of a document in SAP Engineering Control Center. For this purpose it contains lt subelements of type <plmfile>, which define the individual document types.



workstation_application "EPJ", "EPG" The identifiers of the document types that should not be displayed. "EPJ", "EPG" = Identification of the document types.

2.4.1.2 The DType definitions for master documents

The SAP Engineering Control Center distinguishes between master documents and dependent documents. The master document is the main document and contains the CAD model file to be processed. In addition, the master document is the basis for the preparation of the bill of materials. The DType definition of master documents is devided into the DType definitions for assemblies ("SEA"), parts ("SEP"), drawings ("SEDM"), sheet metal parts "SES") and weldment assemblies ("SEW").

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

DType definition of master documents of type "SEA" for Solid Edge

<DType type="master" identifier="SEA" include_template="SLEMDL"

application_type="SLE" application_role="A">

<description language="EN" text="Solid Edge Assembly"/>

<icon>

<icondef icon_position="1" icon_group="default"

icon_identifier="tree/sle/solid_edge_assembly_$(FAMILY)16"/>

</icon>

<program_options>



take_instances_for_generic="yes" />

</program_options>

<document_create document_type="SEA" document_number_assignment="internal">

<seedfile filename="Asm.asm" type="template" default="yes">

<description language="EN" text="Asm.asm"/>

</seedfile>

- 41 / 70 -


<seedfile filename="Asm.asm" type="select" default="no" extension_filter="*.asm">

<description language="EN" text="select existing file"/>

</seedfile>

</document_create>

<material_create material_creation_method="linkOnly"

material_number_assignment="exit"/>

<primary_application primary_workstation_application="SEA">

<checkin_rules>

<save_direct>

<plmfile extension="jpg" workstation_application="EPJ"

description="Preview (jpeg)"/>

<plmfile extension="gif" workstation_application="EPG"

description="Preview (gif)"/>

<plmfile extension="jt" workstation_application="JTM"

description="3D Preview"/>

<plmfile extension="bmp" workstation_application="BMP"

description="BMP"/>

<plmfile extension="pdf" workstation_application="PDF"

description="PDF"/>

<plmfile extension="rh" workstation_application="RHM"


<plmfile filename_pattern=".*_mono\.rh" workstation_application="RHM"


<plmfile filename_pattern=".*_mono\.vds" workstation_application="RHM"

description="Monolithic VDS"/>

</save_direct>

<replace_primary_file>

<plmfile extension="*.asm"/>

</replace_primary_file>

</checkin_rules>

<first_level_files>

<plmfile extension="cfg" workstation_application="CFG" description="Assembly

config file"/>

</first_level_files>


</DType>

Attributes to the element <DType> of definition "SEA"


type "master" Sets the type of DType definition. "master" = This is a DType definition for master documents.

identifier "SEA"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SEA " = ID of this DType definition.

include_template "SLEMDL" Determines which template definition should be integrated into this definition. "SLEMDL" = The DType template with the ID "SLEMDL" from this "dtype.xml" file is included.

- 42 / 70 -



Designates the application that is relevant for this document (Workstation Application). This application opens the file from SAP Engineering Control Center. "SLE" = This is the Workstation Application for Solid Edge (WSAppl).

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

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

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


icon_position "1" Position of icon in the document entry of the tree. "1" = Left, "6" = right.

icon_group "default"

Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon.

icon_identifier "tree/sle/solid_edge_assembly_$(FAMILY)16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_assembly_$(FAMILY)16" = The icon file.

The <program_options> sub-element contains various settings that control the behavior of the document in the SAP Engineering Control Center. It contains the sub-element <new_version> which contains settings for versioning documents.

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

Attribute VValue Description

status_list "AC;FR;PR;IW;SW" Determines which document statuses are allowed for versioning. "AC;FR;PR;IW;SW" = List of permitted document statuses.


Determines which additional original documents are not copied to the new version of the document during versioning. "ZIP" = List with workstation application identifiers.


Determines which dependent documents (nonmaster DTypes) are not required for versioning the master document. "" = List of DTypes (here empty!).

take_instances_for_generic "yes"

Defines whether the entire part family group (generic part + variants) is versioned during versioning of the generic part. "yes" = Version the entire part family group.

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



document_type "SEA" SAP document type for the newly created document. "SEA" = Solid Edge Assembly-Dokument.

- 43 / 70 -



The <seedfile> sub-element contains settings for the template file. Several template files can be assigned, in other words the <seedfile> may occur more than once. This includes the <description> sub-element, which defines each description text in different languages.

Attributes to the first sub-element <seedfile> inherited from the sub-element <document_create>


filename "Asm.asm"

When using type="template", this attribute defines the file name of the template file that is used. There must be a file with this name, or the process will terminate with an error. "Asm.asm" = File name of the template file that is to be used.

type "template" Determines how the original document will be generated. "template" = The "filename" attribute is used to specify the template file that is to be used.

default "yes" Here you can determine whether this template file should be used as a preset in the "Create Document" dialog. "yes" = This template file is preset.

extension_filter "*.asm"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.asm" = Filter for the file extension.

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


filename "Asm.asm"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Asm.asm" = Dateiname der Vorlagendatei.

type "select"

Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "select" = It is possible to select a template file in the "Create Document" dialog.

Default "no" Here you can determine whether this template file should be used as a preset in the "Create Document" dialog. "no" = The template file is not preset.

extension_filter "*.asm"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.asm" = Filter for the file extension.




material_creation_method "linkOnly"

Determines whether and how a new document is created from Materials. "linkOnly" = No material is created for the document. An object link is generated from the document to the material that does not exist yet.

- 44 / 70 -


material_number_assignment "exit" Defines material number assignment in the SAP system. "exit" = Number assignment takes place via a user exit.




primary_workstation_application "SEA" "SEA" = SAP workstation application identifier for Solid Edge Assemblies.

The sub-element <checkin_rules> determines how files in the additional directory and document originals are treated when checking in. This is why it has multiple sub-elements. The sub-element <save_direct> determines which additional files (paragraph styles) are stored as originals in the additional directory when saving. It contains one ore more sub-elements <plmfile> to determine the types additional files.



extension "jpg", "gif", "jt", "bmp", "pdf", "rh"

The respective file name extensions of additional files in the file system. "jpg", "gif", "jt", "bmp", "pdf", "rh" = File extensions.

workstation_application "EPJ", "EPG", "JTM", "BMP", "PDF", "RHM"

Workstation application identifiers for each paragraph style. "EPJ", "EPG", "JTM", "BMP", "PDF", "RHM" = IDs of the document types.

description "Preview (jpeg)", "Preview (gif)", "3D Preview", "BMP", "PDF", "Monolithic RH", "Monolithic VDS", "$(FILENAME)"

Description of the respective additional file. "Preview (jpeg)", "Preview (gif)", "3D Preview", "BMP", "PDF", "Monolithic RH", "Monolithic VDS", "$(FILENAME)" = Description of the additional files.

filename_pattern ".*_mono\.rh", ".*_mono\.vds" Filters by file names and regular expressions. ".*_mono\.rh", ".*_mono\.vds" = Filter masks.

The sub-element <replace_primary_file> defines whether the original of a document can be replaced using drag & drop or a menu function and which files are permissible for this. It contains the sub-elemet <plmile> to specify the filter conditions for the files to be stored directly in the document.

Attribute of the sub-element <plmfile> of the sub-element <replace_primary_file> of <checkin_rules>


extension "*.asm" Filters according to the extensions for file names in the file system. "*.asm" = File name extension.

The sub-element <first_level_files> defines which additional originals are stored alongside the original in the document in the session directory during checkout. It contains the sub-element <plmfile> to define the file types.

Attributes of the sub-element <first_level_files>


extension "cfg" Filters according to the extensions for file names in the file system. "cfg" = File name extension.

- 45 / 70 -


workstation_application "CFG" ID of the workstation application for the additional file type. "CFG" = ID of the file type.

description "Assembly config file" Description of the additional file type. "Assembly config file" = Description.

The DType definition of Solid Edge FOA documents:

DType definition of FOA master documents of type "SEM" for Solid Edge

<DType type="master" identifier="SEM" include_template="SLEMDL"


<description language="EN" text="Solid Edge FOA Member"/>

<icon>


icon_identifier="tree/sle/solid_edge_assembly_$(FAMILY)16"/>

</icon>

<program_options show_for_create="no">

<copy_as allowed="no"/>



rename_master_original="no"/>

</program_options>

<document_create document_type="SEM" document_number_assignment="internal"

rename_template_filename="no"

filename_template_base="">

<seedfile filename="FOA.asm" type="select" default="no"

filename_pattern=".*\.asm![0-z]*">

<description language="EN" text="select existing file" />

</seedfile>

</document_create>



<primary_application primary_workstation_application="SEM">

<checkin_rules>


<plmfile filename_pattern=".*\.asm![0-z]*"/>


</checkin_rules>


</DType>

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



- 46 / 70 -


identifier "SEM"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SEM" = ID of this DType definition.

include_template "SLEMDL"

Sets which template definition will be integrated into this definition. "SLEMDL" = The DType template with the "SLEMDL" ID from this "dtype.xml" file is included. This is the generic definition.


Designates the application that is relevant for this document (Workstation Application). This application opens the file from SAP Engineering Control Center. "SLE" = The workstation application (WSAppl) for Solid Edge.

application_role "A" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "A" = ID of the object type for assemblies.







icon_identifier "tree/sle/solid_edge_assembly_$(FAMILY)16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_assembly_$(FAMILY)16" = The icon file.

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

Attributes of sub-element <program_options>


show_for_create "no"

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

The <copy_as> subelement contains various settings that determine how the document behaves in the case of a "CopyAs".

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


allowed "no" Specifies whether a "CopyAs" is allowed for this DType. The setting includes the Clone dialog. "no" = "CopyAs" not allowed for this DType.

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

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

- 47 / 70 -



status_list "AC;FR;PR;IW;SW" Determines which document statuses are allowed for versioning. "AC; FR; PR; IW; SW" = List of permitted document statuses.


Determines which additional original documents are not copied to the new version of the document during versioning. "ZIP" = List with workstation application identifiers.


Determines which dependent documents (nonmaster D types) are not required for versioning the master document. "" = List of DTypes (here empty!).

rename_master_original "no"

Specifies whether the file name of the original file is the same as the part rules for this DType, or whether the existing file name is retained unchanged. "no" = File name of the previous version unchanged.

The sub-element <document_create> determines, the document creation in SAP.



document_type "SEM" SAP document type for the newly created document. "SEM" = Solid Edge assembly document as FOA member.


rename_template_filename "no"

Specifies whether the file name for the original is to be renamed according to the set naming rules or whether the file name of the template file is copied unchanged during the creation of the document. "no" = The file name of the template file is copied unchanged for the original in the document.

filename_template_base "" Specifies how the filename for the original in this document is composed. "" = No rules specified.


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


filename "FOA.asm"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "FOA.asm" = Name of the template file.

type "select"

Specifies how the original of the document is generated. In the "Create Document" dialog, you can select a template file by using the file selection dialog. "select" = Choosing the template file is possible.

default "no" This attribute can be used to set a template file to default, which is preset in the "Create Document" dialog. "no" = The template file is not preset.

filename_pattern ".*\.asm![0-z]*"

Enhanced filter option for restricting the selection of a template file from the file system using a regular expression (Regular Expression, RegExp). ".*\.asm![0-z]*" = Filter for the template file.

- 48 / 70 -











primary_workstation_application "SEM" "SEM" = ID of the workstation application for Solid Edge FOA documents.

The sub-element <checkin_rules> determines how files in the additional directory and document originals are treated when checking in. The sub-element <replace_primary_file> defines whether the original of a document can be replaced using drag & drop or a menu function and which files are permissible for this. It contains the sub-element <plmile> to specify the filter conditions for the files to be stored directly in the document.

Attribute of the sub-element <plmfile> of the sub-element <replace_primary_file> of <checkin_rules>


filename_pattern ".*\.asm![0-z]*"

Enhanced filter option for restricting the selection of a template file from the file system using a regular expression (Regular Expression, RegExp). ".*\.asm![0-z]*" = Filter for the file.

It follows the description of the DType definition for Solid Edge part documents:

DType definition of master documents of type "SEP" for Solid Edge part documents

<DType type="master" identifier="SEP" include_template="SLEMDL"

application_type="SLE" application_role="P">

<description language="EN" text="Solid Edge Part"/>

<icon>


icon_identifier="tree/sle/solid_edge_part_$(FAMILY)16"/>

</icon>

<document_create document_type="SEP" document_number_assignment="internal">

<seedfile filename="Part.par" type="template" default="yes">

<description language="EN" text="Part.par" />

</seedfile>

<seedfile filename="Part.par" type="select" default="no"

extension_filter="*.par">

<description language="EN" text="select existing file" />

</seedfile>

</document_create>

- 49 / 70 -




<primary_application primary_workstation_application="SEP">

<checkin_rules>


<plmfile filename_pattern=".*\.par"/>


</checkin_rules>


</DType>

Attributes to the element <DType> of definition "SEP"



identifier "SEP"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SEP" = ID of this DType definition.





application_role "P" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "P" = ID of the object type for parts.







icon_identifier "tree/sle/solid_edge_part_$(FAMILY)16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_part_$(FAMILY)16" = The icon file.



- 50 / 70 -



document_type "SEP" SAP document type for the newly created document. "SEP" = Solid Edge part document.



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


filename "Part.par"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Part.par" = File name of the template file.





filename "Part.par"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Part.par" = File name of the template file.

type "select"



extension_filter "*.par"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.par" = Filter for the file extension.






- 51 / 70 -






primary_workstation_application "SEP" "SEP" = ID of the workstation application for Solid Edge parts.


Attribute der Unterelemente <plmfile> des Unterelementes <replace_primary_file> von <checkin_rules>


filename_pattern ".*\.par"


Description of the DType definition of Solid Edge part documents for sheet metal parts ("SES"):

DType definition of master documents of type "SES" for Solid Edge sheet metal part documents

<DType type="master" identifier="SES" include_template="SLEMDL"

application_type="SLE" application_role="P">

<description language="EN" text="Solid Edge Sheet Metal"/>

<icon>


icon_identifier="tree/sle/solid_edge_sheet_metal_16"/>

</icon>

<document_create document_type="SES" document_number_assignment="internal">

<seedfile filename="Sheet Metal.psm" type="template" default="yes">

<description language="EN" text="Sheet Metal.psm" />

</seedfile>

<seedfile filename="Sheet Metal.psm" type="select" default="no"

extension_filter="*.psm">

<description language="EN" text="select existing partfile" />

</seedfile>

</document_create>



<primary_application primary_workstation_application="SES">

<checkin_rules>


<plmfile filename_pattern=".*\.psm"/>


- 52 / 70 -


</checkin_rules>


</DType>

Attributes to the element <DType> of definition "SES"



identifier "SES"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SES" = ID of this DType definition.





application_role "P" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "P" = ID of the object type for parts.







icon_identifier "tree/sle/solid_edge_sheet_metal_16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_sheet_metal_16" = The icon file.




document_type "SES" SAP document type for the newly created document. "SES" = Solid Edge sheet metal part document.


- 53 / 70 -





filename "Sheet Metal.psm"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Sheet Metal.psm" = File name of the template.





filename "Sheet Metal.psm"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Sheet Metal.psm" = File name of the template file.

type "select"


default "no"

Here you can determine whether this template file should be used as a preset in the "Create Document" dialog. "no" = The template file is not preset.

extension_filter "*.psm"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.psm" = Filter for the file extension.






material_number_assignment "exit" "exit" = Number assignment takes place via a user exit.




primary_workstation_application "SES" "SES" = ID of the workstation application for Solid Edge sheet metal part documents.

- 54 / 70 -



Attributes of the sub-element <plmfile> of the sub-element <replace_primary_file> of <checkin_rules>


filename_pattern ".*\.psm"


DType definition of Solid Edge assembly documents for weldments ("SEW"):

DType definition of master documents of type "SEW" for Solid Edge weldments

<DType type="master" identifier="SEW" include_template="SLEMDL"


<description language="EN" text="Solid Edge Weldment"/>

<icon>


icon_identifier="tree/sle/solid_edge_weldment_16"/>

</icon>

<document_create document_type="SEW" document_number_assignment="internal">

<seedfile filename="Normal.pwd" type="select" default="no"

extension_filter="*.pwd">


</seedfile>

</document_create>


material_number_assignment="exit" />

<primary_application primary_workstation_application="SEW">

<checkin_rules>


<plmfile filename_pattern=".*\.pwd"/>


</checkin_rules>


</DType>

Attributes to the element <DType> of the definition "SES"



identifier "SEW"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SEW" = ID of this DType definition.

- 55 / 70 -






application_role "A" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "A" = ID of the object type for assemblies.





icon_group "default" Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon.

icon_identifier "tree/sle/solid_edge_weldment_16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_weldment_16" = The icon file.




document_type "SEW" SAP document type for the newly created document. "SEW" = Solid Edge weldment assembly.



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


filename "Normal.pwd"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Normal.pwd" = File name of the template file.

type "select"


- 56 / 70 -


default "no"

Here you can determine whether this template file should be used as a preset in the "Create Document" dialog. "no" = The template file is not preset.

extension_filter "*.pwd"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.pwd" = Filter for the file extension.










primary_workstation_application "SEW" "SEW" = ID of the workstation application for Solid Edge weldment assembly documents.


Attributes to the sub-element <plmfile> of sub-element <replace_primary_file> of <checkin_rules>


filename_pattern ".*\.pwd"


DType definition of Solid Edge master drawing documents ("SEDM"):

DType definition of master documents of type "SEDM" for Solid Edge drawings

<DType type="master" identifier="SEDM" include_template="SLEDRW"

application_type="SLE" application_role="D">

<description language="EN" text="Solid Edge Draft - Master"/>

<icon>


icon_identifier="tree/sle/solid_edge_draft_16"/>

</icon>

<document_create document_type="SDM">

- 57 / 70 -


<seedfile filename="Draft.dft" type="template" default="yes"

component_reference="no">

<description language="EN" text="Draft.dft" />

</seedfile>

<seedfile filename="Draft.dft" type="select" default="no"

extension_filter="*.dft">


</seedfile>

</document_create>

<material_create material_creation_method="no"/>

<primary_application primary_workstation_application="SED"/>

</DType>

Attributes to the element <DType> of definition "SEDM"



identifier "SEDM"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SEDM" = ID of this DType definition.

include_template "SLEDRW"

Determines which template definition should be integrated into this definition. "SLEDRW" = The DType template with the "SLEDRW" ID from this "dtype.xml" file is included. This is the generic definition.



application_role "D" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "A" = ID of the object type for drawings.





icon_group "default" Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon.

icon_identifier "tree/sle/solid_edge_draft_16" Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/sle/solid_edge_draft_16" = The icon file.


- 58 / 70 -




document_type "SDM" SAP document type for the newly created document. "SDM" = Solid Edge drawings (master).





filename "Draft.dft"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Draft.dft" = File name of the template.


default "yes"

Here you can determine whether this template file should be used as a preset in the "Create Document" dialog. "yes" = This template is preset.

component_reference "no"

Specifies whether the dependent document contains a component reference (identified in sort term ':DC') or whether the document is a simple dependent document (identifier 'D'). When the master is opened, dependent documents with component references are made available in the same way as any available components in the session directory of the user. "no" = Dependent documents without component reference.




The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Draft.dft" = File name of the template.

type "select"



extension_filter "*.dft"

When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.dft" = Filter for the file extension.



- 59 / 70 -



material_creation_method "no"

Determines whether and how a new document is created from Materials. "no" = No material is created for the document. For this document, material cannot be created subsequently via SAP Engineering Control Center.




primary_workstation_application "SED" "SED" = ID of the workstation application for Solid Edge drawing documents.

2.4.1.3 The DType definition for nonmaster documents

The SAP Engineering Control Center distinguishes between master documents and dependent documents. The latter are referred to as nonmaster documents and are assigned to their respective master documents.

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

Here are the DType definitions of nonmaster documents for Solid Edge for the type "SED"-nonmaster:

DType definition for nonmaster documents for Solid Edge

<DType type="nonmaster" identifier="SED" include_template="SLEDRW"

application_type="SLE" application_role="D">

<description language="EN" text="Solid Edge Draft - NonMaster"/>

<icon>


icon_identifier="tree/sle/solid_edge_draft_16"/>

</icon>

<nonmaster_options create_mastercomp_name="DummyRef.asm"/>

<document_create document_type="SED" document_number_assignment="master">

<seedfile type="template" extension_filter="*.dft" default="no"

filename="Draft_Ref.dft"

component_reference="yes">

<description language="EN" text="Standard drawing ref"/>

</seedfile>

<seedfile filename="Draft.dft" type="template" default="yes"

component_reference="no">

<description language="EN" text="Draft.dft"/>

</seedfile>

<seedfile filename="Draft.dft" type="select" default="no"

extension_filter="*.dft">

- 60 / 70 -


<description language="EN" text="select existing partfile"/>

</seedfile>

</document_create>

<material_create material_creation_method="no"/>

<primary_application primary_workstation_application="SED"/>

</DType>

Attribute of the element <DType> of the "SED" definition


type "nonmaster" Sets the type of DType definition. "nonmaster" = It's a matter of a DType definition for nonmaster documents.

identifier "SED"

Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one and five characters long. "SED" = ID of this DType definition.

include_template "SLEDRW"

Determines which template definition should be integrated into this definition. "SLEDRW" = The DType-Template with the ID "SLEDRW" from this "dtype.xml" file is included. This is the generic definition for Solid Edge Drawings.


Designates the application that is relevant for this document (Workstation Application). This application opens the file from SAP Engineering Control Center. "SLE" = This is the Workstation Application for (WSAppl) for Solid Edge.

application_role "D" Here you can adjust the object type in the RES4 field of the SAP tableDRAW. "D" = ID of the object type for Drawings.

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

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


icon_position "1" Position of the symbol in the document entry in the tree. "1" = far left, "6" = far right.


Identification of a symbol group. Depending on the status, other symbols can be represented. "default" = This is the standard symbol.

icon_identifier "tree/slw/solidworks_draft_$(FAMILY)16"

Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_draft_$(FAMILY)16" = The icon file.

The sub-element <nonmaster_options> is used to control how the dependent document responds in relation to the master document.

Attribute of the sub-element <nonmaster_options>

Attribut Wert Beschreibung

- 61 / 70 -


create_mastercomp_name "DummyRef.asm"

Specifies the name of the reference to the master document in the template file in the document creation of the dependent document. "DummyRef.asm" = Name of the reference to the master document in the template file.

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

Attributes of the sub-element <document_create>


document_type "SED" SAP document type for the newly created document. "SED" = Solid Edge Drawing as nonmaster document.

document_number_assignment "master" Determines the document number assignment in SAP. "master" = The number of the master document is adopted.


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

Attribut Wert Beschreibung



When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.dwg" = Filter for the file extension.

default "no"

This determines whether this template file should be used as a preset in the "Create Document" dialog. "no" = The template file is not preset.

filename "Draft_Ref.dft"

The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Draft_Ref.dft" = File name of the template file.

component_reference "yes"

Determines whether a dependent document gets a component reference (definition in the sorting term: 'DC') or whether the document is a simple dependent document (definition 'D'). "yes" = A component reference is generated.




When using type="template", this attribute defines the file name of the template file that is used. There must be a file with this name, or the process will terminate with an error. "Draft.dft" = File name of the template file that is to be used.


default "yes" This determines whether this template file should be used as a preset in the "Create Document" dialog. "yes" = The template file is preset.

- 62 / 70 -


component_reference "no"

Determines whether a dependent document gets a component reference (definition in the sorting term: 'DC') or whether the document is a simple dependent document (definition 'D'). "no" = Dependent document has no component reference.

Attributes of the third <seedfile> sub-element inherited from the <document_create> sub-element



The "filename" attribute is used to specify the template file that is to be used. You can create a template file in the "Create Document" dialog using a file selection dialog. "Draft.dft" = File name of the template file.

type "select"

Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. You can select a template file in the "Create document" dialog using a file selection dialog. "select" = It is possible to select a template file in the "Create document" dialog.

Default "no" This determines whether this template file should be used as a preset in the "Create Document" dialog. "no" = The 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 dialog you can select files that are matched by the filter. "*.dwg" = Filter for the file extension.




material_creation_method "no"

Determines whether and how a new document is created from Materials. "no" = No material is applied to the document. You can not attach materials to this document later through SAP Engineering Control Center.

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



primary_workstation_application "SED" "SED" = Identification of the SAP workstation application for Solid Edge Drawings.

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

- 63 / 70 -


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:

Structure of the file "options.xml"

<options>

<structure>

<node label="...">

<node card="<<Card X>>"/>

<node card="<<Card Y>>"/>

- 64 / 70 -


...

</node>

</structure>

<card name="<<Card X>>">

<option label="..." type="..." prefname="..." tooltip="..."/>

<option label="..." type="..." prefname="..." tooltip="...">

<entry name="..." value="..."/>



</option>

...

</card>

<card name="<<Card Y>>">

<option label="..." type="..." prefname="..." tooltip="..." maxchars="...">



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


label="..." Name (Optional) If attribut exists, a folder icon with the given name will appear. Below you will find the cards arranged under a branch, defined as in the following.

card="..." Card identifier

Defines an entry in the tree diagram, which contains changeable parameters (preferences), and which will appear on the right when clicked. The adjustable 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="Solid Edge">

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

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.

- 65 / 70 -


Attribut of element <card>


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>


label="..." Name or description of the option

Description of the option as appears on the card under "Description"

type="..." Data type file type of the option. The following are possible: "string", "boolean", "long"

prefname="..." Parameter name The complete name of the preference from file "default.txt"

tooltip="..." Description of the option (Optional) Description of the option. Appears as tooltip, when mouse cursor is positioned on the option

maxchars="..." Number (Optional) Maximum possible number of signes or characters 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>


name="..." Name Name of value in the list

value="..." Value accordung to attribute "type" from element <option> Value, which is given to parameter at choice

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.

2.6 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 Solid Edge after launch. As this deals with a traditional batch file, command line instructions such as "set" and "if" can also be used here, as well as contents of already existing environment variables, with the notation "%<<Variable name>>%".

Note: As the SAP Engineering Control Center Interface to Solid Edge 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!

- 66 / 70 -


2.7 Version information

To gain an overview of the imported changes of the relevant releases of the SAP Engineering Control Center Interface to Solid Edge, the changes are listed here in the configuration files "default.txt" und "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

02.13.81.00

plm.options.BOMTable.AddNonExistingColumns.SLE

plm.options.checkIn.UpdateAttributesFromSAP.SLE

02.12.79.00

plm.document.variants.importOnDemand.SAPDescription.SLE

02.12.72.00

plm.loadoptions.versionConflictResolveMode.SLE

plm.execute.additional.SLE

02.12.71.00

plm.convert.additional.SLE

02.12.66.00

plm.options.BOMTable.Column.SLE.Material

plm.options.BOMTable.Column.SLE.Postext1

plm.options.BOMTable.Column.SLE.Postext2

plm.options.BOMTable.Column.SLE.OtherColumn

plm.options.Thumbnail.Size.SLE

plm.convert.additional.SLE.JT.filenameFormat

02.11.62.00

plm.options.SaveDIRAfterCreation.SLE

plm.document.FOA.Handling.SLE

plm.doc.checkout.allowedFamilyMembersApplTypes

plm.document.variantKeepVersion.SLE

02.10.58.00

plm.options.checkIn.AbortAnalysisOfCheckedInComponents.SLE

02.09.52.00

plm.options.deliverOnlyRequestedAttributesToSAP.SLE

02.08.50.00

plm.options.new.SaveActiveDocument.SLE

plm.options.OnFileOpenUI.DeactivatedForAddin.ST9.SLE

plm.options.Ballooning.InitializeString.SLE

plm.options.SapOpenForLoadDrawing.SLE

plm.doc.cancel.restore.files.SLE

- 67 / 70 -


02.07.49.00

plm.options.OnFileOpenUI.DeactivatedForAddin.ST9.SLE

plm.options.open.UseMultiSearchForSapOpen.SLE

plm.options.structureAnalyze.showDialogForMissingReferences.SLE

plm.document.Import.IgnoreMissingReferences.SLE

02.06.47.00

plm.options.new.SaveActiveDocument.SLE

plm.options.SapOpenForLoadDrawing.SLE

plm.options.importOnDemand.updateAttributes.SLE

02.05.40.00

plm.structure.application.init.strategy.levels.SLE

plm.loadoptions.SLE.ShowCADOpenDialog

plm.document.SaveAsNewDocument.CheckOutTop.SLE

02.04.36.00

plm.options.SapOpenForCadOpenDocument.SLE

plm.Occurrence.IncludeInBOM.SLE

plm.Occurrence.UserDefinedQuantity.SLE

plm.options.Ballooning.InitializeString.SLE

plm.options.importOnDemand.TransferAttributesToSAP.SLE

plm.document.dtype.Default.SEA.SLE

plm.document.dtype.Default.SEP.SLE

plm.document.dtype.Default.SES.SLE

plm.document.dtype.Default.SEW.SLE

plm.document.dtype.Default.SDM.SLE

02.03.32.00

plm.structure.application.LoadDrawings.SLE

plm.options.importOnDemand.loadDrawings.SLE

plm.options.save.loadDrawings.SLE

plm.options.CreateDIRForNewDocument.SLE

02.02.27.00

plm.document.Import.IgnoreMissingReferences.SLE

02.01.22.00

plm.structure.application.CollectEntries.SLE

01.03.15.00

plm.options.updateAttributes.useInteropPrefix.SLE

01.02.14.00

plm.options.CreateDIRForNewDocument.SLE

- 68 / 70 -


01.00.11.00

plm.convert.additional.SLE

plm.convert.additional.SLE.SEA

plm.convert.additional.SLE.SEP

plm.convert.additional.SLE.SES

plm.convert.additional.SLE.SEW

plm.convert.additional.SLE.SED

plm.convert.additional.SLE.SDM

plm.convert.additional.SLE.SEA.JT.extension

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

Changes in configuration file "dtype.xml"

Version Description

02.11.62.00

▪ The template definitions for "SLEMDL" and "SLEDRW" have got the attribute from_application_only="yes" in their checkin_rules.

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

▪ The DType definitions "SEA" and "SEM" have both got the sub-element <program_options> added.

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

- 69 / 70 -


3 Final Remark

This manual is intended to aid in the use of the product. Because the development of this product is also ongoing, this document applies to the release available at the time of printing. CIDEON Software & Services GmbH & Co. KG is grateful for comments and suggestions from users. Please contact us in this regard via the CIDEON Service Portal (ticket system).

This documentation was prepared with the greatest of care; however, we cannot accept liability for any errors or omissions therein.

You will find additional information and news on our Website!

CIDEON Software & Services GmbH & Co. KG

www.cideon.com

Copyright © 2018 CIDEON Software & Services GmbH & Co. KG. All rights reserved.

No portion of this document may be reproduced or copied by any means or for any purpose without the express permission of CIDEON Software & Services GmbH & Co. KG.

- 70 / 70 -

https://service.cideon.com/

https://www.cideon.com/