Installation Guide CUSTOMER Document Version: 11.0 2017-09-29
Typographical Conventions Format Example Description Words or characters that are quote from the screen display. These include field names, captions, button names, menu paths and menu options. Cross-references to text in other documentation. Example EXAMPLE Example Example <Example> Highlighted words or expressions Technical names of system objects. These include report names, program names, transaction codes, table names and individual core terms of a programming language that are surrounded by continuous text, such as SELECT and INCLUDE. Output on the screen. This includes file and directory names and their paths, messages, names of variable and parameters, source code and names of installation, upgrade and database tools. Exact user input. This includes words or characters, which you enter in exactly the way they are specified in the documentation. Variable user input. Pointy brackets indicate that you replace these words and characters for entries in the system with corresponding entries. EXAM PLE Buttons on the keyboard, e.g. F2 or EN TER. 2 Typographical Conventions
Document History Note Before you start the implementation, make sure you have the current version of this document. The version is available on the SAP Service Marketplace at http://service.sap.com/instguides. Version Date Change 1.0 2015-11-01 Initial creation 2.0 2015-12-04 Information added to "System Requirements" section 3.0 2015-12-11 Information added to "System Requirements" section 4.0 2016-01-29 Information added to "System Requirements" section 5.0 2015-05-13 Textual Improvements "BAdI Implementations for SAP Engineering Control Center" section updated 6.0 2016-06-10 Information added to "System Requirements" section Textual Improvements 7.0 2016-10-28 Note added to "SAP Front-End Installer" 8.0 2016-11-25 Information added to "System Requirements" section 9.0 2017-04-07 Note extended in "SAP Front-End Installer" 10.0 2017-06-30 "Java Connector Update" section added 11.0 2017-09-29 System Requirements updated SAP Engineering Control Center Document History 3
Contents 1 Introduction... 5 1.1 About this Document... 5 1.2 Before You Start... 5 1.2.1 SAP Notes for the Installation... 5 1.2.2 Information on SAP Service Marketplace... 6 1.2.3 Naming Conventions... 6 2 Preparation... 7 2.1 System Requirements... 7 2.2 Users for Installation and Configuration... 7 2.3 Setting up the SAP System... 10 2.3.1 KPro... 10 2.3.2 SAP Installation Server... 10 3 Installation... 11 3.1 SAP Front-End Installer... 11 3.2 Installation Environment... 11 3.3 BAdI Implementations for SAP Engineering Control Center... 13 3.3.1 BAdI DOCUMENT_MAIN01... 14 3.3.2 BAdI EQUI_Update (Optional)... 16 3.4 Configuring Enhancements (User Exits)... 16 3.4.1 MGA00001 Material Master (Industry): Checks and Enhancements (Optional)... 16 3.4.2 CLFM0002 Call classification data before saving (Optional)... 17 3.4.3 ILOM0001 - Additional checks before saving a functional location (Optional)... 18 3.5 Final Steps... 19 4 Update of Configuration-Specific Files... 20 4.1 Update des Java-Connectors...20 4 SAP Engineering Control Center Contents
1 Introduction SAP Engineering Control Center is quick and easy to install. For development purposes, you first create a standard installation in an SAP system. You can test customer-specific modifications there. This minimizes the risk of errors in the final installation. 1.1 About this Document Purpose The Installation Guide provides system administrators with all important information regarding the installation and post-installation of SAP Engineering Control Center. Integration A working SAP system is the prerequisite for installing SAP Engineering Control Center. 1.2 Before You Start 1.2.1 SAP Notes for the Installation You have to read the following SAP notes and implement them in the SAP system before you start the installation. These SAP Notes contain the latest information regarding the installation as well as corrections for the installation documentation. The latest versions of the SAP notes are available at: http://service.sap.com/notes SAP Note Number Title 2049249 Release strategy for ABAP add-on ECTR 2050165 Release strategy for ABAP add-on ECTRWUI Introduction 5
1.2.2 Information on SAP Service Marketplace Documentation Title Master Guide Configuration Guide Operations Guide Internet Address http://service.sap.com/instguides http://service.sap.com/instguides http://service.sap.com/instguides General Links Title SAP Notes Installation Guides Security Guide SAP Help Portal OSS Messages Internet Address http://service.sap.com/notes http://service.sap.com/instguides http://service.sap.com/security http://help.sap.com Creation in component PLM-ECC 1.2.3 Naming Conventions This documentation uses the following naming conventions: Variables Add entries for your component or remove entries as required. Variables <SAPSID> <sapsid> <DBSID> <dbsid> <INSTDIR> <MEDIA-DIR> <OS> Description SAP system ID in uppercase letters SAP system ID in lowercase letters Database system ID in uppercase letters Database system ID in lowercase letters Installation directory Media directory Operating system 6 Introduction
2 Preparation 2.1 System Requirements The following requirements must be met for the installation: You have one of the following operating systems installed: o Windows 7 (64-Bit) o Windows 8 (64-Bit) o Windows 10 (64-Bit) You are using the following servers: o SAP ECC 6.0 or higher with the following component level o See Note 2049249 o SAP Kernel Release 721 and above Client: SAP GUI, Version 740 and above To successfully integrate SAP 3D Visual Enterprise Viewer, the following prerequisites must be met: SAP 3D Visual Enterprise Viewer - Version 8.0.101 (8.0 SP1 MP1) Note that to successfully install the add-on for SAP 3D Visual Enterprise Viewer, the viewer must be installed before SAP Engineering Control Center. Otherwise, the option required to install the add-on will not be displayed in the SAP Front-End Installer. Component PLMWUI is prerequisite for optional SAP PLM 7 functionality (ECTRWUI). The back-end add-on ECTRWUI is required for the "PLM Web UI" add-on. The functions also require SAP component PLMWUI.44 to be installed. See Note 2050165 To successfully integrate Microsoft Office, the following prerequisites must be met: Microsoft Word - Versions 2007 (32-Bit), 2010,2013 and 2016 Microsoft Excel - Versions 2007 (32-Bit), 2010,2013 and 2016 Microsoft PowerPoint - Versions 2007 (32-Bit), 2010,2013 and 2016 For VEConverter to be integrated successfully, the following requirements must be fulfilled: Current version of VEConverter is on a 64-bit Windows operating system Windows 7 / Windows Server 2008 and higher 2.2 Users for Installation and Configuration The following users are required for successful installation: Preparation 7
Operating System A user with administrator rights or via the SAP Installer SAP System A user with authorization for the following authorization objects Authorization Description S_C_FUNCT S_GUI Authorization for SAP GUI activities S_PROGRAM S_RFC S_TCODE Authorization for transaction CDESK S_USER_GRP S_WF_WI C_AENR_BGR C_AENR_ERW C_KLAH_BKP C_DRAD_OBJ C_DRAW_BGR C_DRAW_DOK C_DRAW_STA C_DRAW_TCD C_DRAW_TCS CC change number authorization group CC change service enhanced authorization check Authorization class maintenance Object links Create/Change/Display/Delete Authorization for authorization groups Authorization for document access Authorization document status Authorization activities for documents Status-specific authorizations for documents C_DRZA_TCD C_DRZI_TCD C_STUE_BER C_STUE_WRK C_TCLA_BKA M_MATE_MAN CS Bill of Material authorizations CS Bill of Material plant (plant assignments) Authorization class types Material: central data M_MATE_MAR M_MATE_STA Material: maintenance status M_MATE_WRK M_MATE_WGR Material: goods group 8 Preparation
Please take the authorization objects from the following SAP Notes into consideration: Note Description 555812 - CDESK CAD desktop: required authorization Use template role /DSCSAG/ECTR_BASE. A user with a development key (for BAdIs) and the authorization for these transactions (in addition to the authorization objects above) Authorization SE03 SE09 SE11 SE16n SE18 SE19 SE30 SE37 SE38 SE80 SE91 SE93 SPRO SU01 OAC0 - KPRO OACT - KPRO CSADMIN ST22 STMS SLG1 SM12 SM21 SM59 ST01 ST05 Description Transport utilities Manage orders Display SAP DDIC Display table content BAdI definition BAdI implementation Performance analysis Execute function modules Execute reports Start ABAP Workbench Display messages Display transactions Customizing Display user(s) Maintain content repositories Maintain storage categories Monitor KPro Display runtime error Transport overview Application log Lock overview System log RFC connection configuration (activate trace) System trace SQL trace Preparation 9
2.3 Setting up the SAP System 2.3.1 KPro SAP Engineering Control Center requires the Knowledge Provider (KPro). KPro is an independent tool for storing originals. KPro uses special BAPIs for storing / removing (check-in / checkout) documents, to link originals and for caching. Make the following default settings and check the prerequisites: Store all document types in the KPro, not just the CAD documents. When you set up a new workstation, install an SAP GUI (latest version) first. Make sure you have access and the required rights for an SAP system. The SAP system is connected to a running KPro server. Check the connection using transaction CV01N. You have made a note of the KPro storage category for the installation transaction. You can read this information in default.txt. 2.3.2 SAP Installation Server If you have a central installation, you need an SAP Installation Server. If you distribute an installation across any number of client machines, the installation is central. For more information, see SAP Service Marketplace under: http://service.sap.com/sltoolset 10 Preparation
3 Installation 3.1 SAP Front-End Installer You can install SAP Engineering Control Center in your system landscape via the SAP Front-End Installer. 1. Execute the file SAP ECTR 5.1.exe with administrator rights. 2. In the following dialog, choose the components to be installed. 3. Follow the instructions in SAP Front-End Installer. Note When you enter the installation path, only the following characters are permitted: [A-Z], [a-z], [0-9], [+;-;_], spaces are replaced with an underscore 3.2 Installation Environment The following sections explain the directory structure of the installation environment: Installation of files Settings in the files Adaptation of the installation to customer-specific requirements The notation of the following directory tree follows the Windows notation but applies analogously to Unix environments. Directory Structure %PLM_INSTDIR% _ addons\ _ basis\ Description %PLM_INSTDIR% is the installation directory. In the Windows environment this is normally C:\Program Files (x86)\sap\ectr This directory contains additional functions that enhance the scope of SAP Engineering Control Center. This can be, for example, an integrated viewer. Contains various folders with the system components for the basic installation. The contents of these folders might be overwritten during updates. A separate folder structure is available for customer-specific adaptations. _ aux-files\... This directory contains the definitions as well as additional files that are necessary for execution. _ classes\ This directory contains the jar archives that are required Installation 11
Directory Structure Description for execution. _ \patch_v5.x.x _ config\ _ dictionary\ _ de _ en In this directory, errors are corrected and enhancements are made to the files in the jar archives. The respective updates can be downloaded from https://service.sap.com/. This directory contains the preference files, which must be adjusted to the respective environment. Preference files are text files containing the definition of environment variables that control the response of the SAP PLM integration. This directory contains the default dictionary file. The file can be available in several languages. _ scripts\... sys\win\ bin\... icons jre32\... jre64\... lib32 lib64 Contains the source texts of the start files. Contains various folders with system components. This directory contains various start files that are required for execution. This directory contains various symbols. SAP Engineering Control Center works with different applications. A symbol can be assigned to an application and represent it. This directory contains the Java runtime environment, which is required for execution. SAP Engineering Control Center uses version 1.8.0. This directory contains the.dll files that are required for execution. _ customize\ This directory contains the folders with the settings files with which extensive customer-specific adjustments can be made to the response of SAP Engineering Control Center. You will see available licenses and auxiliary programs at this point. The contents of these directories are not overwritten during an update. _ aux-files This directory contains customer-specific api definitions. 12 Installation
Directory Structure Description _ classes\... _ config -specific classes are stored here. In these classes, SAP Engineering Control Center can be adjusted to the requirements of the respective customer. This directory contains the preference files, which must be adjusted to the respective environment. Preference files are text files with the definition of environment variables that control the response of the SAP PLM integration. _ dictionary\ _ de _ en _ exec\win\ _ addutils This directory is intended for customer-specifically adapted dictionary files. Directory for customer-specific program files. _ license This directory contains the license file, which is called activation.txt. _ scripts\... Directory for customer-specific script files. _ documentation _ de\... _ en\... _ templates This directory contains documentation such as the Application Help. This directory contains the template files for the different document types. 3.3 BAdI Implementations for SAP Engineering Control Center For the functionality of SAP Engineering Control Center, certain Business Add-Ins (BAdIs) must be implemented and activated. Note the following: Implement the BAdIs in the customer namespace and assign these BAdIs to an existing package. Activate the new BAdIs. Any existing BAdI implementations in the /DSCSAG/ namespace are merely used as copy templates. You must not activate these BAdIs. The relevant SAP transactions are SE18 (BAdI Builder Definitions) and SE19 (BAdI Builder Implementations). Installation 13
3.3.1 BAdI DOCUMENT_MAIN01 Method BEFORE_SAVE This method is used for validation, check and addition of document data prior to saving the document. The method doc_before_save fills the tables /DSCSAG/DOC_RED, /DSCSAG/DOC_VERS, and the CDESK_DRAW. When documents are created in SAP GUI, a colon (":") is not set in the draw-res4. As a result, the BAdI implementation is not called. If you want to call the BAdI implementation for such documents, you need to set the preference variable SAP.PLM.BADI.ADDITIONAL.DOCTYPES in front-end Customizing. Note If this method is not implemented, documents cannot be displayed or edited properly in SAP Engineering Control Center. METHOD if_ex_document_main01~before_save. ******************************************************************** * for PLM / SAP Engineering Control Center ******************************************************************** IF draw-res4 CA ':' OR /dscsag/preferences=>stringvalue( /dscsag/preferences=>cv_prefn_badi_doctype_addit ) CS draw-dokar. CALL METHOD /dscsag/utils=>doc_before_save EXPORTING api_flag = api_flag tcode = tcode CHANGING update_task = update_task draw = draw drat = drat drad = drad drap = drap draz = draz docfiles = docfiles. ENDIF. ENDMETHOD. Method AFTER_SAVE This method contains functions that are called when a document is saved: The doc_after_save method checks table /dscsag/check to determine whether SAP Engineering Control Center is active for the user. If this is not the case, the method is terminated immediately. 14 Installation
This method is used to update SAP Engineering Control Center when changes are made to documents (Observer). Note If this method is not implemented, metadata displayed along with documents may be outdated. METHOD IF_EX_DOCUMENT_MAIN01~AFTER_SAVE. ********************************************************************* * for PLM / SAP Engineering Control Center ********************************************************************* CALL METHOD /dscsag/utils=>doc_after_save EXPORTING api_flag = api_flag tcode = tcode draw = draw drat = drat drad = drad drap = drap draz = draz docfiles = docfiles. ENDMETHOD. Installation 15
3.3.2 BAdI EQUI_Update (Optional) Methode EQUIPMENT_IN_UPDATE This method is used to update SAP Engineering Control Center when equipment is changed (Observer). Note If this method is not implemented, metadata displayed along with equipments may be outdated. METHOD if_ex_equi_update~in_update. ********************************************************************* * for PLM / SAP Engineering Control Center ********************************************************************* DATA: ls_object TYPE /dscsag/ch_obj2. IF i_data_equi-itob-equnr IS NOT INITIAL. CLEAR ls_object. ls_object-objecttable = /dscsag/cl_constants=>mc_dsc_equi. ls_object-objectkey = i_data_equi-itob-equnr. MOVE sy-uname TO ls_object-changed_by. /dscsag/utils=>timestamp( IMPORTING changed_at = ls_object-changed_at ). CALL FUNCTION '/DSCSAG/UPD_OBJECT2' EXPORTING object = ls_object commit = ' '. ENDIF. ENDMETHOD. 3.4 Configuring Enhancements (User Exits) 3.4.1 MGA00001 Material Master (Industry): Checks and Enhancements (Optional) To automatically display the change of a material in SAP Engineering Control Center (Observer), enhancement MGA00001 must be implemented. Note If this enhancement is not implemented, metadata displayed along with materials may be outdated. Procedure 1. Check whether the enhancement already exists in the SAP system: Display EXIT_SAPLMGMU_001 using transaction SE37. 16 Installation
2. Double-click on "ZXMG0U02": If the message Include ZXMG0U02 does not exist is displayed, the enhancement has not been implemented yet and has to be created. 3. Implement the enhancement. To do this use transaction CMOD to create a new project, for example, "ECTR" and assign enhancement MGA00001 using Assign Enhancement. 4. Activate the components. 5. Double-click on exit EXIT_SAPLMGMU_001 and create the include. If a warning is displayed, confirm the warning. 6. Insert the source code in include ZXMG0U02. ********************************************************************* * for PLM / SAP Engineering Control Center ********************************************************************* CALL METHOD /dscsag/utils=>exit_saplmgmu_001 EXPORTING wmara stext = wmara = stext[] EXCEPTIONS application_error = 0 OTHERS = 0. 3.4.2 CLFM0002 Call classification data before saving (Optional) To automatically display the change of a class (for example, in CL24n, CL20n) in SAP Engineering Control Center (Observer), enhancement CLFM0002 must be implemented. Note If this enhancement is not implemented, metadata displayed along with classes may be outdated. Procedure 1. Check whether the enhancement already exists in the SAP system. To do this, display function module EXIT_SAPLCLFM_002 using transaction SE37. 2. Double-click on "ZXCLFU02". If the message Include ZXCLFU02 does not exist is displayed, the enhancement has not been implemented yet and has to be created. 3. Implement the enhancement. To do so, use transaction CMOD to create a new project, for example, "Z_ECTR". 4. Assign enhancement CLFM0002 using Assign Enhancement. 5. Activate the components. 6. Double-click on exit EXIT_SAPLCLFM_002 and create the include. 7. Insert the source code in include ZXCLFU02. ********************************************************************* Installation 17
* for PLM / SAP Engineering Control Center ********************************************************************* CALL METHOD /dscsag/utils=>exit_saplclfm_002 EXPORTING t_allkssk = t_allkssk[] t_allausp = t_allausp[] t_delcl = t_delcl[] t_delob = t_delob[]. 3.4.3 ILOM0001 - Additional checks before saving a functional location (Optional) To display changes to a functional location automatically in SAP Engineering Control Center (Observer), you need to implement the enhancement ILOM0001. Note If this enhancement is not implemented, metadata displayed along with functional locations may be outdated. Procedure 1. Check whether the enhancement already exists in the SAP system: To do this, display function module EXIT_SAPMILO0_001 using transaction SE37. 2. Double-click " ZXLOMU01": If the message Include ZXLOMU01 does not exist appears, the enhancement is not yet implemented and needs to be created. 3. Implement the enhancement. To do this, use transaction CMOD to create a new project, such as "ECTR", and assign the enhancement ILOM0001 by selecting Enhancement Assignment. 4. Activate the components. 5. Double-click the exit EXIT_SAPMILO0_001 and create the include. If a warning is displayed, confirm the warning. 6. Insert the source code in the include ZXLOMU01. * Include ZXLOMU01 ********************************************************************* * for PLM / SAP Engineering Control Center ********************************************************************* DATA: ls_iflo LIKE iflo, ls_object TYPE /dscsag/ch_obj2. ls_iflo = data_iflo. IF ls_iflo-tplnr IS NOT INITIAL."safety-check CLEAR ls_object. ls_object-objecttable = /dscsag/cl_constants=>mc_dsc_floc. ls_object-objectkey = ls_iflo-tplnr. MOVE sy-uname TO ls_object-changed_by. 18 Installation
/dscsag/utils=>timestamp( IMPORTING changed_at = ls_object-changed_at ). CALL FUNCTION '/DSCSAG/UPD_OBJECT2' EXPORTING object = ls_object commit = ' '. ENDIF. 3.5 Final Steps To ensure that no errors occur in SAP Engineering Control Center, carry out the following functions in the administrator menu: 1. Choose Administration in the menu bar. 2. Open the flyout SAP Engineering Control Center System Setup. 3. Carry out the following functions sequentially. For more information, see the application help. o Transfer SAP Engineering Control Center settings to the SAP system o Set ABAP switches o Select object data for SAP Engineering Control Center Installation 19
4 Update of Configuration-Specific Files Every time SAP Engineering Control Center is updated, new features are added to the configuration files such as DEFAULT.TXT. The new features can be found in the directory %PLM_INSTDIR%\TEMPLATE-CUSTOMIZE\. The easiest way to compare the files is to use a tool that compares text files. At a glance, you can see which new variables have been added, and if necessary, you can copy these variables directly to your production directory. 4.1 Update des Java-Connectors To import the latest version of the Java Connector, exchange the following files: %PLM_INSTDIR%\basis\sys\win\lib32\sapjco3.dll %PLM_INSTDIR%\basis\sys\win\lib32\sapjco3.pdb %PLM_INSTDIR%\basis\sys\win\lib64\sapjco3.pdb %PLM_INSTDIR%\basis\sys\win\lib64\sapjco3.dll %PLM_INSTDIR%\basis\classes\sapjco3.jar 20 Update of Configuration-Specific Files
WWW.SAP.COM/CONTACTSAP COPYRIGHT 2014 SAP SE OR AN SAP AFFILIATE COMPANY. ALL RIGHTS RESERVED. NO PART OF THIS PUBLICATION MAY BE REPRODUCED OR TRANSMITTED IN ANY FORM OR FOR ANY PURPOSE WITHOUT THE EXPRESS PERMISSION OF SAP SE OR AN SAP AFFILIATE COMPANY. SAP AND OTHER SAP PRODUCTS AND SERVICES MENTIONED HEREIN AS WELL AS THEIR RESPECTIVE LOGOS ARE TRADEMARKS OR REGISTERED TRADEMARKS OF SAP SE (OR AN SAP AFFILIATE COMPANY) IN GERMANY AND OTHER COUNTRIES. ALL OTHER PRODUCT AND SERVICE NAMES MENTIONED ARE THE TRADEMARKS OF THEIR RESPECTIVE COMPANIES. PLEASE SEE HTTP://WWW.SAP.COM/CORPORATE- EN/LEGAL/COPYRIGHT/INDEX.EPX#TRADEMARK FOR ADDITIONAL TRADEMARK INFORMATION AND NOTICES.