Installation Guide - SAP ECTR for SAP S/4HANA 1.1

16
CUSTOMER Installation Guide SAP ECTR for SAP S/4HANA 1.1

Transcript of Installation Guide - SAP ECTR for SAP S/4HANA 1.1

CUSTOMER

Installation Guide SAP ECTR for SAP S/4HANA 1.1

2

DOCUMENT HISTORY

Note

Before you start the implementation, make sure you have the latest version of this document.

This guide is valid as of SAP ECTR for SAP S/4HANA S/4HANA 1.1.5.1

The latest version is available on SAP Service Marketplace at

https://help.sap.com/viewer/p/SAP_ENGINEERING_CONTROL_CENTER

Version Date Change

1.0 2019-05-29 Initial creation

2.0 2019-07-26 New section added "CLFM0002 Call classification data before saving (Optional)"

3.0 2019-11-21 "System Requirements" section optimized

4.0 2020-07-02 “Final Steps” section optimized

“System Requirements” section optimized

5.0 2021-04-29 "System Requirements" section optimized

6.0 2021-10-21 "System Requirements" section optimized

3

TABLE OF CONTENTS

1 INTRODUCTION ..................................................................................................................................... 4

1.1 ABOUT THIS DOCUMENT ..................................................................................................................... 4

1.2 BEFORE YOU START ............................................................................................................................ 4 1.2.1 SAP NOTES FOR THE INSTALLATION ................................................................................................ 4 1.2.2 INFORMATION ON SAP SERVICE MARKETPLACE ............................................................................ 5 1.2.3 NAMING CONVENTIONS ...................................................................................................................... 5

2 PREPARATION ...................................................................................................................................... 7

2.1 SYSTEM REQUIREMENTS .................................................................................................................... 7 2.1.1 FRONT END ........................................................................................................................................... 7

2.1.1.1 Hardware ....................................................................................................................... 7

2.1.1.2 Software ......................................................................................................................... 7 2.1.2 BACK END .............................................................................................................................................. 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 FRONTEND INSTALLER .............................................................................................................. 11

3.2 INSTALLATION ENVIRONMENT ......................................................................................................... 11

3.3 CONFIGURING ENHANCEMENTS (USER EXITS) ............................................................................. 13 3.3.1 CLFM0002 CALL CLASSIFICATION DATA BEFORE SAVING (OPTIONAL) ...................................... 13

3.4 FINAL STEPS ........................................................................................................................................ 14

4 UPDATE OF CONFIGURATION-SPECIFIC FILES ............................................................................. 15

4.1 UPDATE OF THE JAVA CONNECTOR ............................................................................................... 15

4

1 INTRODUCTION

SAP ECTR for SAP S/4HANA 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 ECTR for SAP S/4HANA.

Integration

A working SAP system is the prerequisite for installing SAP ECTR for SAP S/4HANA.

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:

https://support.sap.com/en/my-support/knowledge-base.html

SAP Note Title

2325172 Release strategy for ABAP add-on ECTR

5

1.2.2 Information on SAP Service Marketplace

Documentation

Title Internet Address

Master Guide Configuration Guide Operations Guide Application Help

https://help.sap.com/viewer/p/SAP_ENGINEERING_CONTROL_CENTER

General Links

Title Definition

SAP Notes https://support.sap.com/en/my-support/knowledge-base.html

Installation Guides https://help.sap.com/viewer/p/SAP_ENGINEERING_CONTROL_CENTER

Security Guide https://www.sap.com/corporate/en/company/security.html

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

OSS Messages Creation in component PLM-ECC

What's new in SAP ECTR 5.2 and SAP ECTR for SAP S4HANA 1.1 https://wiki.scn.sap.com/wiki/x/rwgeGg

This link is also available in the help menu in SAP ECTR for SAP S/4HANA.

1.2.3 Naming Conventions

This documentation uses the following naming conventions:

Variables

Add entries for your component or remove entries as required.

Variable 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

6

Variable Description

<INSTDIR> Installation directory

<MEDIA-DIR> Media directory

<OS> Operating system

7

2 PREPARATION

2.1 System Requirements

2.1.1 Front end

2.1.1.1 Hardware

Here you can find the basic requirements for installing SAP ECTR for SAP S/4HANA on a PC. If your device does not meet these requirements, the use of SAP ECTR for SAP S/4HANA may be limited.

Processor: 2.0 GHz or faster

RAM: 8 GB (gigabytes) or more

Hard disk space: 300 GB or more free memory

Note

The hardware requirements apply exclusively to working with SAP ECTR for SAP S/4HANA. If you

use an integration, you will also need to observe the system requirements of the manufacturer of the

integrated system.

2.1.1.2 Software

Windows 10 (64-bit)

.NET Framework 4.6.2

Visual C++ 2013 and Visual C++ Redistributable Package

SAP GUI, Version 760 or higher

For SAP 3D Visual Enterprise Viewer to be integrated successfully, the following requirements must be fulfilled:

SAP 3D Visual Enterprise Viewer, Version 9.0.600 or higher

Note that to successfully install the add-on for SAP 3D Visual Enterprise Viewer, the viewer must be installed before SAP ECTR for SAP S/4HANA. Otherwise, the option required to install the add-on will not be displayed in the SAP Frontend Installer.

Microsoft Office

2013

2016

2019

2.1.2 Back end

SAP ECC 6.0 or higher with the component level described in SAP Note 2049249 for SAP ECTR for SAP S/4HANA 520.

SAP Document Management and SAP Content Server

2.2 Users for Installation and Configuration

The following users are required for successful installation:

8

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

9

Authorization Description

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

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

10

Authorization Description

STMS Transport overview

SLG1 Application log

SM12 Lock overview

SM21 System log

SM59 RFC connection configuration (activate trace)

ST01 System trace

ST05 SQL trace

2.3 Setting up the SAP System

2.3.1 KPro

SAP ECTR for SAP S/4HANA 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:

https://help.sap.com/

11

3 INSTALLATION

3.1 SAP Frontend Installer

You can install SAP ECTR for SAP S/4HANA in your system landscape via the SAP Frontend Installer.

Execute the SAP ECTR Installer with administrator rights.

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

Follow the instructions in SAP Frontend 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 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 ECTR for SAP S/4HANA. 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.

12

Directory Structure Description

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

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 ECTR for SAP S/4HANA works with different applications. A symbol can be assigned to an application and represent it.

jre64\...

This directory contains the Java runtime environment, which is required for execution. SAP ECTR for SAP S/4HANA uses version 1.8.0.

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 ECTR for SAP S/4HANA. 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 ECTR for SAP S/4HANA can be adjusted 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\

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

13

Directory Structure Description

_ de

_ en

_ 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 Application Help.

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

3.3 Configuring Enhancements (User Exits)

3.3.1 CLFM0002 Call classification data before saving (Optional)

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

S/4HANA (Observer), enhancement CLFM0002 must be implemented.

Note

If this enhancement is not implemented, metadata displayed along with classes may be outdated.

Procedure

Check whether the enhancement already exists in the SAP system. To do this, display function module

EXIT_SAPLCLFM_002 using transaction SE37.

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.

Implement the enhancement. To do so, use transaction CMOD to create a new project, for example,

"Z_ECTR".

Assign enhancement CLFM0002 using Assign Enhancement.

Activate the components.

Double-click on exit EXIT_SAPLCLFM_002 and create the include.

Insert the source code in include ZXCLFU02.

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

* for PLM / SAP Engineering Control Center

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

14

CALL METHOD /dscsag/utils=>exit_saplclfm_002

EXPORTING

i_called = i_called

t_allkssk = t_allkssk[]

t_allausp = t_allausp[]

t_delcl = t_delcl[]

t_delob = t_delob[].

3.4 Final Steps

To ensure that no errors occur in SAP ECTR for SAP S/4HANA, carry out the following functions in the administrator menu:

Choose Administration in the menu bar.

Open the flyout SAP ECTR for SAP S/4HANA System Setup.

Carry out the following functions sequentially. For more information, see the application help.

Transfer SAP ECTR for SAP S/4HANA settings to the SAP system

Set ABAP switches

Select object data for SAP ECTR for SAP S/4HANA

Scheduling Report /DSCSAG/OBSERVER_CLEAR

15

4 UPDATE OF CONFIGURATION-SPECIFIC FILES

Every time SAP ECTR for SAP S/4HANA 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 of the Java Connector

To import the latest version of the Java Connector, exchange the following files:

%PLM_INSTDIR%\basis\sys\win\lib64\sapjco3.pdb

%PLM_INSTDIR%\basis\sys\win\lib64\sapjco3.dll

%PLM_INSTDIR%\basis\libraries\sapjco3.jar

www.sap.com/contactsap

© 2020 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. The information contained herein may be changed without prior notice. Some software products marketed by SAP SE and its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided by SAP SE or an SAP affiliate company for informational purposes only, without representation or warranty of any kind, and SAP or its affiliated companies shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP or SAP affiliate company products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. In particular, SAP SE or its affiliated companies have no obligation to pursue any course of business outlined in this document or any related presentation, or to develop or release any functionality mentioned therein. This document, or any related presentation, and SAP SE’s or its affiliated companies’ strategy and possible future developments, products, and/or platform directions and functionality are all subject to change and may be changed by SAP SE or its affiliated companies at any time for any reason without notice. The information in this document is not a commitment, promise, or legal obligation to deliver any material, code, or functionality. All forward-looking statements are subject to various risks and uncertainties that could cause actual results to differ materially from expectations. Readers are cautioned not to place undue reliance on these forward-looking statements, and they should not be relied upon in making purchasing decisions. 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. See www.sap.com/copyright for additional trademark information and notices.