SAP Engineering Control Center Interface to SOLIDWORKS - Configuration Manual

Transcription

1 Configuration manual Management of CAD data and documents in SAP SAP Engineering Control Center Interface to SOLIDWORKS SAP Engineering Control Center Interface to SOLIDWORKS manages the design data in SAP. SAP Engineering Control Center Interface links the CAD system closely to the SAP PLM Interface and makes data available to the company early-on in the design process. Product Lifecycle Management begins as soon as the design has started instead of through an interface at the end of the design phase. By coupling the CAD system and the SAP Engineering Control Center, the components designed in the CAD system can be managed. You can configure the SAP Engineering Control Center Interface to SOLIDWORKS in many different ways and adapt it to your own requirements and working methods. This configuration manual presents the possible configurations and describes the procedures and configuration parameters in detail.

2 2018. Germany. All Rights Reserved. Contents of this document may not be (totally or partly) reproduced, used or published without previous written agreement by the. 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 / 85 -

3 1 Folder structure and directories Icons for CAD originals in SAP ECTR Manual installation of SAP Engineering Control Center Interface to SOLIDWORKS Starting SOLIDWORKS from ECTR in the SAP logon language The configuration files Menu definitions menu.guidef menu_macros.txt attributes-from-sap.xml and attributes-to-sap.xml default.txt Parameter transfer as XML file when calling external tools or macros dtype.xml DType definitions for SOLIDWORKS Generic DType definitions DType definition for master documents DType definition for nonmaster documents options.xml plm_setenv.bat rfc-tunnel-whitelist.txt Version information Configuration examples Mapping the properties Available properties Use custom properties Material-specific mapping Variant-specific Variant-independent Final Remark / 85 -

4 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\slw is the installation directory of the SAP Engineering Control Center Interface to SOLIDWORKS. It contains the following subdirectories which are significant for configuration: %PLM_INSTDIR%\applications\slw\appdata %PLM_INSTDIR%\applications\slw\basis %PLM_INSTDIR%\applications\slw\documentation %PLM_INSTDIR%\applications\slw\templates %PLM_INSTDIR%\applications\slw\template-templates %PLM_INSTDIR%\applications\slw\customize\config %PLM_INSTDIR%\applications\slw\template-customize\config The directory appdata The SAP Engineering Control Center Interface to SOLIDWORKS has a toolbar in CAD next to the main menu that contains its functions as buttons. In the subdirectory icons contained here, all of the symbols used for these toolbar buttons can be found in two sizes: 16 x 16 and 32 x 32 pixels. The directory basis Here, the following directories are included: aux-files: Contains the data "standard_icons.txt". This determines which 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 / 85 -

5 The directory customize\config Here, files can be found that are necessary for the configuration of the SAP Engineering Control Center Interface to SOLIDWORKS. These are: default.txt dtype.xml options.xml menu.guidef menu_macros.txt plm_setenv.bat attributes-from-sap.xml attributes-to-sap.xml rfc-tunnel-whitelist.txt At the start of SOLIDWORKS, these files are evaluated and override the basic installation of the SAP Engineering Control Center that is filed under %PLM_INSTDIR%\customize\config and add additional CAD-specific configurations that are not included in the basic configuration, for example specific types of documents, workstation applications and menu items. The directory 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 templatecustomize\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\slw\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 SOLIDWORKS: - 5 / 85 -

6 Icons for SOLIDWORKS supplied as standard Symbol Description File name in "images.jar" SOLIDWORKS single part document DType: Document symbol position 1 tree/slw/solidworks_part_$(family)16 with $(FAMILY) = <leer> SOLIDWORKS assembly document DType: Document symbol position 1 tree/slw/solidworks_assembly_$(family)16 with $(FAMILY) = <leer> SOLIDWORKS drawing master document DType: Document symbol position 1 tree/slw/solidworks_drawing_16 SOLIDWORKS drawing dependent document (Document is up-to-date compared to the master) DType: Document symbol position 1 tree/slw/solidworks_drawing_16$(nm_old) with $(NM_OLD)= 0 SOLIDWORKS drawing dependent document (Document is outdated compared to the master) DType: Document symbol position 1 tree/slw/solidworks_drawing_16$(nm_old) with $(NM_OLD)= 1 SOLIDWORKS document - single part Workstation Application SWP SOLIDWORKS document assembly Workstation Application SWA SOLIDWORKS document drawing Workstation Application SWD SOLIDWORKS Application Menu: System\Start application\solidworks tree\slw\solidworks_part_16.png tree\slw\solidworks_assembly_16.png tree\slw\solidworks_drawing_16.png Replacement is done in file "standard_icons.txt". tree/slw/solidworks_drawing_160 = tree/slw/solidworks_drawing_16 Thus the file "tree\slw\solidworks_drawing_16.png" from the archive "images. jar" is used. Replacement is done in file "standard_icons.txt". tree/slw/solidworks_drawing_161 = tree/slw/solidworks_drawing_16 <<{0}/sap/o_outdated The file "tree\slw\slw\solidworks_drawing_16.png" is overlaid with {0}\sap\o_outdated. {0} stands for the size. Possible values are small, medium, large. tree\file\obr_tree_file_swp.png tree\file\obr_tree_file_swa.png tree\file\obr_tree_file_swd.png small\app_solidworks.png 1.2 Manual installation of SAP Engineering Control Center Interface to SOLIDWORKS Integration of SAP Engineering Control Center Interface to SOLIDWORKS in the user interface of SOLIDWORKS happens during the automatic installation without the requirement of the interference of user. Prerequisite for a manual installation is the availability of file "CdnEctrInterfaceSWx64.zip" Manual instillationis executed as follows: Unpack the content of the file "CdnEctrInterfaceSWx64.zip" completely as per %PLM_INSTDIR%\applications\slw\basis\sys\win\bin. Register the module "CdnECTRInterfaceSWx_64.dll" with the Microsoft tool "regsvr32.exe". Start the SOLIDWORKS and search in the dialog "additional applications" as per the entry "SAP Engineering Control Center Interface to SOLIDWORKS" and activate both corresponding control check boxes. If this entry should not be available, end the SOLIDWORKS and execute the registration of "CdnEctrInterfaceSWx64.zip" again. Instruction: Parallel operation with the CIDEON CDESK-Interface to SOLIDWORKS is not supported due to partially different data model! Other information for this is available under Problems during parallel operation with CIDEON CDESK-Integration). - 6 / 85 -

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

8 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 SOLIDWORKS with standard settings for this interface. The standard settings are chosen so that typical usage scenarios are covered. Should this not be enough, the reaction of the interface and the SAP Engineering Control Center should adapt appropriately. Next to the central configuration files in %PLM_INSTDIR%\customize\config, each application has its own configuration files in %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 CADspecific 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 SOLIDWORKS in the user interface of the SAP Engineering Control Center are defined in the file "menu.guidef". Recurring function sequences in menus and sub-menus can be defined as macros in the file "menu_macros.txt". These macros will then only be referenced in the menu definitions in the file "menu.guidef". In addition to the global files with the same name under %PLM_INSTDIR%\customize\config there are the CAD-specific counterparts, which additionally define appropriate menus for the SAP Engineering Control Center menu.guidef The file "menu.guidef" contains menu items that are available in connection with the SAP Engineering Control Center Interface to SOLIDWORKS in the user interface of the SAP Engineering Control Center. Construction of a menu definition Each individual menu definition begins with a plus sign ('+') in the first column of the line, followed by the menu identification. The individual functions that appear in the menu are arranged one after the other, in which each menu function is preceded by an equal sign ('='). In each menu definition, macros, which are defined in the file "menu_macros.txt" or in the general macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt", are referenced by their 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 / 85 -

9 Definition of the context menu for cloning A context menu is provided for the "Clone" functionality of the SAP Engineering Control Center. Its range of functions are defined using the parameters "om.popup.menu.clonepos.doc_slwmdl" (for SOLIDWORKS models) and "om.popup.menu.clonepos.doc_slwdrw" (for SOLIDWORKS drawings): Definition of the context menu for "Cloning" ############################################################################### # SOLIDWORKS Cloning Menu + om.popup.menu.clonepos.doc_slwmdl =? DOCUMENT_SLW_GENERAL_CLONING + om.popup.menu.clonepos.doc_slwdrw =? DOCUMENT_SLW_GENERAL_CLONING The macro "DOCUMENT_SLW_GENERAL_CLONING" defined in the file "menu_macros.txt" is used, which defines the scope of functions: Definition of the functions of the context menu for "Cloning" in file "menu_macros.txt"? DOCUMENT_SLW_GENERAL_CLONING = fnc.doc.clone.option.no_action = fnc.doc.clone.option.newintnr_option = fnc.doc.clone.option.newextnr_option = fnc.doc.clone.option.replace_option = fnc.doc.clone.option.newvers_option = fnc.doc.clone.option.change_option = = fnc.clpbrd.delete = fnc.doc.reload The following functions are possible: Possible functions in the context menu for "Cloning" Parameter fnc.doc.clone.option.no_action fnc.doc.clone.option.newintnr_option fnc.doc.clone.option.newextnr_option fnc.doc.clone.option.insert_option fnc.doc.clone.option.replace_option fnc.doc.clone.option.delete_option fnc.doc.clone.option.newvers_option fnc.doc.clone.option.change_option fnc.clpbrd.delete fnc.doc.reload Function "No Action" "New internal Number" "Extended Clon Options" "Add Component" "Replace Component" "Delete Component" "New Version" "Change Details" "Remove" "Reload" - 9 / 85 -

10 IMPORTANT: The "Cloning" function is universally designed for various CAD systems. Therefore, not every possible function is necessarily useful for every CAD system and document type. Before adding a function to the context menu, this should be checked carefully! It can be useful to configure different context menus for different document types menu_macros.txt Recurring function sequences in menus and sub-menus are defined as macros in the file "menu_macros.txt." These can then be referenced using their names in the file "menu.guidef." Structure of a macro definition Each individual macro definition begins with a question mark at the beginning of the line, followed by the macro name. This should be typed using capital letters, to designate it as a macro name. The individual menu functions belonging to a macro are arranged one after the other, with each menu function being preceded by an equal sign ('='). Other macros can also be referenced by name within a macro definition, and names should be preceded by a question mark ('?'). These macros can either come from this file itself or from the general macro definition file "%PLM_INSTDIR%\customize\config\menu_macros.txt". Sub-menus in the menu are designated by indentation of the associated menu entries, for which only blank spaces may be used. Tabs are not allowed! Separators within the menu are represented by a line consisting of dashes ('-'). Commentaries can be inserted. These are preceded by a '#' at the beginning of the line. The defined macros "LAUNCH_APPL_SLW" is required, so that the SAP Engineering Control Center can start the SOLIDWORKS application as needed. 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 and %PLM_INSTDIR%\customize\config\attributes-from-sap.xml %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 of the ECTR the inclusion of the standard section will be adapted in the file "attributesfrom-sap.xml". Before: <section name="generic" default_section="true" description="attribute mapping"> - 10 / 85 -

11 With ECTR version 5.1.7: <section name="generic" include_section="standard" description="attribute mapping"> The name of the included standard section comes from the global file "attributes-from-sap.xml" file. Possible values are: "STANDARD", "default" und "STDMOD". Various sections can be defined in the CAD-specific attribute mapping file %PLM_INSTDIR%\applications\slw\customize\config\attributes-from-sap.xml, each of which represents an attribute section that contains defined mappable attributes and their precise treatment. The attribute "name" gives the relationship to the DType description in the file "dtypes.xml". 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: <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 Values Description Attribute of element <section> name="..." include_section="..." description="..." Name of attribute division Name of section: "STANDARD", "STDMOD" or "default" Description of attribute sections DTypes are referenced to this attribute segment with this name in the file "dtypes.xml". 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. This is a comprehensive description of an attribute section / 85 -

12 Within a section, attributes belonging to this attribute section are defined with the sub-element <APPL_ATTRIBUTE>. Attributes of the sub-element <APPL_ATTRIBUTE> Attribute Values Description name="..." Attribute name Document-side name of the attribute. hidden="..." true, false Determines whether this is a helper attribute ("true") or a regular document attribute ("false"). Within the attribute definition, the subelement <DIR> addresses document attributes, and the subelement <MA> addresses material attributes. Attribute Values Description Attributes of subelements <DIR> and <MA> Name of a field in SAP from which the value for the attribute should be read out. field="..." row=" " language=" " Field Name Number 0 - x SAP language code ATTENTION: Only specific SAP fields are allowed here! A list of allowed SAP fields is available in the Operations Guide (File "Operations Guide_DE.pdf") in SAP Engineering Control Center. (Optional) There may be a line of SAP long text to be transferred together. The value indicates the row, starting with 0. If the specified line is not present, an error message is generated. 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 character="0"> <DIR field="documentnumber"/> </CUTLEADING> If character="0", " " will be modified to "4711". The subelement <XFORMAT> combines the values "DOCUMENTNUMBER" and "DOCUMENTTYPE" read out from SAP fields into one string: Example for subelement <XFORMAT> <XFORMAT outputformat="{0}/{1}"> <DIR field="documentnumber"/> <DIR field="documentversion"/> </XFORMAT> If DOCUMENTNUMBER = " " and DOCUMENTVERSION = "02", the result is " /02". Both subelements can be combined: Example for combination of subelements <CUTLEADING> and <XFORMAT> <XFORMAT outputformat="{0}/{1}"> <CUTLEADING character="0"> - 12 / 85 -

13 In this case, the result is "4711/02". <DIR field="documentnumber"/> </CUTLEADING> <DIR field="documentversion"/> </XFORMAT> A full description of formatting possiblities is available in the Operations Guide (file "Operations Guide_EN.pdf") in the SAP Engineering Control Center! 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\slw\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 Values Description Attribute of element <section> name="..." default_section="..." description="..." Name of attribute section true, false Description of attribute sections DTypes are referenced to this attribute section with this name in the file "dtypes.xml". Determines if this attribute division describes a default attribute ("true"). The attributes of the division defaults are available in the document. segments are always processed. 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 / 85 -

14 Attributes of subelements <DIR> and <MA> Attribute Values Description Name of the document or material field which can be changed in SAP. field="..." language=" " Field Name SAP language code ATTENTION: Only specific SAP fields are allowed here! A list of allowed SAP fields is available in the Operations Guide (File "Operations Guide_EN.pdf") in SAP Engineering Control Center. (Optional) If field="longtext", the identifier of the language will be given 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>. Attributes of the sub-element <APPL_ATTRIBUTE> Attribute Values Description name="..." Field Name SAP into which it will be written. Information regarding further possibilities for attribute mapping and construction of file structure "attributesfrom-sap.xml" and "attributes-to-sap.xml" can be found in the help file "Operations Guide_EN.pdf" in the SAP Engineering Control Center, which can be found in folder "%PLM_INSTDIR%\documentation\Manuals\en"! Mapping of filenames and folder names With version of the SAP Engineering Control Center Interface to SOLIDWORKS, the following "DocumentSummaryInformation" attributes are provided additionally for mapping file names and folder names: DSI-SumInfoFileName (file name without extension) DSI-SumInfoFileNameWithExt (file name with extension) DSI-SumInfoFolderName (directory of the file) 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 SOLIDWORKS and the SAP system. Further explanations as to the purpose of the file and the individual configuration parameters can be found in the file "default.txt". It is to be noted that the parameters of the character string ".SLW" listed here must be included for SOLIDWORKS in order to be assigned to the appropriate CAD system from the SAP Engineering Control Center! - 14 / 85 -

15 The following table contains all parameters included in the file "default.txt" in delivery status, as well as their default settings: Parameters of the file "default.txt" for SOLIDWORKS plm.control.partnamerules.applextension.slw The main (primary) application for any mysap document is stored as a value in the RES4 field. For each application, we need to support the extension, which must be defined. In order to support old documents that do not have an appropriate entry in RES4, a default extension is provided. File type as file extension sldprt, sldasm, slddrw plm.control.popwin.name.slw Name (caption text), which the main window of the workstation application identifies to bring it to the foreground. The wild card '*' can be used to output a substring. Name of main window of the workstation application and substring, which is a component of the window name (driven by the wild card '*'). SOLIDWORKS 20* plm.adv.clone.renamerprogram.slw During cloning, it is necessary to rename the individual components as well as their references. This will be carried out by an external program which must be specified here. NOTE: Parts enclosed by '@' are placeholders for values that are taken from the global file "default.txt". Full path of the program to be plm.document.explode.hiddenexternalreferencessortf Consider circle references for cloning. 'Y' Y plm.om.doc.containers.swp plm.om.doc.containers.swa plm.om.doc.containers.swn Determines which information and attribute content of a document type should appear in the tree view of the ECTR. List of containers, separated by ';'. CADVARS;@plm.om.DOC.containers@ plm.control.waitforsessioninms.slw Defines the time until the application starts and the communication via interface will be established. Time in milliseconds plm.options.structureanalyze.readsmartfeatures.slw Indicates whether any existing SOLIDWORKS "smart features" should be resolved or not during structural analysis. ATTENTION: - "ImportOnDemand" is not supported! - If this option is changed SOLIDWORKS and ECTR must be restarted! - 15 / 85 -

16 "true" = Input smart features "false" = Do not input smart features false plm.options.importondemand.transferattributestosap.slw If you use an attribute_section for <document_create/> in file "dtype.xml" you have to set this option. "true" = Use attribute_section "false" = Don't use attribute_section false plm.options.importondemand.loaddrawings.slw Determines whether drawings which have a reference to imported models will be imported or not. ATTENTION: This may decrease performance! "true" = Import also drawings "false" = Ignore drawings false plm.options.importondemand.loadresolvedforsave.slw Determines whether model will be loaded fully resolved for save during import on demand or not. "true" = Load model fully resolved for save "false" = Use SOLIDWORKS setting false plm.options.save.loaddrawings.slw Determines whether drawings which have a reference to saved models will be saved or not. ATTENTION: This may decrease performance! "true" = Save also drawings "false" = Ignore drawings false plm.options.save.saveexternalreferences.slw Determines whether external references and their structures will be saved or not. ATTENTION: This may decrease performance! "true" = Save also external references and their structures "false" = Ignore external references false plm.options.save.updatephysicalpropertiesduringsave.slw Determines whether physical properties will be updated during save or not. "true" = Update physical properties "false" = Use SOLIDWORKS setting true plm.options.createdirfornewdocument.slw Determines whether and how a document info record (DIR) should be created in a newly generated document - 16 / 85 -

17 Parameter: '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 2 plm.options.createdirduringmakedrawingorassemblyfrompartorassembly.slw Determines which dialog appears when processing "Create drawing from part / assembly" and "Create assembly from part / assembly" to DIS creation. '0' = Use "Import" dialog (Import on demand) '1' = Use "Create DIR" dialog with drawing as master DIR '2' = Use "Create DIR" dialog with drawing as dependent document 0 plm.options.createdirdialogfordefeature.slw Within the SOLIDWORKS function "Defeature", a new document and a new DIS can be created. This parameter determines which method or dialog is to be used for the DIS installation. '0' = Use "Import" dialog (Import on demand) '1' = Use "Create DIR" dialog 0 plm.options.createdirdialogforvirtualcomponent.slw Specifies whether the dialog "Create DIS" or the function "Import on demand" should be used for the SOLIDWORKS function "Save virtual components as external file". '0' = Use "Import" dialog (Import on demand) '1' = Use "Create DIR" dialog 0 plm.options.excludefrombom.ignoresubcomponents.slw Determines whether subcomponents will be ignored when exluded from BOM. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Ignore subcomponents "false" = Do not ignore subcomponents false plm.options.excludefrombom.considerchildcomponentdisplayinbom.slw Determines whether to use the SOLIDWORKS functionality "Child component display in BOM when use as subassembly" (to be found in the BOM options of the configuration properties) to determine the "Excluded from BOM" state. Is the parameter set to "true" and the SOLIDWORKS functionality is set to "Promote" the instance in SAP will be marked as 'Not relevant for bill of material' but its subcomponents will be aggregated (like sort string 'W'). ATTENTION: - This option can decrease the performance specifically for SOLIDWORKS < 2018! - If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Use "Child component display in BOM when use as subassembly" "false" = Do not use "Child component display in BOM when use as subassembly" false plm.option.activeconfigurationonly.slw Analyzing and publishing structure of active configuration only / 85 -

18 "true" = For assemblies structure of active configuration only will be published during check in. Additional sort string of components will be provided as - 'C' for normal components - 'W' or 'WU' for components that in SOLIDWORKS are marked as 'Excluded from BOM' - 'W' in case that parameter plm.options.excludefrombom.ignoresubcomponents = false: Sub components will be aggregated - 'WU' in case that plm.options.excludefrombom.ignoresubcomponents = true:sub components will be ignored - 'S' for components that are suppressed in SOLIDWORKS These sort strings will be provided in bill of documents (BOD). "false" = Structure of all configurations will be published, sort string of all components will be set to 'C'. false plm.options.closedocumentforreopen.slw Determines whether files are closed and than opened again if reopen is required (e.g. if in sap a newer version of the file exist). WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Close and reopen file "false" = Release file handle and reload it false plm.options.readcomponentreferencealsoforlightweightassemblycomponents.slw Determines whether the component reference transferred to SAP instance attribute even then when the component is only opened in lightweight mode. WARNING: - If this option is changed SOLIDWORKS and ECTR must be restarted! - This option may decrease performance! "true" = Yes "false" = No false plm.options.structureanalyze.showdialogformissingreferences.slw Determines whether a dialog will be shown when find missing references during structure analyze. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Yes "false" = No true plm.options.structureanalyze.cachedocumentkeysusedforinstanceids.slw Determines that the document key (DIR), which is used to create the instance ID, is to be read and buffered only once. WARNING: Deactivating this option may decrease performance! "true" = Yes "false" = No true plm.convert.additional.slw - 18 / 85 -

19 Additional file formats are adapted via this parameter. The parameter has the following characteristics: 1) Definition of SOLIDWORKS document types for which additional file formats can be created: plm.convert.additional.slw = <DOCTYPE1>;<DOCTYPE2> Example: plm.convert.additional.slw = SWA;SWP;SWD 2) Definition which additional file formats for which SW document type are to be generated: plm.convert.additional.slw.<doctype> = <CONVERT TYPE1>;<CONVERT TYPE2> Example: plm.convert.additional.slw.swp = JT 3) Set the file extension for each additional file: plm.convert.additional.slw.<doctype>.<convert TYPE>.extension = <File extension> Example: plm.convert.additional.slw.swp.jt.extension = jt 4) Define specific options for generating each <CONVERT TYPE>: plm.convert.additional.slw.<convert TYPE>.Options = <OPTION1>;<OPTION2> Possible known options are: - STL2JT: Full path to the "stltojt.exe" file of the SAPGUI installation to create "JT" files. - KeepExtension: Sets the rule for the file name of the additional format file: Value = true (or 'keepextension' not defined): At filename of additional file the extension of desired file format will be appended Value = false: At filename of additional file the extension of the CAD file will be replaced by extension of desired file format Examples: - plm.convert.additional.slw.jt.options = STL2JT - plm.convert.additional.slw.pdf.options = keepextension 5) For each combination of document type - additional file format each of its options can be set: plm.convert.additional.slw.<doctype>.<convert TYPE>.<OPTIONS> = <VALUE> Examples: - plm.convert.additional.slw.swa.jtm.stl2jt = C:\\Program Files (x86)\\sap\\frontend\\sapgui\\program\\stltojt.exe - plm.convert.additional.slw.swd.pdf.keepextension = false Parameter: Parameter: See Description! These parameters are commented out by default! plm.convert.additional.slw.jt.filenameformat The names for neutral formats can be configured. The following placeholders are available, which are replaced by the corresponding SAP values: "$ (DOCNUMBER)" : SAP name "$ (DOCTYPE)" : Document category "$ (DOCVERSION)": Document version "$ (DOCPART)" : Document section String that can contain the allowed placeholders. Number.$(DOCNUMBER)_Type.$(DOCTYPE)_Version.$(DOCVERSION)_Part.$(DOCPART) plm.options.maximumnumberofgdiobjects.slw Sets the maximal amount of GDI objects. Max Parameter: WARNING: - If this option is changed SOLIDWORKS and ECTR must be restarted! - This number shouldn't exceed 9990! 8000 plm.options.sapopenforcadopendocument.slw - 19 / 85 -

20 Parameter: Parameter: Parameter: Parameter: Parameter: Parameter: Determines whether a document will be loaded from SAP when clicked 'Open'. '0' = Use SOLIDWORKS default dialog '1' = Use ECTR dialog '2' = Ask user 2 plm.options.sapopenforcadplacedocument.slw Determines whether a document will be loaded from SAP when add component to assembly/reload model in drawing. '0' = Use SOLIDWORKS default dialog '1' = Use ECTR dialog '2' = Ask user 2 plm.options.sapopenforloaddrawing.slw Determines whether document will be loaded from SAP when load drawing. '0' = Use SOLIDWORKS default dialog '1' = Use ECTR dialog '2' = Ask user 0 plm.options.open.usemultisearchforsapopen.slw Choose which ECTR open dialog should be used when opening a document from SAP. Enabling this option will let you open multiple documents at once. "true" = Use multi search dialog "false" = Use single search dialog true plm.loadoptions.slw.documentloadmode Determines the document load mode. "default" = Use SOLIDWORKS settings "resolved" = Load model fully resolved "lightweight" = Load model lightweight (assemblies and drawings only) "viewonly" = Load in view only "usespeedpak" = Use Speedpak (assemblies and drawings only) "ignorehiddencomponents" = Do not load hidden components (assemblies only) "showcadopendialog" = Show CAD open dialog default plm.options.showcomponentnameandordescriptioninfeaturetree.slw Show component name and/or component description in SOLIDWORKS FeatureManager structure tree after loading document. ATTENTION: Since this setting of SOLIDWORKS is stored directly in the model file, the document can be dirty if a value other than '0' is chosen here! '0' = Use document settings '1' = Show component name '2' = Show component description '3' = Show component name and component description 0 plm.options.changefeaturetreedisplayonlyforwritabledocuments.slw Specifies whether the SOLIDWORKS FeatureTree display should be changed for writable documents only. "true" = Yes "false" = Always change - 20 / 85 -

21 Parameter: true plm.options.missingreferencereloadoption.slw Define behavior if SOLIDWORKS notices a missing component file when loading an assembly. '0' = Use SOLIDWORKS behavior '1' = Load component from SAP automatically '2' = Ask user for loading the missing component from SAP ATTENTION: If the option is set to value 1 or 2 the assembly document will be dirty after loading it. Parameter: 0 plm.options.actionwhenvirtualcomponentwithreferencestorealcomponentsfound.slw Define the behavior if SOLIDWORKS notices a virtual component which has at least one reference to a real component. ATTENTION: - The virtual component and its structure will be ignored anyway! - If you change this option you have to restart SOLIDWORKS and ECTR! '0' = Only log the virtual component '1' = Log the virtual component and ask user if he want to abort structure analyze NOTE: The option '1' will only take affect during operations "Save" and "Save and Display". If the user decide to abort structure analysis the "Save" or "Save and Display" process will be aborted. 1 plm.bom.create.sxx Determines whether a bill of materials (BOM) should be generated for document types SWD, SDN, SWA, SWP und SWN "true" = Generate BOM "false" = Do not generate BOM false plm.bom.createatcheckin.sxx Determines whether a bill of materials (BOM) should be generated for document types SWD, SDN, SWA, SWP und SWN during check-in "true" = Generate BOM "false" = Do not generate BOM false plm.bom.updateatcheckin.sxx Determines whether an existing BOM should be updated during check-in "true" = Update BOM "false" = Do not update BOM false plm.bom.update.sxx Determines whether an existing BOM should be updated "true" = Update BOM "false" = Do not update BOM false plm.document.saveasnewdocument.checkouttop.slw - 21 / 85 -

22 Parameter: Parameter: Determines what should be done with the parent document during the function "Save as new document". '0' = Do not check out '1' = Check out '2' = Check out and save (intermediate) 0 plm.options.saveasnewdocument.replace.slw Defines the method for replacing references in the "Save as new document" function. '0' = Replace in all open views without warning dialog '1' = Replace only in active and unavoidable other views without warning dialog '2' = Replace in all open views after displaying a warning dialog '3' = Replace only in active and unavoidable other views without warning dialog '4' = Do not replace references 0 plm.options.updateattributes.useinteropprefix.slw Determines whether the prefix "UDP-" will be used for user-defined properties ("UDP") This is necessary for interoperability between CAD systems. "true" = Use prefix "false" = Do not use prefix true plm.options.deliveronlyrequestedattributestosap.slw Determines whether deliver only requested attributes to SAP. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Yes "false" = No true plm.options.checkin.updateattributesfromsap.slw Determines whether attributes from SAP are updated before save (check-in) documents. "true" = Update attributes before save "false" = Do not update attributes before save false plm.options.deliverphysicalpropertiesconfigurationspecific.slw Deliver physical properties configuration specifications. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "true" = Yes "false" = No (read physical properties of active configuration) true plm.options.deliverphysicalpropertiesindocumentunit.slw Determines whether the physical properties size, weight and time should be transferred in the units set in the document, or in meters, kilograms and seconds. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! - 22 / 85 -

23 "true" = Use document settings "false" = Use meters, kilograms and seconds false plm.options.deliverspecificsheetproperties.slw Determines if sheet specific properties will be transferred. It is possible to get the dimensions for all sheets and the scaling for all sheets and drawing views. Dimensions wont be collected for drawing views only for sheets. WARNING: If this option is changed SOLIDWORKS and ECTR must be restarted! "0" = Only for the active sheet "1" = For all sheets "2" = For all sheets and the scaling of drawing views 0 plm.options.checkin.abortanalysisofcheckedincomponents.slw When an assembly is checked in, its entire structure is usually analyzed to find also checked out and / or modified documents. This takes a long time, however. Assuming that a read-only, unmodified component file can not have been modified (i.e., in its components and its contents), its structure analysis can optionally be dispensed with in order to speed up the process. ATTENTION: This only works reliably if the CAD system reliably passes changes to sub-sub components to the top module. Otherwise inconsistencies may occur! In case of uncertainty this option should not be activated! It is also necessary to check whether the parameter plm.options.deselectcadoptionforprompttosavereadonlydocuments.slw must be set to "true"! "true" = Performance option is activated "false" = Performance option is not used true plm.options.deselectcadoptionforprompttosavereadonlydocuments.slw If the SOLIDWORKS option "No prompt to save read-only referenced documents (reject changes)" in the "System Options" under "External References" is activated and the function controlled with the parameter plm.options.checkin.abortanalysisofcheckedincomponents.slw is activated, sub-sub components won't be propagated to the top module. However, this can be prevented with the parameter described here by temporarily overriding this parameter at checkin. "true" = Override SOLIDWORKS option on Checkin "false" = Do not override SOLIDWORKS option on Checkin false plm.doc.cancel.restore.files.slw Determines the action during the function "Cancel, discard changes". "true" = Reset the local copy to the last check-in point "false" = Delete the local copy from the session directory false plm.options.import.standardpart.dark.slw Determines whether standard parts imported dark. "true" = Yes "false" = No false plm.library.slw.<library name> - 23 / 85 -

24 Specifies the access path to a standard part directory containing user-specific standard part libraries. ATTENTION: - The prerequisite is that the standard part directory is accessible to all computers which should have access to it and is located in the same location (this is usually a network drive)! - If this option is changed SOLIDWORKS and ECTR must be restarted! Access path to the standard part directory (e.g.: "\\\\svr-standard-parts\\mylib"). - none - plm.document.dtype.toolboxpart.slw Determines the DType for SOLIDWORKS toolbox parts (standard parts). WARNING: The DType indicated here must be defined in the file "dtype.xml"! A DType defined in "dtype.xml" SWNPR plm.structure.application.collectentries.slw Determines whether multiple built-up components in the structure overview of the ECTR will be displayed individually or summarily. "collectnone" = No summary. Every instance will be shown individually "collectall" = Summarize all instances. Only depict and summarize a node with the total "collectbyslwconfiguration" = All instances separately for each configuration collectnone plm.structure.application.additionalattributes.slw List of available file attributes that should additionally be displayed in the ECTR structure display. List of file types, separated by ';' - none - plm.structure.application.displayadditionalattributes.slw Determines whether the file attributes given in the list should additionally be displayed or not in the ECTR structure display. "true" = Display additional file attributes "false" = Do not display additional file attributes false plm.structure.application.hidestructureofspeedpaks.slw Determines whether the document structure of assemblies with a SpeedPak as active configuration will resolved and displayed in the ECTR structure display or not. "true" = Document structure of assembly with a SpeedPak as active configuration will not resolved "false" = If a SpeedPak is the active configuration of an assembly switch to SpeedPak's parent configuration and resolve document structure false plm.structure.application.loaddrawings.slw Determines wether drawings which have reference to model should be displayed or not in the ECTR stucture display. "true" = Display drawings which have reference to model "false" = Don't display drawings which have reference to model false plm.structure.application.init.strategy.levels.slw - 24 / 85 -

25 Parameter: Parameter: Parameter: Parameter: Parameter: Parameter: Number of levels which should be submitted to application structure. "all" = Complete structure <number> = Number of levels 1 plm.structure.application.displayexternalreferences.slw Determines whether external references are to be displayed in the application structure of the ECTR. "true" = Display external references "false" = Don't display external references false plm.structure.application.displaysuppressedcomponents.slw Determines whether suppressed components are displayed in the application structure. NOTE: This parameter is also included in the preference dialog "Application Structure" of the ECTR as option "Display suppressed components". "true" = Yes "false" = No false plm.options.ballooning.ballooncontent.slw Sets the content for balloons. '0' = Material and BOM position number '1' = material number '2' = BOM position number '3' = SAP balloon content '4' = CAD position number 3 plm.options.bomtable.column.slw.[cad_column] = [SAP_FIELD] If a BOM exists in a drawing and this contains a column [CAD_COLUMN], this determines which content from which SAP field [SAP_FIELD] is stored there. The following tags are possible for SAP fields. These identify the corresponding column of the return table ET_BALLOONS: "MATERIAL" = Internal material number "MATERIAL_EXT" = External material number "POSTEXT1" = Value from column POSTEXT1 "POSTEXT2" = Value from column POSTEXT2 plm.options.bomtable.column.slw.sapmaterial = MATERIAL_EXT plm.options.bomtable.addnonexistingcolumns.slw Determines whether a non-existing column [CAD_COLUMN] is to be added to a drawing in the CAD BOM and updated with the contents of [SAP_FIELD] or not. ATTENTION: If this option is changed, SOLIDWORKS and ECTR must be restarted! "true" = Add column "false" = Do not add column true plm.options.suppressalwayssaveasdialogforreadonlyconverteddocuments.slw During local save of a document structure always suppress SaveAs-Dialog for read-only converted documents (documents saved in previous SOLIDWORKS version) / 85 -

26 Parameter: "true" = Yes "false" = No true plm.execute.additional.slw - 26 / 85 -

27 It is possible to execute additional functions before or after a specific PLM process by starting either an executable file (external tool) or a CAD macro (internal VBA or command routine) and powershell. The following specifications are possible: 1.) Specifies the time of execution per document type: plm.execute.additional.slw.<doctype>.<exec TIME> Possible options for <EXEC TIME> are: - "BeforeCheckIn": Execute before checkin - "AfterCheckOut": Exectute after checkin - "AfterBallooning": Execute after ballooning Example: plm.execute.additional.slw.swa.beforecheckin 2.) Specifies the type of additional function: plm.execute.additional.slw.<doctype>.<exec TIME>.type = [EXEC TYPE] Possible options for are: - "Executable": External tool - "CADMacro": CAD macro (VBA) - "Powershell": Starts the Windows powershell Example: plm.execute.additional.slw.swp.beforecheckin.type = Executable 3.) Specifies the name of the external program, macro or command: plm.execute.additional.slw.<doctype>.<exec TIME>.commandLine = [CMDLINE] Example: plm.execute.additional.slw.swa.beforecheckin.commandline = D:\\Data\\Tools\\ExternalTool.exe NOTE: Executables need a valid file path with escaped backslashes! Example: "D:\\Data\\Tools\\ExtractFormat64.exe" 4.) Options for executable type "CADMacro": plm.execute.additional.slw.<doctype>.<exec TIME>.module = [Module in macro] plm.execute.additional.slw.<doctype1>.<exec TIME>.function = [Funktion name in module] Examples: plm.execute.additional.slw.swd.afterballooning.module = Drawing_DeleteDuplicateBa plm.execute.additional.slw.swd.afterballooning.function = main NOTE: For the version type "CADMacro" it is absolutely necessary to specify the options "module" and "function"! 5.) Specifies the parameters to pass: plm.execute.additional.slw.<doctype>.<exec TIME>.parameterN = [PARAM VALUE] The placeholder 'N' stands for the parameter number. The parameter number also determines the order in which the parameters are passed! Example: plm.execute.additional.slw.swa.beforecheckin.parameter1 = $(FILENAME) plm.execute.additional.slw.swa.beforecheckin.parameter2 = Test-User Hint: For executables and power shell calls, the parameters can also be given as arguments (only the parameter values). For the parameter transfer, the XML file "parameters.xml" is generated, which can be evaluated by the called module. For more information, see chapter Parameter transfer as XML file when calling external tools or macros! See in Description! / 85 -

28 2.3.1 Parameter transfer as XML file when calling external tools or macros Parameter transfer as XML file To set up calls to external tools or macros, the parameters plm.execute.additional.slw exist in the configuration file "default.txt"! Input parameters for external applications and macros A file "parameters.xml" is always created in the path %TEMP%\CIDEON\Macros\<CAD-Modulename>\<Macroname>, e.g.: C:\Users\User\AppData\Local\Temp\CIDEON\Macros\CdnECTRInterfaceSWx_64.dll\TestMacro.swp\parameters.xml This must be evaluated by a called executable or macro if a parameter transfer is necessary. When calling external applications and the Windows powershell, the parameters can also be given as arguments (only the parameter values). The file "parameters.xml" has the following structure: Structure of the file "parameters.xml" <?xml version="1.0" encoding="utf-8"?> <parameters> <parameter> <name>function</name> <value>main</value> </parameter> <parameter> <name>module</name> <value>testmacro1</value> </parameter> </parameters> Return of macros If a macro in this path stores %TEMP%\CIDEON\Macros\<CAD module name>\<macroname> a file "return.xml", this is evaluated by the interface. e.g.: C:\Users\User\AppData\Local\Temp\CIDEON\Macros\CdnECTRInterfaceSWx_64.dll\TestMacro1.swp\return.xml The file "return.xml" must have the following structure: Structure of file "return.xml" <?xml version="1.0" encoding="utf-8"?> <return> <code>1</code> <message>error 4711!</message> </return> On return codes!= 0, the message is displayed as an error message. If return code = 0, the message is only output in the log file / 85 -

29 The evaluation sequence of the return messages The evaluation of the return messages takes place in the following sequence: 1. HRESULT of executable, powershell or macro (indicator for successful execution). 2. Check if there is a file "return.xml" in %TEMP%\CIDEON\Macros\<CAD module name>\<macroname> if so, evaluate it. 3. If there is no file "return.xml", only the exit code of executable, powershell or macro is returned. 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 SOLIDWORKS contains definitions and settings for document types supported by SOLIDWORKS. Structure The file "dtype.xml" has the following basic structure: File structure of "dtype.xml" <!DOCTYPE DType_definitions SYSTEM "../../../../basis/aux-files/dtype_4110.dtd"> <DType_definitions> <DType... >... </DType> <DType... >... </DType> </DType_definitions> The element <DType> defines the characteristics of a document type or template. It outlines distinctions between the master document, nonmaster documents dependent on the master document, and templates for document type descriptions. The element <DType> possesses a variety of attributes and accepts a wide range of subelements. The setup and structure of the file "dtype.xml" are extensively explained in the help file "Operations Guide_EN.pdf", which can be found in the directory "%PLM_INSTDIR%\documentation\Manuals\en". The XML structure of "dtype.xml" is defined in the file "%PLM_INSTDIR%\basis\aux-files\dtype_4110.dtd". The DType definitions for the SAP Engineering Control Center Interface to SOLIDWORKS are described here DType definitions for SOLIDWORKS With the installation of the SAP Engineering Control Center interface to SOLIDWORKS the file "dtype.xml" is delivered. This includes the DType definitions that are essential for the interaction with the SAP Engineering Control Center. Below these definitions will be explained. The definition is divided into three areas: - 29 / 85 -

30 Generic functions (template definition) Master document definitions Nonmaster document definitions The following are the descriptions of the individual definitions for SOLIDWORKS documents Generic DType definitions The generic definitions are templates with basic definitions that are valid for all SOLIDWORKS document types. These are integrated in the other DType definitions. Two DType templates are defined for SOLIDWORKS: "SLWMDL" for parts and assemblies "SLWDRW" for drawings NOTE: It is recommended to maintain only the language English directly in the file "dtype.xml"! All other languages will be offered via the particular "dictionary.txt" file. This affects the definitions of DTypes and Seedfiles. All elements <description language="xy"> are omitted except English which are used as fallback. First, we will explain the definition for parts and assemblies: Generic DType definition for SOLIDWORKS parts and assemblies <DType type="template" identifier="slwmdl" include_template="deflt" application_type="slw" group="solidworks"> <description language="en" text="solidworks Documents"/> <program_options show_for_create="yes" has_primary_application="yes" dirty_flag="yes" attempt_status_change_on_checkin="yes" function_group="doc_slwmdl" customer_data_section="slwmdl" auto_adjust_application_role="no"> <copy_as allowed="yes" ignore_wsappl_list="zip" use_initial_version="yes" copy_material="no" remove_dirty_flag="no"> </copy_as> <new_version status_list="ac;iw;fr" ignore_wsappl_list="zip" ignore_nm_dtype_list="" rename_master_original="yes" remove_dirty_flag="no"/> </program_options> <document_create create_with_sap_gui="no" create_multi_allowed="no" document_number_assignment="internal" initial_document_number="*" document_type="swp" initial_document_part="000" part_editable="no" initial_document_version="00" version_editable="no" change_to_after_create_status="ac" filename_template_base="$(docnumber)$(doctype)$(docpart)" filename_template_version=""> </document_create> <material_create material_creation_method="deferred" material_number_assignment="internal" material_type="fert;halb" material_template="" material_plant_assignment="" material_default_class=""/> - 30 / 85 -

31 <primary_application primary_workstation_application="swp" attribute_section="slwmdl" update_attributes_for_rw="yes" update_attributes_for_ro="no" update_attributes_for_dirty="yes"> <container_file> <plmfile extension="ecf" workstation_application="ecf" description="ectr container file"/> </container_file> <checkout_rules rename_master_original_at_checkout="no" one_version_in_session_only="no" hardlink_in_session="no" read_structure="flag" check_references_on_edit="yes"> </checkout_rules> <checkin_rules from_application_only="yes"> <save_direct> <plmfile extension="jpg" workstation_application="epj" description="ectr Preview (jpeg)"/> <plmfile extension="edrw" workstation_application="edw" description="$(filename)"/> <plmfile extension="eprt" workstation_application="edw" description="$(filename)"/> <plmfile extension="easm" workstation_application="edw" description="$(filename)"/> <plmfile extension="stp" workstation_application="stp" description="$(filename)"/> <plmfile extension="step" workstation_application="stp" description="$(filename)"/> <plmfile extension="igs" workstation_application="igs" description="$(filename)"/> <plmfile extension="stl" workstation_application="stl" description="$(filename)"/> <plmfile extension="sat" workstation_application="sat" description="$(filename)"/> <plmfile filename_pattern=".*_mono\.rh" workstation_application="rhm" description="monolithic RH"/> <plmfile filename_pattern=".*_mono\.vds" workstation_application="rhm" description="monolithic VDS"/> <plmfile extension="rh" workstation_application="rh" description="$(filename)"/> </save_direct> <ignore> <plmfile extension="bak"/> <plmfile extension="tmp"/> <plmfile extension="xml"/> <plmfile filename_pattern="veconverterresponse\.xml"/> </ignore> <delete_in_sap> <plmfile workstation_application="epg"/> <plmfile workstation_application="epj"/> <plmfile workstation_application="cgo"/> <plmfile workstation_application="jt"/> <plmfile workstation_application="edw"/> - 31 / 85 -

32 <plmfile workstation_application="stp"/> <plmfile workstation_application="igs"/> <plmfile workstation_application="stl"/> <plmfile workstation_application="sat"/> </delete_in_sap> <delete_in_session> <plmfile extension="jpg"/> <plmfile extension="gif"/> <plmfile extension="cgm"/> <plmfile extension="rh"/> <plmfile extension="vds"/> </delete_in_session> <scripts> <script <params> <param name="convertfile"/> <param name="$(masterfile)"/> <param name="--output-directory"/> <param name="$(add_dir)"/> <param name="--output-format"/> <param name="rh"/> <param name="--sap-identifier"/> <param name="document=$(doc_type)*$(doc_nr)*$(doc_part)*$(doc_vr)"/> <param name="--sap-metadata"/> <param name="doctype=$(doc_type)"/> <param name="--sap-metadata"/> <param name="docnumber=$(doc_nr)"/> <param name="--sap-metadata"/> <param name="docpart=$(doc_part)"/> <param name="--sap-metadata"/> <param name="docversion=$(doc_vr)"/> <param name="--import-setting"/> <param name="loadexternalfiles=false"/> </params> </script> </scripts> </checkin_rules> </primary_application> <additional_files enable_additional_files="yes"> <ignore_files> <plmfile workstation_application="epj"/> <plmfile workstation_application="epg"/> <plmfile workstation_application="jt"/> </ignore_files> </additional_files> <allowed_nonmaster DType="VWINM" max_count="99"/> </DType> Attribute to the element <DType> of template definition "SLWMDL" - 32 / 85 -

33 type identifier include_template application_type group "template" "SLWMDL" "DEFLT" "SLW" "SOLIDWORKS" Determines the type of DType definition. "template" = This is a DType template definition. Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SLWMDL" = ID of this template definition. 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. "SLW" = This is the Workstation Application (WSAppl) for SOLIDWORKS. Defines the group designation for master documents. The group designation helps to organize DTypes within the dialog "create document". "SOLIDWORKS" = Document belongs to this group. The sub-element <program_options> contains different settings, which control the behavior of the document in the SAP Engineering Control Center. Attributes of the sub-element <program_options> show_for_create has_primary_application dirty_flag attempt_status_change_on_checkin function_group customer_data_section auto_adjust_application_role "yes" "yes" "yes" "yes" "DOC_SLWMDL" "SLWMDL" "no" Determines whether in dialogue "create document " this DType is visible in the combo box for accessible document types. "yes" = Document is visible. Determines if document is normal document with original and assigned Workstation Application or container object for additional originals without explicit original. "yes" = The document has an original with the designated Workstation application Determines if the newly created document has a dirty flag. "yes" = The document has a dirty flag. Determines if change of status applies during check in at SAP Engineering Control Center or if SAP System conducts change of status. "yes" = Change of status by SAP Engineering Control Center. Sets the Function Group to which the document belongs. For documents with a common Function Group, for example, individual context menus can be defined. "DOC_SLWMDL" = Identifier of the Function Group. Name of a section in the attribute mapping file that is defined in customer-specific data. The data will be displayed in the object browser of ECTR under the tab "customer data". "SLWMDL" = Name of section. Turns the automatic adaptation of the "application role" in RES4 in SAP on or off. "no" = No automatic adaptation / 85 -

34 The sub-element <copy_as> determines how the document behaves during a "CopyAs" action and how SAP Engineering Control Center reacts to the document. Attributes of the sub-element <copy_as> from sub-element <program_options> allowed ignore_wsappl_list use_initial_version copy_material remove_dirty_flag "yes" "ZIP" "yes" "no" "no" Determines if a CopyAs is permitted for this DType. "yes" = "CopyAs" - operation permitted. Determines which additional originals of the document will be accepted during copy but not into copy of document according to a table of identifiers for the Workstation Application for additional originals all of which are separated by semicolon. "ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied. Determines whether the version number of the copy should be set on the original or on the initial value (normally "00"). "yes" = Version number of the copy on which the initial value will be set. Determines if designated material will also be copied during copy of master document. This attribute has no influence on depending documents, which are copied onto the master documents during copy process. "no" = Material will not be copied. Determines if dirty flag of copy will be reset. "no" = The dirty flag of copy remains set. The sub-element <new_version> contains settings for the versioning of documents. Attribute to the sub-element <program_options> Status list ignore_wsappl_list "AC;IW;FR" "ZIP" Determines the type of document status that allows visioning of documents. A list of document statuses can be given separateed by ";". "AC;IW;FR" = With this type of document status new versions are allowed. Determines which additional originals of the document will not be accepted into a new version of document during versioning, according to a list of identifiers for the Workstation Application which are separated by semicolons. "ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied. ignore_nm_dtype_list "" Determines which depending documents will be omitted during versioning of master documents. Depending documents to be omitted will be listed in a table of DTypes, separated by semicolon. remove_dirty_flag "no" "" = No ignorable document types defined. Determines if dirty flag of new version will be reset. "no" = The dirty flag of new version remains set. The sub-element <document_create> contains settings that control the way in which a new document is created in SAP. Attributes to the sub-element <document_create> - 34 / 85 -

35 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" document_number_assignment "internal" initial_document_number "*" Determines if the mass creation of this document is allowed. "no" = Mass creation of this document is not permitted. Determines the document number assignment in SAP. "internal" = SAP assigns the number automatically. The value of this field has no meaning when the number is internally assigned. This value is entered as a prefix in the input field of the document system dialogue when the number is externally assigned. "*" = Due to internal number assignment without meaning. document_type "SWP" initial_document_part "000" part_editable "no" SAP document type for the newly created document. "SWP" = SAP document type. Sets the initial value of the part number for documents. "000" = Initial value of the doucment part number. Defines whether the default value or the selected SAP partial document from the "initial_document_part" attribute can be changed in the input field in the documentation system dialog for SAP Engineering Control Center. "no" = The default value cannot be changed. initial_document_version "00" version_editable "no" Sets the initial value of the version number for documents. "00" = Initial value of the version number Defines whether the default value for the document version can be changed in the documentation system dialog of SAP Engineering Control Center. "no" = No changes in default values are allowed. change_to_after_create_status "" The initial status of newly created document can be set here. filename_template_base "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" "" = Standard status will be used. Determines composition of file name of original document. The following place holders are possible: $(DOCNUMBER) for the document number, $(DOCTYPE) for the document type and $(DOCPART) for 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 / 85 -

36 Attributes of the sub-element <material_create> Determines whether and how a new document is created from Materials. material_creation_method material_number_assignment "deferred" "internal" "deferred" = No material is applied to the document. You can attach Materials subsequently to this document. Defines material number assignment in the SAP system. The values are the same as that of the document number assignment. "internal" = The SAP system assigns the number automatically. material_type "FERT;HALB" material_template "" material_plant_assignment "" material_default_class "" 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. Template material with which the material attachments can be processed. "" = No material template specified. Initial value for the assigned plant. "" = No initial work assigned. 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. Attribute of the sub-element <primary_application> primary_workstation_application "SWP" "SWP" = Identification of the SAP workstation application for the original. attribute_section update_attributes_for_rw update_attributes_for_ro update_attributes_for_dirty "SLWMDL" "yes" "no" "yes" Name of the section within the Attribute Mapping File, in which attribute exchanges between SAP and the application (SOLIDWORKS) are defined. "SLWMDL" = Name of section within the Attribute Mapping file Defines the attribute update for the action "Open for editing" "yes" = Perform attribute update. Defines the attribute update with the action "Open as read-only". "no" = Do not perform an attribute update. Defines if to update the attributes when dirty flag was set. "yes" = Perform attribute update. The sub-element <container_file> defines the characteristics of the ZIP archive, which is stored in the document as a container file. It contains the <plmfile> sub-element, which defines the properties for the container file. 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 - 36 / 85 -

37 workstation_application description "ECF" "ECtr container file" Filters original documents according to the workstation application. "ECF" = Identification of the workstation application. 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 Parameter Values Description rename_master_original_at_checkout one_version_in_session_only hardlink_in_session read_structure check_references_on_edit "no" "no" "no" "flag" "yes" Defines if the original is renamed during opening according to rules for component names. "no" = Keep file name during opening. 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. 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. Determines whether a structure resolution will be performed upon opening a document. "flag" = Only perform a structure resolution if "Structure"-Flag is set. Defines if under function "Open for Edit" all files for referenced components were provided in the session directory. Test has been done If not, operation will be abandoned. "yes" = Run test The sub-element <checkin_rules> determines how files in the additional directory and document originals are treated when checking in. This is why it has multiple sub-elements. Attribute of the sub-element <checkin_rules> from <primary_application> 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 workstation_application "jpg", "edrw", "eprt", "easm", "stp", "step", "igs", "stl", "sat", "rh", "jt" "EPJ", "EDW", "STP", "IGS", "STL", "SAT", "RHM", "JT", "RH" The respective file name extensions of additional files in the file system. "jpg", "edrw", "eprt", "easm", "stp", "step", "igs", "stl", "sat", "rh", "jt" = The respective file name extensions Workstation application identifiers for each additional format. "EPJ", "EDW", "STP", "IGS", "STL", "SAT", "RHM", "JT", "RH" = Identification of the document types / 85 -

38 description filename_pattern "ECtr Preview (jpeg)", "$(FILENAME)", "Monolithic RH", "Monolithic VDS" ".*_mono\.rh", ".*_mono\.vds" Description of the respective additional file. "ECtr Preview (jpeg)", "$(FILENAME)", "Monolithic RH", "Monolithic VDS"= Description of the additional files. 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 times the subelement<plmfile> that determines the additional file types to ignore. Attribute of the sub-element <plmfile> of sub-element <ignore> by <checkin_rules> Parameter Values Description extension filename_pattern "bak", "tmp", "xml""bak", "tmp", "bat" "VEConverterResponse\.xml" The respective file name extensions of the additional files to ignore in the file system. "bak", "tmp", "xml" = File name extensions of the additional file types. Filters by file names and regular expressions. "VEConverterResponse\.xml" = Filter mask. The sub-element <delete_in_sap> determines which original in the document should be deleted during check in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that determine the additional file types to delete. Attributes of sub-element <plmfile> of sub-element <delete_in_sap> by <checkin_rules> Parameter Values Description workstation_application "EPJ", "EDW", "STP", "IGS", "STL", "SAT", "RHM", "JT", "RH" Workstation application identifiers for each paragraph style. "EPG", "EPJ", "CGO", "JT", "EDW", "STP", "IGS", "STL", "SAT" = Identifications of the workstation application. The <delete_in_session> sub-element determines which files should be deleted during check in. It includes multiple <plmfile> sub-elements that determine the additional file types to delete. Attributes of the sub-element <plmfile> of sub-element <delete_in_session> by <checkin_rules> Parameter Values Description extension "jpg", "gif", "cgm", "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 run before checking in. The individual scripts are contained in subelement <script> Attributes of the sub-element <script> of sub-element <scripts> by <checkin_rules> Parameter Values Description Name "@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat" = script call path "VEConverter.bat". Sets the entire call path of the executing program. "@PLM_INSTDIR@\customize\exec\win\addutils\VEConverter.bat" = script call path "VEConverter.bat" / 85 -

39 <script> contains the sub-element <params> which determines the parameters for running the script. This includes one or more sub-elements <param>, which each define a parameter. Attributes of the sub-elements <params>, sub-element <params>, sub-element <script>, sub-element <scripts> from <checkin_rules> Parameter Values Description 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 defined parameter. These partly contain mutable data in the form of placeholders ("$(...)"). The subelement <additional_files> determines which additional formats of a document will be displayed and can be edited in the SAP Engineering Control Center. Parameter Values Description Attribute of the sub-element <additional_files> enable_additional_files "yes" Determines whether the additional originals are permissable for this document. "yes" = additional originals are permissible. The sub-element t <ignore_files> determines which additional originals of the document in the originals container of a document can NOT be displayed in SAP Engineering Control Center. These includes sub-items of type <plmfile> which define the individual document types. Attributes of the subelements <plmfile> of the subelement <ignore_files> from <additional_files> Parameter Values Description workstation_application "EPJ", "EPG", "CGM" The identifiers of the types of documents that should not be displayed. "EPJ", "EPG", "JT" = Identification of the document types. Thee sub-element <allowed_nonmaster> determines which types of document (Nonmaster documents) are accepted as a dependent document. Parameter Values Description Attributes of the sub-element <allowed_nonmaster> DType max_count "99" "VWINM" The non-ambiguous DType ID of the definition of the dependent document. "VWINM" = DType of allowed dependent documents. Allowable number of dependent documents for this master document. "99" = Max. number of possible dependent documents of this type. Now follows the definition of the template for the DTYPE definition of Drawings: Generic DType definition for SOLIDWORKS drawings <DType type="template" identifier="slwdrw" include_template="deflt" application_type="slw" group="solidworks"> - 39 / 85 -

40 <description language="en" text="solidworks 2D Documents"/> <program_options show_for_create="yes" has_primary_application="yes" dirty_flag="yes" attempt_status_change_on_checkin="yes" function_group="doc_slwdrw" customer_data_section="slwdrw" auto_adjust_application_role="no"> <copy_as allowed="yes" ignore_wsappl_list="zip" use_initial_version="yes" remove_dirty_flag="no"/> <new_version status_list="ac;iw;fr" ignore_wsappl_list="zip" ignore_nm_dtype_list="" remove_dirty_flag="no"/> </program_options> <nonmaster_options link_to_master_material="yes"/> <document_create create_with_sap_gui="no" create_multi_allowed="no" document_number_assignment="master" initial_document_number="*" document_type="swd" initial_document_part="000" part_editable="no" initial_document_version="00" version_editable="no" change_to_after_create_status="ac" filename_template_base="$(docnumber)$(doctype)$(docpart)" filename_template_version=""> </document_create> <material_create material_creation_method="deferred" material_number_assignment="master" material_type="fert;halb" material_template="" material_plant_assignment="" material_default_class=""/> <primary_application primary_workstation_application="swd" update_attributes_for_dirty="yes" update_attributes_for_rw="yes" update_attributes_for_ro="no" ttribute_section="slwdrw"> <container_file> <plmfile extension="ecf" workstation_application="ecf" description="ectr container file"/> </container_file> <checkout_rules rename_master_original_at_checkout="no" one_version_in_session_only="no" hardlink_in_session="no" read_structure="flag" check_references_on_edit="yes"> </checkout_rules> <checkin_rules from_application_only="yes"> <save_direct> <plmfile extension="jpg" workstation_application="epj" description="ectr Preview (jpeg)"/> <plmfile extension="gif" workstation_application="epg" description="ectr Preview (gif)"/> </save_direct> <ignore> <plmfile extension="bak"/> - 40 / 85 -

41 <plmfile extension="tmp"/> <plmfile extension="xml"/> </ignore> <delete_in_sap> <plmfile workstation_application="epg"/> <plmfile workstation_application="epj"/> </delete_in_sap> <delete_in_session> <plmfile extension="jpg"/> <plmfile extension="gif"/> </delete_in_session> </checkin_rules> </primary_application> </DType> Attributes of the element <DType> of template definition "SLWDRW" type identifier include_template application_type group "template" "SLWDRW" "DEFLT" "SLW" "SOLIDWORKS" Determines the type of DType definition. "template" = This is a DType template definition. Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one to five characters long. "SLWDRW" = ID of this template definition. 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 Applikation). This application opens the file from SAP Engineering Control Center. "SLW" = This is the Workstation Application (WSAppl) for SOLIDWORKS. Defines the group designation for master documents. The group designation helps to organize DTypes within the dialog "create document". "SOLIDWORKS" = Document belongs to this group. The sub-element <program_options> contains different settings, which control the behavior of the document in the SAP Engineering Control Center. Attributes of the <program_options> sub-element show_for_create has_primary_application "yes" "yes" Determines whether in dialogue "create document " this DType is visible in the combo box for accessible document types. "yes" = Document is visible. Determines if document is normal document with original and designated Workstation Application or container object for additional originals without explicit original. "yes" = the document has an original with the designated Workstation application / 85 -

42 dirty_flag attempt_status_change_on_checkin function_group customer_data_section auto_adjust_application_role "yes" "yes" "DOC_SLWDRW" "SLWDRW" "no" Determines if the newly created document has a dirty flag. "yes" = The document has a dirty flag. Determines if change of status applies during check in at SAP Engineering Control Center or if SAP System conducts change of status. "yes" = Change of status by SAP Engineering Control Center. Sets the Function Group to which the document belongs. For documents with a common Function Group, for example, specific context menus can be defined. "DOC_SLWDRW" = Identifier of the Function Group. Name of a section in the attribute mapping file that is defined in customer-specific data. The data will be displayed in the object browser of ECTR under the tab "customer data". "SLWDRW" = Name of section. Turns the automatic adaptation of the "application role" in RES4 in SAP on or off. "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 ignore_wsappl_list use_initial_version remove_dirty_flag "yes" "ZIP" "yes" "no" Determines if a CopyAs is permitted for this DType. "yes" = "CopyAs" - operation permitted. Determines which additional originals of the document will be accepted during copy but not into copy of document according to a table of identifiers for the Workstation Application for additional originals all of which are separated by semicolon. "ZIP" = Additional originals of type "ZIP" (ZIP-Archive) will not be copied. Determines whether the version number of the copy should be set on the original or on the initial value. (as a rule "00") "yes" = Version number of the copy on which the initial value will be set. Determines if dirty flag of copy will be reset. "no" = The dirty flag of copy remains set. The sub-element <new_version> contains settings for versioning of documents. Attribute to the sub-element <program_options> Status list "AC;IW;FR" Determines the type of document status that allows visioning of documents. A list of document statuses can be given separateed by ";". "AC;IW;FR" = With this type of document status new versions are allowed / 85 -

43 ignore_wsappl_list "ZIP" 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 omitted during versioning of master documents. Depending documents to be omitted will be listed in a table of DTypes, separated by semicolon. remove_dirty_flag "no" "" = No ignorable document types defined. Determines if dirty flag of new version will be reset. "no" = The dirty flag of new version remains set. The sub-element <nonmaster_option> determines whether a dependent document will be linked to the material of the master document. nonmaster_options> from sub-element <program_options> Attribute of the <nonmaster_options> subelement Attribute link_to_master_material Value "yes" Description Determines whether the dependent document receives an object link to the master document material. "yes" = An object link is created by the master document material to the dependent document. The sub-element <document_create> contains settings that control the way in which a new document is created in SAP. Attributes to the sub-element <document_create> create_with_sap_gui create_multi_allowed "no" "no" Determines if SAP GUI should be opened when creating a document. "no" = Do not open SAP GUI. Determines if the mass creation of this document is allowed. "no" = Mass creation of this document is not permitted. Determines the document number assignment in SAP. document_number_assignment initial_document_number "*" "master" "master" = The document version number is taken from the master document. In case of document_number_assignment = "internal" and "master" the value of this field has no meaning This value is entered as a prefix in the input field of the document system dialogue when the number is externally assigned. "*" = Wg. "master" without meaning. document_type "SWD" initial_document_part "000" SAP document type for the newly created document. "SWD" = SAP document type. Sets the initial value of the part number for documents. "000" = Initial value of the doucment part number / 85 -

44 part_editable "no" Defines whether the default value or the selected SAP partial document from the "initial_document_part" attribute can be changed in the input field in the documentation system dialog for SAP Engineering Control Center. "no" = The default value cannot be changed. initial_document_version "00" version_editable "no" Sets the initial value of the version number for documents. "00" = Initial value of the version number. Defines whether the default value for the document version can be changed in the documentation system dialog of SAP Engineering Control Center. change_to_after_create_status filename_template_base "AC" "$(DOCNUMBER)$(DOCTYPE)$(DOCPART)" "no" = No changes in default values are allowed. The initial status of newly created document can be set here. "AC" = The initial status. Determines composition of file name of original document. The following place holders are possible: $(DOCNUMBER) for the document number, $(DOCTYPE) for the document type and $(DOCPART) for 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> Determines whether and how a new document is created from Materials. material_creation_method material_number_assignment "deferred" "master" "deferred" = No material is applied to the document. You can attach Materials subsequently to this document. Defines material number assignment in the SAP system. The values are the same as that of the document number assignment. "master" = The number of the master document is adopted. material_type "FERT;HALB" material_template "" material_plant_assignment "" 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. Template material with which the material attachments can be processed. "" = No material template specified. Initial value for the assigned plant. "" = No initial work assigned / 85 -

45 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. Attribute of the sub-element <primary_application> primary_workstation_application "SWD" "SWD" = Identification of the SAP workstation application for the original. update_attributes_for_dirty update_attributes_for_rw update_attributes_for_ro attribute_section "yes" "yes" "no" "SLWDRW" Defines if to update the attributes when dirty flag was set. "yes" = Perform attribute update. Defines the attribute update for the action "Open for editing" "yes" = Perform attribute update. Defines the attribute update with the action "Open as read-only". "no" = Do not perform an attribute update. Name of the section within the Attribute Mapping File, in which attribute exchanges between SAP and the application (SOLIDWORKS) are defined. "SLWDRW" = Name of section within the Attribute Mapping file. The sub-element<container_file> defines the characteristics of the ZIP archive, which is stored in the document as a container file. It contains the <plmfile> sub-element, which defines the properties for the container file. Attributes of the sub-element <plmfile> inherited from the sub-element <container_file> from <primary_application> extension workstation_application description "ecf" "ECF" "ECtr container file" Filters by file name extensions in the file system. "ecf" = File name extension. Filters original documents according to the workstation application. "ECF" = Identification of the workstation application 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 Parameter Values Description rename_master_original_at_checkout one_version_in_session_only "no" "no" Defines if the original is renamed during opening according to rules for component names. "no" = Keep file name during opening. 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 / 85 -

46 hardlink_in_session read_structure check_references_on_edit "no" "flag" "yes" 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. Determines whether a structure resolution will be performed upon opening a document. "flag" = Only perform a structure resolution if "Structure"-Flag is set. Defines if under function "Open for Edit" all files for referenced components were provided in the session directory. Test has been done at If not, operation will be abandoned. "yes" = Run test. The sub-element <checkin_rules> determines how files in the additional directory and document originals are treated when checking in. This is why it has multiple sub-elements. Attribute of the sub-element <checkin_rules> from <primary_application> 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 workstation_application description "jpg", "gif" "EPJ", "EPG" "ECtr Preview (jpeg)", "ECtr Preview (gif)" The respective file name extensions of additional files in the file system. "jpg", "gif" = The respective file name extensions. Workstation application identifiers for each paragraph style. "EPJ", "EPG" = Identification of the document types. Description of the respective additional file. "ECtr Preview (jpeg)", "ECtr Preview (gif)" = Description of additional files. The <ignore> sub-element determines which files will be ignored when saving. It includes multiple times the subelement<plmfile> that determines the additional file types to ignore. Attributes of the sub-elements <plmfile> of the sub-element <ignore> of <checkin_rules> Parameter Values Description extension "bak", "tmp", "xml""bak", "tmp", "bat" The respective file name extensions of the additional files to ignore in the file system. "bak", "tmp", "bat" = File name extensions of the additional file types. The sub-element <delete_in_sap> determines which original in the document should be deleted during check in. This allows for a targeted adjustment of the document. It includes multiple <plmfile> sub-elements that determine the additional file types to delete. Attributes of sub-element <plmfile> of sub-element <delete_in_sap> by <checkin_rules> Parameter Values Description - 46 / 85 -

47 workstation_application "EPJ", "EPG" Workstation application identifiers for each additional format. "EPG", "EPJ" = Identification of the workstation application. The sub-element <delete_in_session> determines which files should be deleted during check in. It includes multiple <plmfile> sub-elements that determine the additional file types to delete. Attributes of the sub-element <plmfile> of sub-element <delete_in_session> by <checkin_rules> Parameter Values Description extension "jpg", "gif" The file name extensions of the files to be deleted in the file system. "jpg", "gif" = File name extensions of the additional file types DType definition for master documents The SAP Engineering Control Center distinguishes between master documents and dependent documents. The master document is the main and contains the CAD model file to be processed. In addition, the master document is the basis for the preparation of the bill of materials. The DType definition for master documents is divided up into DType definitions for parts ("SWP") and assemblies ("SWA") as well as their standard parts ("SWN") and for drawings ("SWD"). NOTE: It is recommended to maintain only the language English directly in the file "dtype.xml"! All other languages will be offered via the particular "dictionary.txt" file. This affects the definitions of DTypes and Seedfiles. All elements <description language="xy"> are omitted except English which are used as fallback. DType definition for master documents of the type "SWP" for SOLIDWORKS <DType type="master" identifier="swprt" include_template="slwmdl" application_type="slw" application_role="p"> <description language="en" text="solidworks Model SWP"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_part_$(family)16"/> </icon> <document_create document_type="swp" document_number_assignment="internal" rename_template_filename="yes"> <seedfile filename="modeltemplate.sldprt" type="template" default="yes" extension_filter="*.sldprt"> <description language="en" text="standard part"/> </seedfile> <seedfile filename="modeltemplate.sldprt" type="select" default="no" extension_filter="*.sldprt"> <description language="en" text="select existing partfile"/> </seedfile> </document_create> <primary_application primary_workstation_application="swp"/> - 47 / 85 -

48 <allowed_nonmaster DType="NSWDR" max_count="99"/> </DType> Attributes of the component <DType> of the definition "SWPRT" type identifier include_template application_type application_role "master" "SWPRT" "SLWMDL" "SLW" "P" Sets the type of DType definition. "master" = It s a matter of DType definition for master documents. Non-ambiguous ID string of this DType definition in the entire XML document. The ID has to be between one to five characters long. "SWPRT" = ID of this DType definition. Determines which template definition should be integrated into this definition. "SLWMDL" = The DType template with the ID "SLWMDL" from this "DType.xml" file will be included. This is the generic definition. Designates the application that is relevant for this document (Work Station Application). This application opens the file from SAP engineering control center. "SLW" = This is the Workstation Application (WSAppl) for SOLIDWORKS. Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "P" = Identification of the object type for parts. The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP Engineering Control Center. It also includes the sub-element <icondef>. Attributes of the sub-element<icondef> of the sub-element<icon> icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_part_$(family)16" Position of the symbol within the document entry in the tree. "1" = Leftmost, "6" = rightmost. Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon. Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_part_$(family)16" = The icon file. The sub-element <document_create> determines the way in which the document is created in SAP. Attributes to the sub-element <document_create> document_type document_number_assignment "SWP" "internal" SAP document type for the newly created document. "SWP" = SOLIDWORKS part document. Determines the document number assignment in SAP. "internal" = SAP assigns the number automatically / 85 -

49 rename_template_filename "yes" Determines whether, for the document attachment, the filename of the original is renamed according to the established naming rules or if the filename of the template file is assumed unchanged. "yes" = The filename of the original is renamed in creating the document. sub-element <seedfile> contains settings for the template file. Several template files can be assigned, i.e. the <seedfile> may occur more than once. This includes the sub-element <description>, which defines each description text in different languages. Attributes of the first sub-element<seedfile> of sub-element<document_create> filename type default extension_filter "modeltemplate.sldprt" "template" "yes" "*.sldprt" When using type="template", this attribute defines the filename of the template files that is used. There must be a file with this name, or the process will terminate with an error. "modeltemplate.sldprt" = Filename of the template file to be used. Determines how the original document will be generated. "template" = The "filename" attribute is used to specify the template file that is to be used. This determines whether this template file should be used as a preset in the "Create document" dialog. "yes" = The template file is preset. When selecting a template file with the type="select", this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.sldprt" = Filter for the file extension. Attributes of the 2. sub-element <seedfile> of sub-element <document_create> filename type default extension_filter "modeltemplate.sldprt" "select" "no" "*.sldprt" The "filename" attribute is used to specify the template file that is to be used. You can create a document within the dialog, select a template file via a file selection dialog. "modeltemplate.sldprt" = Data filename of the template file. Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. A template file can be selected within the dialog "Create document" via a file selection dialog. "select" = Selection of a template file in the dialog "Create document" possible. This helps determine whether this template file is preset in the dialog "Create document". "no" = This template file has not been preset. When selecting a template file with the type ="select" this attribute defines the filter for file extension. In the file selection dialog you can select files that are matched by the filter. "*.sldprt" = Filter for file extension. The sub-element<primary_application> determines which application is relevant for this master document (primary application) and defines the rules for the checking in and out of the originals. Attributes of the sub-element<primary_application> primary_workstation_application "SWP" "SWP" = Identification of the SAP workstation application for SOLIDWORKS parts / 85 -

50 The sub-element <allowed_nonmaster> defines a certain document type, allowed as a nonmaster document. Attributes of the sub-element <allowed_nonmaster> DType max_count "99" "NSWDR" Specifies the DType allowed as nonmaster document. "NSWDR" = DType. Determines the maximal amount of possible nonmaster-documents. "99" = Maximal number of nonmaster documents. Standard Parts from component libraries such as the SOLIDWORKS toolbox are aggregated and managed under the document type "SWN", this being applicable for SOLIDWORKS Parts as well as for assemblies, insofar as they function as standard parts. In that sense the DType definition for master documents of the type SOLIDWORKS Standard Part organized under DType definitions for parts ("SWP") as standard parts and modules ("SWA") as standard parts. The description of the DType definition for parts as standard part ("SWN"): DType definition for master documents of the type "SWN" for SOLIDWORKS parts <DType type="master" identifier="swnpr" include_template="slwmdl" application_type="slw" application_role="p"> <description language="en" text="solidworks Model SWN"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_part_$(family)16"/> </icon> <document_create document_type="swn" document_number_assignment="internal" rename_template_filename="no" change_to_after_create_status="aa"> <seedfile filename="modeltemplate.sldprt" type="select" default="no" extension_filter="*.sldprt"> <description language="en" text="select existing partfile"/> </seedfile> </document_create> <primary_application primary_workstation_application="swn" use_relative_path="yes"/> <allowed_nonmaster DType="NSWDR" max_count="99"/> </DType> Attributes of the element <DType> of the DType definition "SWNPR" type identifier "master" "SWNPR" Sets the type of DType defintion. "master" = It s a matter of a DType definition for master documents. Non-ambiguous ID string of this DType-definition in the entire XML document. The ID has to be between one to five characters long. "SWNPR" = ID of this DType definition / 85 -

51 include_template application_type application_role "SLWMDL" "SLW" "P" Determines which template definition should be integrated into this definition. "SLWMDL" = The DType template with the ID "SLWMDL" from this"dtype.xml" file is included. This is the generic definition. Designates the application that is relevant for this document (Workstation Application). This application opens the file from SAP Engineering Control Center. "SLW" = This is the work station application (WSAppl) for SOLIDWORKS. Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "P" = Identification of the object type for parts. the sub-element<icon> defines an acronym that will be used when determining the applicable symbol in SAP Engineering Control Center. In addition it includes the sub-element <icondef>. Attributes of the sub-element <icondef> of the sub-element <icon> icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_part_$(family)16" Position of the symbol within the document entry in the tree. "1" = leftmost, "6" = rightmost. Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard symbol. Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_part_$(family)16" = The icon file. The sub-element <document_create> determines the positioning of the document in SAP. Attribute of the sub-element <document_create> document_type document_number_assignment rename_template_filename change_to_after_create_status "SWN" "internal" "no" "AA" SAP document type for the newly created document. "SWN" = SOLIDWORKS part document as standard part. Defines the document number assignment in SAP. "internal" = SAP automatically assigns the number. Determines whether, for the document attachment, the file name of the original is renamed according to the established naming rules or if the file name of the template file is assumed unchanged. "no" = The filename of the original is assumed unchanged. Determines the original SAP status in the newly created document. "AA" = SAP status identification. The sub-element <seedfile> contains settings of the template file. Several template files can be assigned, i.e. <seedfile> may occur more than once. This includes the sub-element <description>, which defines each description text in different languages. Attributes of the sub-element <seedfile> of the sub-element <document_create> - 51 / 85 -

52 type default extension_filter "select" "no" "*.sldprt" Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. A template file can be selected within the dialog "Create document" via a file selection dialog. "select" = Selection of a template file in the dialog "Create document" is possible. This helps determine whether this template file is preset in the dialog "Create document". "no" = This template file has not been preset. When selecting a template file with the type ="select" this attribute defines the filter for the file extension. In the file selection dialog you can select files that are matched by the filter. "*.sldprt" = Filter for file extension. The sub-element<primary_application> determines which application is relevant for this master document (primary application) and defines the rules for the checking in and out of the originals. Attributes of the sub-element<primary_application> primary_workstation_application "SWN" "SWN" = Identification of the SAP workstation application for SOLIDWORKS standard parts. use_relative_path "yes" Determines whether for addressing a document of this type a relative path is to be used. "yes" = use of relative paths. The sub-element defines a specific document type allowed as non-master document. Attributes of the sub-element <allowed_nonmaster> DType max_count "99" "NSWDR" Specifies the DType allowed as nonmaster document. "NSWDR" = DType. Specifies the maximal number of nonmaster documents. "99" = Maximal number of nonmaster documents. Now the DType definition for SOLIDWORKS assemblies ("SWA") as master document: DType definition for master documents of the type "SWA" for SOLIDWORKS <DType type="master" identifier="swpas" include_template="slwmdl" application_type="slw" application_role="a"> <description language="en" text="solidworks assembly SWA"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_assembly_$(family)16"/> </icon> <document_create document_type="swa" document_number_assignment="internal" rename_template_filename="yes"> <seedfile filename="modeltemplate.sldasm" type="template" default="yes" extension_filter="*.sldasm"> <description language="en" text="standard assembly"/> </seedfile> <seedfile filename="modeltemplate.sldasm" type="select" default="no" extension_filter="*.sldasm"> - 52 / 85 -

53 <description language="en" text="select existing assembly"/> </seedfile> </document_create> <primary_application primary_workstation_application="swa"/> <allowed_nonmaster DType="NSWDR" max_count="99"/> </DType> Attributes of the element <DType> of the definition "SWPAS" type identifier include_template application_type application_role "master" "SWPAS" "SLWMDL" "SLW" "A" Sets the type of DType definition. "master" = It s a matter of a DType definition for master documents. Non-ambiguous ID string of this DType-definition in the entire XML document. This ID has to measure one to five characters. "SWPAS" = ID of this DType-definition. Specifies which template definition is implied in this definition. "SLWMDL" = The DType template with the ID "SLWMDL" from this "DType.xml" file is included. This is the generic definition. Identifier for the application relevant for this document (workstation application). This application opens the file from the SAP Engineering Control Center. "SLW" = This is the work station application (WSAppl) for SOLIDWORKS. Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "A" = Identification of the object type for SOLIDWORKS assemblies. The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP Engineering Control Center. In addition it includes the sub-element <icondef>. Attributes of the sub-elementes <icondef> of the sub-element <icon> icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_assembly_$(family)16" Icon position within the document entry in the tree. "1" = Leftmost, "6" = rightmost. Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon. Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_assembly_$(family)16" = The icon file. The sub-element <document_create>determines the position of the document in the SAP. Attributes of the sub-element <document_create> document_type "SWA" SAP document type for the newly created document. "SWA" = SOLIDWORKS assembly document / 85 -

54 document_number_assignment rename_template_filename "internal" "yes" Defines the document number assignment in the SAP. "internal" = SAP automatically assigns the number. Determines whether, for the document attachment, the file name of the original is renamed according to the established naming rules or if the file name of the template file is assumed unchanged. "yes" = the filename of the original is renamed in creating the document. The sub-element <seedfile> contains settings for the template file. Several template files can be assigned, d.h. <seedfile> may occur more than once. This includes the sub-element <description>, which defines each description text in different languages. Attributes of the 1. sub-element <seedfile> of sub-element <document_create> filename type default extension_filter "modeltemplate.sldasm" "template" "yes" "*.sldasm" In using the type="template" this attribute defines the filename of the template file that is used. There must be a file with this name, or the process will terminate with an error. "modeltemplate.sldasm" = Filename of the template file to be used. Determines how the original document will be generated. "template" = the attribute "filename" specifies the template file to be used. This determines whether the template file is preset in the dialog "Create document". "yes" = This template file is preset. When selecting a template file with the type="select" this attribute defines the filter for the file extension. In the file selection dialog you can select files that are matched by the filter. "*.sldasm" = Filter for file extension. Attributes of the 2. sub-element <seedfile> of sub-element <document_create> filename type default extension_filter "modeltemplate.sldasm" "select" "no" "*.sldasm" The attribute "filename" specifies the template file to be used. You can create a document in the dialog, select a template file via a file selection dialog. "modeltemplate.sldasm" = Filename of the template file Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. A template file can be selected in the dialog "Create document" via a file selection dialog. "select" = Selection of a template file in the dialog "Create document" possible. This helps determine whether a template file is preset in the dialog "Create document". "no" = This template file is not preset. When selecting a template file with the type="select" this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.sldasm" = Filter for the file extension. the sub-element <primary_application> determines which application is relevant for this master document (primary application) and defines the rules of this checking in and out of the originals. Attributes of the sub-element <primary_application> - 54 / 85 -

55 primary_workstation_application "SWA" "SWA" = identification of the SAP work station application for SOLIDWORKS assemblies. The sub-element <allowed_nonmaster> defines a specific document type allowed as nonmaster document. Attributes of the sub-element <allowed_nonmaster> DType max_count "99" "NSWDR" Specifies the DType allowed as nonmaster document. "NSWDR" = DType. Specifies the maximal number of possible nonmasterdocuments. "99" = Maximal number of nonmaster documents. A description of the DType definition for SOLIDWORKS assemblies as standard parts ("SWN") follows: DType definition for master documents of the type "SWN" for SOLIDWORKS assemblies <DType type="master" identifier="swnas" include_template="slwmdl" application_type="slw" application_role="a"> <description language="en" text="solidworks assembly SWN"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_assembly_$(family)16"/> </icon> <document_create document_type="swn" document_number_assignment="internal" rename_template_filename="no"> <seedfile filename="modeltemplate.sldasm" type="select" default="no" extension_filter="*.sldasm"> <description language="en" text="select existing assembly"/> </seedfile> </document_create> <primary_application primary_workstation_application="swn"/> <allowed_nonmaster DType="NSWDR" max_count="99"/> </DType> Attributes of the element <DType> of the definition "SWNAS" type identifier include_template "master" "SWNAS" "SLWMDL" Sets the type of DType definition. "master" = It s a matter of a DType definition for master documents. Non-ambiguous ID string of this DType-definition in the entire XML document. This ID has to be one to five characters long. "SWNAS" = ID of this DType definition. Specifies which template definition is implied in this definition. "SLWMDL" = The DType template with the ID "SLWMDL"from this "DType.xml" file is included. This is the generic definition / 85 -

56 application_type application_role "SLW" "A" Identifier for this application relevant for this document (work station application). This application opens the file from the SAP Engineering Control Center. "SLW" = For SOLIDWORKS this is the work station application (WSAppl). Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "A" = Identification of the object type for SOLIDWORKS assemblies. the sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP Engineering Control Center. In addition it includes the sub-element <icondef>. Attributes of the sub-element <icondef> of the sub-element <icon> icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_assembly_$(family)16" Icon position within the document entry in the tree. "1" = Leftmost, "6" = rightmost. Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon. Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_assembly_$(family)16" = The icon file. The sub-element <document_create> determines settings, how the document is created in the SAP. Attributes of the sub-element <document_create> document_type document_number_assignment rename_template_filename "SWN" "internal" "no" SAP document type for the newly created document. "SWN" = SOLIDWORKS assembly document as standard part. Defines the document number assignment in the SAP. "internal" = SAP automatically assigns the number. Determines whether, for the document attachment, the file name of the original is renamed according to the established naming rules or if the file name of the template file is assumed unchanged. "no" = The filename of the original is assumed unchanged. The sub-element <seedfile> contains settings for the template file. Several template files can be assigned, i.e. <seedfile> may occur more than once. This includes the sub-element;description>, which defines each description text in different languages. Attributes of the sub-element <seedfile> of the sub-element <document_create> type default "select" "no" Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. A template file can be selected in the dialog "Create document" via a file selection dialog. "select" = Selection of a template file in the dialog "Create document" possible. It can determine whether this template file is preset in the dialog "Create document". "no" = This template file has not been preset / 85 -

57 extension_filter "*.sldasm" 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. "*.sldasm" = File extension filter. The sub-element <primary_application> determines which application is relevant for this master document (primary application) and defines the rules for the checking in and out of the originals. Attributs of the sub-element <primary_application> primary_workstation_application "SWN" "SWN" = Identification of the SAP work station application for SOLIDWORKS standard parts. the sub-element <allowed_nonmaster> defines a specific document type which is allowed as nonmaster document. Attributes of the sub-element <allowed_nonmaster> DType max_count "99" "NSWDR" Specifies the DType allowed as nonmaster document. "NSWDR" = DType. Determines the maximal amount of possible nonmaster documents. "99" = Maximal number of nonmaster documents. Now we come to the DType definition of SOLIDWORKS-Drawings ("SWD") as master document: DType definition for master documents of the type "SWD" for SOLIDWORKS <DType type="master" identifier="mswdr" include_template="slwdrw" application_type="slw" application_role="d"> <description language="en" text="solidworks Drawing SWD"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_drawing_$(family)16"/> </icon> <document_create document_type="swd" document_number_assignment="internal" rename_template_filename="yes"> <seedfile filename="modeltemplate.slddrw" type="template" default="yes" extension_filter="*.slddrw"> <description language="en" text="standard drawing"/> </seedfile> <seedfile filename="modeltemplate.slddrw" type="select" default="no" extension_filter="*.slddrw"> <description language="en" text="select existing drawing"/> </seedfile> </document_create> <primary_application primary_workstation_application="swd"/> </DType> - 57 / 85 -

58 Attributes of the element <DType> of the definition "MSWDR" type identifier include_template application_type application_role "master" "MSWDR" "SLWDRW" "SLW" "D" Determines the type of the DType definition. "master" = It s a matter of a DType definition for master documents. Non-ambiguous ID string of this DType-definition in the entire XML document. The ID has to be between one to five characters long. "MSWDR" = ID of this DType definition. Determines, which template definition iis implied in this definition. "SLWDRW" = The DType template with the ID "SLWDRW" from this "DType.xml" file is being included. This is the generic definition for SOLIDWORKS drawings. Designates the application that is relevant for this document (Work Station Application). This application opens the file from the SAP Engineering Control Center. "SLW" = this is the work station application for SOLIDWORKS (WSAppl). Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "D" = identification of the object type for SOLIDWORKS drawings. The sub-element <icon> defines an acronym that will be used when determining the applicable symbol in SAP Engineering Control Center. In addition it includes the sub-element <icondef>. Attributes of the sub-element <icondef> of the sub-element <icon> icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_drawing_$(family)16" Icon position within the document entry in the tree. "1" = Leftmost, "6" = rightmost. Identification of a symbol group. Status-depending, other symbols can be represented. "default" = This is the standard icon. Path to determine the icon file, which contains the applicable symbol for this symbol position. "tree/slw/solidworks_drawing_$(family)16" = The icon file. the sub-element <document_create> determines, how the document is created in the SAP. Attributes of the sub-element <document_create> document_type document_number_assignment rename_template_filename "SWD" "internal" "yes" SAP document type for the newly created document. "SWD" = SOLIDWORKS drawing doument. Defines the document number assignment in SAP. "internal" = SAP automatically assigns the number. Determines whether, for the document attachment, the file name of the original is renamed according to the established naming rules or if the file name of the template file is assumed unchanged. "yes" = The filename of the original is renamed in creating the document / 85 -

59 The sub-element <seedfile> contains the settings for the template file. Several of template files can be assigned, i.e. <seedfile> may occur more than once. This includes the sub-element <description> which defines each description text in different languages. Attributes of the first sub-elementes <seedfile> of the sub-element <document_create> filename type default extension_filter "modeltemplate.slddrw" "template" "yes" "*.slddrw" In applying the type="template" this attribute defines the filenames of the template file to be used. There must be a file with this name, or the process will terminate with an error. "modeltemplate.slddrw" = filename of the template file to be used. Determines how the original document will be generated. "template" = The attribute "filename" indicates the template file to be used. Hereby it can be determined whether this template file is preset in the dialog "Create document". "yes" = This template file is preset. When selecting a template file with the type="select" this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.slddrw" = Filter for the file extension. Attributes of the 2. sub-element <seedfile> of the sub-element <document_create> filename type default extension_filter "modeltemplate.slddrw" "select" "no" "*.slddrw" The "filename" attribute is used to specify the template file that is to be used. They can create a document in the dialog, select a template file via the file selection dialog. "modeltemplate.slddrw" = data file of the file template. Determines how the original document will be generated. The "filename" attribute is used to specify the template file that is to be used. A template file can be selected in the dialog "Create document" via a file selection dialog. "select" = Selection of a template file in the dialog "Create document" possible. It can determine whether this template file is preset in the dialog "Create document". "no" = This template file has not been preset. When selecting a template file with the type="select" this attribute determines the file extension filter that is used. In the file selection dialog you can select files that are matched by the filter. "*.slddrw" = File extension filter. The sub-element <primary_application> designates the application which is relevant for this master document (primary application) and defines the rules for the checking in and out of the originals. Attributes of the sub-element <primary_application> primary_workstation_application "SWD" "SWD" = Identification of the SAP work station application for SOLIDWORKS drawings DType definition for nonmaster documents The SAP Engineering Control Center distinguishes between master documents and dependent documents. The latter are designated nonmaster documents and are assigned to their master document / 85 -

60 NOTE: It is recommended to maintain only the language English directly in the file "dtype.xml"! All other languages will be offered via the particular "dictionary.txt" file. This affects the definitions of DTypes and Seedfiles. All elements <description language="xy"> are omitted except English which are used as fallback. Here is the DType definition of the nonmaster documents for SOLIDWORKS for the type "SDN" nonmaster: DType definition for nonmaster documents for SOLIDWORKS <DType type="nonmaster" identifier="nswdr" include_template="slwdrw" application_type="slw" application_role="d"> <description language="en" text="solidworks Drawing SDN NonMaster"/> <icon> <icondef icon_position="1" icon_group="default" icon_identifier="tree/slw/solidworks_drawing_16"/> </icon> <document_create document_type="sdn" rename_template_filename="yes"> <seedfile filename="modeltemplate.slddrw" type="template" default="yes" extension_filter="*.slddrw"> <description language="en" text="standard drawing"/> </seedfile> <seedfile filename="modeltemplate.slddrw" type="select" default="no" extension_filter="*.slddrw"> <description language="en" text="select existing drawing"/> </seedfile> </document_create> <primary_application primary_workstation_application="swd"/> </DType> Attributes of the <DType> element of the "NSWDR" definition type identifier include_template application_type application_role "master" "NSWDR" "SLWDRW" "SLW" "D" Determines the kind of DType definition. "master" = Involves a DType definition for master documents. Non-ambiguous ID string for this DType definition within the entire XML document. The ID has to be between one and five characters long. "NSWDR" = Identification of this DType definition. Determines which template definition will be incorporated into this definition. "SLWDRW" = The DType template with the "SLWDRW" identification from this "dtype.xml" file will be included. This is the generic definition for SOLIDWORKS drawings. Designation for the application that is relevant for this document (Workstation Application). This application opens the file from the SAP Engineering Control Center. "SLW" =This is the Workstation Application (WSAppl) for SOLIDWORKS. Here you can adjust the object type setting in the RES4 field of the SAP table DRAW. "D" = Identification of the object type for drawings / 85 -

61 The <icon> sub-element defines an abbreviation that will be used when determining the applicable symbol in the SAP Engineering Control Center. It also comprises the <icondef> sub-element. Attributes of the <icondef> sub-element from the <icon> sub-element icon_position "1" icon_group "default" icon_identifier "tree/slw/solidworks_drawing_$(family)16" Position of the symbol within 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. Path to determine the icon file, which comprises the applicable symbol for this symbol position. "tree/slw/solidworks_drawing_$(family)16" = The icon-file. The <document_create> sub-element determines the way in which the document is created in SAP. Attributes of the <document_create> sub-element document_type rename_template_filename "SDN" "yes" SAP document type for the newly created document. "SDN" = SOLIDWORKS drawing document as nonmaster document. Determines whether, for the document attachment, the file name of the original will be renamed according to the established naming rules or if the file name of the template file will be assumed as is. "yes" = the filename of the original will be renamed in creating the document. The <seedfile> sub-element comprises settings for the template file. Several template files can be assigned, i.e. the <seedfile> may occur more than once. This comprises the <description> sub-element, which defines each description text in different languages. Attributes of the first <seedfile> sub-element from the <document_create> sub-element filename type default extension_filter "modeltemplate.slddrw" "template" "yes" "*.slddrw" When type="template" is used, this attribute defines the file name of the template file that will be used. There must be a file with this name, or the process will terminate with an error. "modeltemplate.slddrw" = File name of the template file that will be used. Determines how the original document will be created. "template" = The "filename" attribute is used to specify the template file that is to be used. This determines whether this template file should be used as a preset in the "Create Document" dialog. "yes" = This template file is preset. When selecting a template file with type="select", this attribute defines the file extension filter that is used. In the file selection dialog, the files that are matched by the filter will be offered for selection. "*.slddrw" = File extension filter. Attributes of the second <seedfile> sub-element from the <document_create> sub-element - 61 / 85 -

62 filename type default extension_filter "modeltemplate.slddrw" "select" "no" "*.slddrw" The "filename" attribute will be used to specify the template file that is to be used. You can create a template file in the document dialog with the help of a file selection dialog. "modeltemplate.slddrw" = File name of the template file. Determines how the original document will be created. The "filename" attribute will be used to specify the template file that is to be used. In the "Create Document" dialog, you can select a template file with the help of a file selection dialog. "select" = Makes it possible to select a template file in the "Create document" dialog. This determines whether this template file should be preset in the "Create Document" dialog. "no" = This template file is not preset. When selecting a template file with type="select", this attribute defines the file extension filter. In the file selection dialog, you are offered the files that are matched by the filter. "*.slddrw" = File extension filter. The <primary_application> sub-element determines which application is assigned to this master document (primary application) and defines the rules for the checking in and out of the originals. Attributes of the <primary_application> sub-element primary_workstation_application "SWD" "SWD" = Identification of the SAP Workstation Application for SOLIDWORKS 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. 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: - 62 / 85 -

63 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>>"/>... </node> </structure> <card name="<<card X>>"> <option label="..." type="..." prefname="..." tooltip="..."/> <option label="..." type="..." prefname="..." tooltip="..."> <entry name="..." value="..."/> <entry name="..." value="..."/> <entry name="..." value="..."/> </option>... </card> <card name="<<card Y>>"> <option label="..." type="..." prefname="..." tooltip="..." maxchars="..."> <entry name="..." value="..."/> <entry name="..." value="..."/> </option> <option label="..." type="..." prefname="..." tooltip="..." maxchars="..."/> - 63 / 85 -

64 ... </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="..." card="..." Name Card identifier (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. 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="solidworks"> <node card="miscellaneous" label="plm.options.card.misc"/> <node card="application structure" label="plm.options.card.application.structure"/> </node> Dictionary identifiers can and should also be used for the following attributes: <option label="...">, <option tooltip="..."> and <entry name="..."> With the element <card> you define the options that can be reached under the respective card note. The assignment is done via name of card. Attribut of element <card> 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. label="..." type="..." Name or description of the option Data type Attributs of sub-element <option> Description of the option as appears on the card under "Description" 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" - 64 / 85 -

65 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 SOLIDWORKS after launch. As this deals with a traditional batch file, command line instructions such as "set" and "if" can also be used here, as well as contents of already existing environment variables, with the notation "%<<Variable name>>%". NOTE: As the SAP Engineering Control Center Interface to SOLIDWORKS do not require any special environment variables but the SAP Engineering Control Center does expect a CAD-specific file "plm_setenv.bat", and this file does not contain any definitions of environment variables after installation, and is therefore empty! 2.7 rfc-tunnel-whitelist.txt The configuration file "rfc-tunnel-whitelist.txt" contains a list of all RFC function modules that can be called by the SAP Engineering Control Center Interface to SOLIDWORKS via the ECTR. Calling RFC function modules that are not contained in this list is rejected with an error. With this white list, the SAP Engineering Control Center Interface to SOLIDWORKS follows the security concept of the ECTR and enables you to ensure that only permitted RFC function modules can be executed. The standard configuration includes the following RFC functions that are allowed to be executed: /DSCSAG/MM_GETNONMASTER2 /DSCSAG/DOC_BOM_MAINTAIN3_MULT CDESK_SRV_MODIFY_INST_DATA - 65 / 85 -

66 The wildcard character '*' is allowed when specifying the RFC function. This makes it possible to specify entire groups of RFC functions that have the same prefix in their names, for example. 2.8 Version information To gain an overview of the imported changes of the relevant releases of the SAP Engineering Control Center Interface to SOLIDWORKS, the changes are listed here in the configuration files "default.txt" and "dtype.xml". The following table contains changes in parameters in the configuration file "default.txt". The status shows whether the relevant parameter in this version was added ( ), changed ( ) or deleted ( ). When changing a parameter, merely a new parameter name is given. Version Status Parameter Changes in configuration file "default.txt" plm.options.checkin.updateattributesfromsap.slw plm.options.bomtable.addnonexistingcolumns.slw plm.options.bomtable.column.slw.[cad_column] plm.options.ballooning.ballooncontent.slw plm.options.saveasnewdocument.replace.slw plm.structure.application.displaysuppressedcomponents.slw plm.execute.additional.slw plm.options.actionwhenvirtualcomponentwithreferencestorealcomponentsfound.slw plm.convert.additional.slw plm.options.missingreferencereloadoption.slw plm.options.changefeaturetreedisplayonlyforwritabledocuments.slw plm.options.createdirdialogforvirtualcomponent.slw plm.options.suppressalwayssaveasdialogforreadonlyconverteddocuments.slw plm.options.createdirdialogfordefeature.slw plm.library.slw.<library name> plm.options.createdirduringmakedrawingorassemblyfrompartorassembly.slw plm.options.deselectcadoptionforprompttosavereadonlydocuments.slw plm.options.checkin.deselectcadoptionforprompttosavereadonlydocuments.slw plm.options.deliverspecificsheetproperties.slw - 66 / 85 -

67 plm.options.deliverphysicalpropertiesindocumentunit.slw plm.convert.additional.slw plm.options.structureanalyze.cachedocumentkeysusedforinstanceids.slw plm.options.applicationstructure.additionalattributes.slw plm.options.applicationstructure.collectentries.slw plm.options.checkin.abortanalysisofcheckedincomponents.slw plm.options.checkin.deselectcadoptionforprompttosavereadonlydocuments.slw plm.options.excludefrombom.loadcomponentstoreadchildcomponentdisplayinbom.slw plm.options.new.saveactivedocument.slw plm.options.applicationstructure.displayadditionalattributes.slw plm.options.showcomponentnameandordescriptioninfeaturetree.slw plm.options.importondemand.loadresolvedforsave.slw plm.option.activeconfigurationonly.slw plm.options.maximumnumberofgdiobjects.slw plm.options.structureanalyze.showdialogformissingreferences.slw plm.options.sapopenforloaddrawing.slw plm.options.new.saveactivedocument.slw plm.options.deliverphysicalpropertiesconfigurationspecific.slw plm.options.importondemand.updateattributes.slw plm.options.save.updatephysicalpropertiesduringsave.slw plm.loadoptions.slw.documentloadmode plm.options.sapopenforcadplacedocument.slw plm.structure.application.init.strategy.levels.slw plm.options.import.standardpart.dark.slw plm.options.sapopenforcadopendocument.slw - 67 / 85 -

68 plm.document.dtype.toolboxpart.slw plm.options.importondemand.loaddrawings.slw plm.options.save.loaddrawings.slw plm.options.save.saveexternalreferences.slw plm.options.applicationstructure.hidestructureofspeedpaks.slw plm.structure.application.sendinstancesforgeneric.slw plm.structure.application plm.options.applicationstructure.collectentries.slw plm.options.applicationstructure.displayadditionalattributes.slw plm.options.applicationstructure.additionalattributes.slw plm.document.saveasnewdocument.checkouttop.slw plm.options.createdirfornewdocument.slw plm.options.importondemand.updateattributes.slw The following table contains changes in the configuration file "dtype.xml": Changes in configuration file "dtype.xml" Version Description The template definitions for "SLWMDL" and "SLWDRW" have got the attribute from_application_only="yes" in their checkin_rules ATTENTION: The attribute "from_application_only" can only be processed from ECTR version onwards, an older ECTR version terminates with an error message! If you are working with an older ECTR, you should use the file "dtype xml" instead of the current "dtype.xml", which is located in the directory "template_customize". It is recommended to maintain only the language english directly in the file "dtype.xml"! All other languages will be offered via the particular "dictionary.txt" file. This affects the definitions of DTypes and Seedfiles. All elements <description language="xy"> are omitted except english which are used as fallback / 85 -

69 3 Configuration examples In the following chapter, various configuration options in the ECTR environment are presented using process-related examples based on the SOLIDWORKS interface. The intention is to illustrate how the various requirements can be implemented. This chapter should be used just as an aid. The values to be configured are described using placeholders and should be replaced, in actual use, according to customer requirements. 3.1 Mapping the properties The mapping (transfer) of properties displays how values can be transferred from SOLIDWORKS to fields in SAP and vice versa. There are several options on both sides how values are read and where these are written. Basically, we distinguish between document-, material- and user-specific properties in SOLIDWORKS. These properties are listed in chapter "Available properties". Fields of the document info record and the material are provided in SAP. Document and material classes can be filled or read further on. With SOLIDWORKS, material properties can also be transferred depending on the variant. The configuration itself can be made in files "attributes-to-sap.xml" and "attributes-from-sap.xml" vorgenommen. A detailed description of the structure of these files can be found in the corresponding section "attributes-from-sap.xml and attributes-to-sap.xml". On the part of the ECTR interface, two so-called "metainf" XML files are provided in the user working directory, specifically in the subfolder of the appropriate document info record. The file "plm_metainf-cad.xml" contains all properties from the CAD, and the file "plm_metainf-sap.xml" contains all properties transferred through SAP with current values. If the file "plm_metainf-cad.xml" doesn't contain all data, you need to check the parameters described in section "Available properties" that are used for all properties and not only for the requested ones. Path of "metainf" files - 69 / 85 -

70 Example of a "plm_metainf-cad.xml" Please note that material-specific properties in SOLIDWORKS can be read and written to the desired SAP field. However, these properties are firmly defined in SOLIDWORKS and therefore should not be overridden by values from SAP Available properties If the properties are not listed in the following table, all properties transferred with the current settings can be read from the log files. For this to be possible, the following radio buttons must be changed in the file "default.txt": plm.options.deliveronlyrequestedattributestosap.slw This parameter must be set to "false" further on. After that, all available parameters can be read in the user directory of the ECTR. Please note that drawings, components and assemblies all have different characteristics and thus the related subfolders must be checked for all document types. The specific log files are written in subfolders with the name of the document and include all properties that are available for a document. The file "plm_metainf-cad.xml" must be checked for properties that should be transferred to SAP from SOLIDWORKS. The file "plm_metainf-sap.xml" must be checked for all information read from SAP. An appropriate block for an attribute in this file has the following structure: Example of a read property in "plm_metainf-cad.xml" <ATTRIBUTE NAME="DP-SW_Last_Saved_Version"> <VALUE>SOLIDWORKS 2016</VALUE> </ATTRIBUTE> The attribute name in the configuration files can be used here to map the properties. The properties that are not available for all documents are listed only in these associated XML files. This function should be changed only during the configuration and should be set to "true" after the successful setting of desired parameters in order to avoid an unnecessary overhead during data transfer. All properties provided by default in SLW are listed below. properties for SOLIDWORKS components, assemblies, drawings and materials Material property PP-Material Description Material code in the form [[SOLIDWORKS material collection]/[material name]] - 70 / 85 -

71 PP-Material_Only PP-Density PP-DensityUnit PP-Surface PP-SurfaceUnit PP-Volume PP-VolumeUnit PP-Weight PP-WeightUnit PP-CenterOfMassX PP-CenterOfMassY Material code Material density Unit of material density used Surface size Surface unit used Material volume Unit of material volume used Material weight Weight unit used Coordinates of the center of mass PP-CenterOfMassZ PP-MomXX PP-MomXY PP-MomYY PP-MomYZ Main axes of inertia PP-MomZZ PP-MomZX Properties of a drawing DP-Sheetsize DP-Sheets General document properties DP-SW_Last_Saved_Version DP-SW_Lastest_Version DSI-SumInfoAuthor DSI-SumInfoComment DSI-SumInfoSubject DSI-SumInfoTitle DSI-SumInfoKeywords DSI-SumInfoCreateDate DSI-SumInfoSaveDate DSI-SumInfoSavedBy Description Format of sheets in a drawing Number of sheets in a drawing Description SOLIDWORKS version used when saved last Version information of the installed SOLIDWORKS version Author of the document Comment in the file information Subject in the file information Title in the file information Keywords in the file information Creation date Date of the last save operation User that saved the document last When transferring properties from SAP objects to SOLIDWORKS document properties please note that some properties cannot be changed and therefore cannot be overwritten in this direction. These include all material properties, the properties of a drawing and the following document properties: DP-SW_Last_Saved_Version DP-SW_Lastest_Version DSI-SumInfoCreateDate DSI-SumInfoSaveDate - 71 / 85 -

72 DSI-SumInfoSavedBy Use custom properties Within SOLIDWORKS, it is possible to create different user-defined properties. All newly defined property names can also be found in the configuration files "attributes-to-sap.xml" and "attributes-from-sap.xml" be used. If user-defined properties are not present in the concrete document, all mapping instructions are ignored. The following example shows the definition of a new addition property, which is written in the corresponding document classification, then changed from the SAP object and loaded in a modified form in the CAD. Property in SOLIDWORKS Customised properties can be found in the SOLIDWORKS, document-related, via the menu item "File\Properties" can be achieved. To define a new property, an entry can be inserted within the table. Properties transferred from SAP that have not yet been created are created automatically / 85 -

73 Menu Item - 73 / 85 -

74 Create the appropriate configurations Summary Information To be able to transfer the new property to SAP, the "attributes-to-sap.xml" Can be configured accordingly. In the example, a mapping is listed in an SAP document class. The property previously defined in the SOLIDWORKS is shown in the following example "CAD_Eigenschaft" respectively. Sample configuration attributes-to-sap.xml <DIR_CLS class="[sap-classname]" classtype="[sap-classtype]" characteristic="[sap-characteristic]"> <APPL_ATTRIBUTE name="cad_attribute" /> </DIR_CLS> To transfer a value from SAP to a SOLIDWORKS property, the "attributes-from-sap.xml" can be configured accordingly. In the following example, "CAD_Eigenschaft" for the SOLIDWORKS attribute. Sample configuration attributes-to-sap.xml <APPL_ATTRIBUTE name="cad_eigenschaft" hidden="false"> <DIR_CLS class="[sap-classname]" classtype="[sap-classtype]" characteristic="[sap-characteristic]"/> </APPL_ATTRIBTUE> - 74 / 85 -

75 If the document is now stored in SOLIDWORKS, via the functions of the ECTR interface, the properties are transferred to SAP. Transferring the values from SAP to SOLIDWORKS takes place when you open it for editing or via the menu entry "SAP PLM\Attribute update" Material-specific mapping ECTR - Display of Classification In SOLIDWORKS a distinction is made between variant-dependent and variant-independent mapping of material properties. This configuration is always set globally and any change to the methodology absolutely requires the ECTR to be restarted. The changeover from variant-dependent to variant-independent mapping is performed with the aid of the following parameters. plm.options.deliverphysicalpropertiesconfigurationspecific.slw It should also be noted that when variant-independent mapping is activated, material properties cannot be written in the document class. For this case, the mapping methodology must be altered or a definite user-defined property must be created for the document in SOLIDWORKS, which is valid for the document in general and not just for a specific configuration Variant-specific Should variant-specific data be transferred, the following parameter must be set in "default.txt" / 85 -

76 plm.options.deliverphysicalpropertiesconfigurationspecific.slw = true All material properties or user-defined variant-specific properties must have "$(variant)-" as a prefix so that they can be transferred to the correct configurations in the ECTR. A corresponding mapping in the configuration file "attributes-tosap.xml" is defined as follows. Example for variant-specific mapping of the weight unit in the corresponding SAP field of a material <MA field="[sap-field name]"> <APPL_ATTRIBUTE name="$(variant)-pp-weightunit" /> </MA> The weight unit can also be written in the material class of the material. Example for variant-specific mapping of the weight unit to a material class <MA_CLS class="[sap-class name]" classtype="[sap-class type]" characteristic="[sap-property]"> <APPL_ATTRIBUTE name="$(variant)-pp-weightunit" /> </MA_CLS> "PP-WeightUnit" can be replaced by any property available in SOLIDWORKS here. User-defined properties defined in the file information can be configured the same way. Please note that variant-specific properties cannot be written into document classes. If such properties should be transferred into document classes, you must create custom variant-independent properties in the SOLIDWORKS file data for this purpose. All variant-independent document attributes (e.g., editor, CAD version, creation date or userdefined properties) will further be specified without the aforementioned prefix "$(variant)-". Variant-specific data can only be transferred from SAP to SOLIDWORKS by using a BAdI extension and is otherwise not supported. Configuration in ECTR To ensure a correct mapping of material-specific properties, it is necessary to make additional configurations in the ECTR. A material must always be linked to a configuration so that the specific properties can be written to this SAP material.the link can be created by a simple Drag & Drop of the material to the appropriate configuration. Should only a default configuration of the document exist, the already mentioned material link must be created. The material link can be created as follows. Creating or assigning materials to documents You can create the materials or link the already existing materials using the context menu functions for the document. An existing material can be stored directly within the document info record in the "Object Links" tab / 85 -

77 Creating materials by using the ECTR context menu - 77 / 85 -

78 Linking materials to the document info record Material links are displayed in the ECTR with a material symbol. An existing material link can also be tested in the "Object Browser" when selecting a document / 85 -

79 Material link to documents available - 79 / 85 -

80 Material linking in the ECTR "Object Browser" If you want to transfer values to a class of materials, these must be already assigned to the material. If the classification is missing, no data can be written. This is true also for document classes / 85 -

81 The material has a material class As the last step, the linked materials need to be assigned to the appropriate configurations. This can be done by a simple "Drag & Drop" / 85 -

82 Adding material link for a configuration This action must be repeated for multiple configurations. At the end, the document in the ECTR should have the following structure. Each configuration will have a correspondingly linked material. Under these conditions, material properties can be transferred depending on the variant / 85 -

83 Fully configured component in the "Desktop" window Even if only the standard/default CAD variant is available, it is necessary to link the material with the variant when configuring the variant-specific mapping. Otherwise, no properties can be transferred Variant-independent It is possible to write attributes from SOLIDWORKS into SAP objects, without taking different configurations into account. To do this, the following parameters must be set: plm.options.deliverphysicalpropertiesconfigurationspecific.slw = false If no configurations have been created (for example, only a standard configuration exists), this option can still be used. With variant-independent mapping, it is not necessary to create material links to existing configurations. They are not - 83 / 85 -