SAP Engineering Control Center

(1)

Installation Guide

Document Version: 9.0 – 2016-04-01

CUSTOMER

SAP Engineering Control Center

(2)

Customer 2

SAP Engineering Control Center Typographical Conventions

Typographical Conventions

Format Description

Example 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 Highlighted words or expressions

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

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

Example Exact user input. This includes words or characters, which you enter in exactly the way they are specified in the documentation.

<Example> Variable user input. Pointy brackets indicate that you replace these words and characters for entries in the system with corresponding entries.

E X A M P L E Buttons on the keyboard, e.g. F 2 or E N T E R.

(3)

SAP Engineering Control Center Document History

Customer 3

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 11-1-2014 Initial creation

2.0 2015-02-01 "Final Steps" section added

3.0 2015-04-01 "Update of Configuration-Specific Files" section added 4.0 2015-05-01 Information added to "System Requirements" section

5.0 2015-06-01 "SAP Installation Server" subsection added to "Setting up the SAP System"

section

6.0 2015-09-01 Information added to "Authorization"

7.0 2015-10-15 Section "SAP Installation Server" revised

8.0 2016-02-10 Information added to "System Requirements" section 9.0 2016-04-01 Information added to "System Requirements" section

(4)

Customer 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

(6)

Customer 6

SAP Engineering Control Center Introduction

1.2.2 Information on SAP Service Marketplace

Documentation

Title Internet Address

Master Guide http://service.sap.com/instguides Configuration Guide http://service.sap.com/instguides Operations Guide http://service.sap.com/instguides

General Links

Title Internet Address

SAP Notes http://service.sap.com/notes

Installation Guides http://service.sap.com/instguides Security Guide http://service.sap.com/security

SAP Help Portal http://help.sap.com

OSS Messages 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 Description

<SAPSID> SAP system ID in uppercase letters

<sapsid> SAP system ID in lowercase letters

<DBSID> Database system ID in uppercase letters

<dbsid> Database system ID in lowercase letters

<INSTDIR> Installation directory

<MEDIA-DIR> Media directory

<OS> Operating system

(7)

SAP Engineering Control Center Preparation

Customer 7

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 o Windows 8 o Windows 10

 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 7.30 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 to be installed.

2.2 Users for Installation and Configuration

The following users are required for successful installation:

Operating System

A user with administrator rights or via the SAP Installer

SAP System

A user with authorization for the following authorization objects

(8)

Customer 8

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 CC change number authorization group

C_AENR_ERW CC change service enhanced authorization check C_KLAH_BKP Authorization class maintenance

C_DRAD_OBJ Object links

Create/Change/Display/Delete C_DRAW_BGR Authorization for authorization groups C_DRAW_DOK Authorization for document access C_DRAW_STA Authorization document status C_DRAW_TCD Authorization activities for documents C_DRAW_TCS Status-specific authorizations for documents C_DRZA_TCD

C_DRZI_TCD

C_STUE_BER CS Bill of Material authorizations

C_STUE_WRK CS Bill of Material plant (plant assignments) C_TCLA_BKA Authorization class types

M_MATE_MAN Material: central data M_MATE_MAR

M_MATE_STA Material: maintenance status M_MATE_WRK

M_MATE_WGR Material: goods group

Please take the authorization objects from the following SAP Notes into consideration:

Note Description

555812 - CDESK CAD desktop: required authorization

(9)

Customer 9

Use template role /DSCSAG/ECTR_BASE.

A user with a development key (for BAdIs) and the authorization for these transactions (in addition to the above authorization objects)

Authorization Description

SE03 Transport utilities

SE09 Manage orders

SE11 Display SAP DDIC

SE16n Display table content

SE18 BAdI definition

SE19 BAdI implementation

SE30 Performance analysis

SE37 Execute function modules

SE38 Execute reports

SE80 Start ABAP Workbench

SE91 Display messages

SE93 Display transactions

SPRO Customizing

SU01 Display user(s)

OAC0 - KPRO Maintain content repositories OACT - KPRO Maintain storage categories

CSADMIN Monitor KPro

ST22 Display runtime error

STMS Transport overview

SLG1 Application log

SM12 Lock overview

SM21 System log

SM59 RFC connection configuration

(activate trace)

ST01 System trace

ST05 SQL trace

Rolle /DSCSAG/ECTR_ADMIN

(10)

Customer 10

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. 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 on client machines in any number, the installation is central.

Further information is available on the SAP Service Marketplace at: http://service.sap.com/sltoolset

(11)

SAP Engineering Control Center Installation

Customer 11

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.0.exe with administrator rights.

2. In the following dialog, choose the components to be installed.

3. Follow the instructions in SAP Front-End Installer.

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 Description

%PLM_INSTDIR%

 

%PLM_INSTDIR% is the installation directory. In the Windows environment this is normally C:\Program Files (x86)\SAP\ECTR

_ addons\

     

This directory contains additional functions that enhance the scope of SAP Engineering Control Center. This can be, for example, an integrated viewer.

_ basis\

     

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

  _ \patch_V5.X.X  

 

In this directory, errors are corrected and enhancements are made to the files in the jar archives. The respective updates can be downloaded from

(12)

Customer 12

   

https://service.sap.com/.

 _ config\

           

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.

 _ dictionary\

     _ de   _ en

This directory contains the default dictionary file. The file can be available in several languages.

 _ scripts\...

 

Contains the source texts of the start files.

  sys\win\

 

Contains various folders with system components.

  bin\...

 

This directory contains various start files that are required for execution.

  icons  

       

This directory contains various symbols.

SAP Engineering Control Center works with different applications. A symbol can be assigned to an application and represent it.

  jre32\...

  jre64\...

   

This directory contains the Java runtime environment, which is required for execution. SAP Engineering Control Center uses version 1.8.0.

  lib32   lib64

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.

 _ classes\...

 

Customer-specific classes are stored here. In these classes, SAP Engineering Control Center can be adjusted

(13)

Customer 13

  to the requirements of the respective customer.

 _ config  

     

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

This directory is intended for customer-specifically adapted dictionary files.

 _ exec\win\

  

  _ addutils

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

This directory contains documentation such as the User Guide.

_ templates This directory contains the template files for the different document types.

3.3 BAdI Implementations for SAP Engineering Control Center

Some Business Add-Ins (BAdIs) must be implemented so that the SAP Engineering Control Center works. Note the following:

 Implement the BAdIs in the customer namespace and assign these BAdIs to an existing package.

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

(14)

Customer 14

3.3.1 BAdI DOCUMENT_MAIN01

Method BEFORE_SAVE

This method is used for validations, checks and additions of document data prior to saving the DMS document.

Method doc_before_save fills table /DSCSAG/DOC_RED and SAVE_COUNTER adapts the

SAP Engineering Control Center to the new requirements. In SAP Engineering Control Center you can use SAVE COUNTER to check for the current status in the session directory, which is saved locally in the client.

When documents are created from the SAP GUI, no colon (":") is set in draw-res4. This has the effect that the BAdI implementation is not called. If you want to call up the BAdI implementation for certain document types, you must set the preference variable /dscsag/preferences => cv_prefn_badi_doctype_addit

(SAP.PLM.BADI.ADDITIONAL.DOCTYPES) in table /DSCAG/PREF. To be informed of the latest version, you must fill table DSCSAG/DOC_VERS.

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:

(15)

Customer 15

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

This method is used to update SAP Engineering Control Center when changes are made to documents.

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.

(16)

Customer 16

3.3.2 BAdI BOM_UPDATE

Method CHANGE_BEFORE_UPDATE

This method is used to add, change and edit Bill of Material fields prior to the update in SAP tables. It checks the master model and wave link relations and sets the indicator in the menu tree of the SAP Engineering Control Center.

METHOD if_ex_bom_update~change_before_update.

*********************************************************************

* for SAP Engineering Control Center

*********************************************************************

CALL METHOD /dscsag/badi_utils=>bom_change_before_update EXPORTING

delta_stzub = delta_stzub delta_clrkb = delta_clrkb delta_clstb = delta_clstb delta_dostb = delta_dostb delta_eqstb = delta_eqstb delta_kdstb = delta_kdstb delta_mastb = delta_mastb delta_prstb = delta_prstb delta_stasb = delta_stasb delta_stkob = delta_stkob delta_stpnb = delta_stpnb delta_stpob = delta_stpob delta_stpub = delta_stpub delta_ststb = delta_ststb delta_tpstb = delta_tpstb.

ENDMETHOD.

(17)

Customer 17

3.3.3 BAdI ECM_UPDATE

Method CHANGE_BEFORE_UPDATE

This method is used to update SAP Engineering Control Center when changes are made to change management objects.

METHOD if_ex_ecm_update~change_before_update . ***************************************************

* Trigger Observer Table

***************************************************

CALL METHOD /dscsag/utils=>ecm_change_before_update EXPORTING

delta_aenrb = delta_aenrb.

ENDMETHOD.

3.4 Configuring Enhancements (User Exits)

MGA00001 Material Master (Industry): Check and set up

To automatically display the change of a material in SAP Engineering Control Center (Observer), enhancement MGA00001 must be implemented.

Procedure

1. Check whether the enhancement already exists in the SAP system: Display EXIT_SAPLMGMU_001 using transaction SE37.

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.

* Trigger ECTR observer

CALL METHOD /dscsag/utils=>exit_saplmgmu_001 EXPORTING

wmara = wmara stext = stext[]

(18)

Customer 18

EXCEPTIONS

application_error = 0 OTHERS = 0.

CLFM0002 Call classification data before saving

To automatically display the change of a class (for example, in CL24n, CL20n) in

SAP Engineering Control Center (Observer), enhancement CLFM0002 must be implemented.

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.

* Trigger ECTR observer

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

(19)

SAP Engineering Control Center Update of Configuration-Specific Files

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

(20)

www.sap.com/contactsap

Copyright

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.