Visual Structure Manager Administration Guide - SAP Help ...

30
User Guide SAP 3D Visual Enterprise structure manager 1.0 SP05 Document Version: 1.3.0 – 2016-08-01 PUBLIC Visual Structure Manager Administration Guide SAP 3D Visual Enterprise

Transcript of Visual Structure Manager Administration Guide - SAP Help ...

User Guide

SAP 3D Visual Enterprise structure manager 1.0 SP05 Document Version: 1.3.0 – 2016-08-01

PUBLIC

Visual Structure Manager Administration Guide SAP 3D Visual Enterprise

2

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Typographic Conventions

Typographic Conventions

Type Style Description

Example Words or characters quoted from the screen. These include field names, screen titles,

pushbuttons labels, menu names, menu paths, and menu options.

Textual cross-references to other documents.

Example Emphasized words or expressions.

EXAMPLE Technical names of system objects. These include report names, program names,

transaction codes, table names, and key concepts of a programming language when they

are surrounded by body text, for example, SELECT and INCLUDE.

Example Output on the screen. This includes file and directory names and their paths, messages,

names of variables and parameters, source text, and names of installation, upgrade and

database tools.

Example Exact user entry. These are words or characters that you enter in the system exactly as

they appear in the documentation.

<Example> Variable user entry. Angle brackets indicate that you replace these words and characters

with appropriate entries to make entries in the system.

EXAMPLE Keys on the keyboard, for example, F2 or ENTER .

Visual Structure Manager Administration Guide

Document History

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 3

Document History

Note

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

find the latest version at the following location: http://service.sap.com/instguides.

The following table provides an overview of the most important document changes:

Version Date Change

1.00 August 2014 First version

1.1.0 December 2014 Updates made to section 2 including applicable notes

1.2.0 April 2015 Updates made to section 2 including applicable notes

1.3.0 July 2016 Updates for VSM 1.0 SP05

4

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Table of Contents

Table of Contents

1 Getting Started .............................................................................................................................. 5 1.1 About this Document ............................................................................................................................ 5 1.2 SAP Notes for the Installation .............................................................................................................. 6 1.3 Information Available in SAP Service Marketplace ............................................................................ 7

2 SAP 3D Visual Enterprise structure manager ........................................................................... 9 2.1 System Landscape ................................................................................................................................ 9 2.2 Software Units ....................................................................................................................................... 9 2.3 Processes .............................................................................................................................................. 11

3 Installation Information ............................................................................................................. 12 3.1 Installing the Software ......................................................................................................................... 12 3.2 SAP GUI Installation Server Installation ............................................................................................. 13

4 Operation Information ................................................................................................................ 15 4.1 Configuration of SAP 3D Visual Enterprise structure manager ....................................................... 15 4.2 Monitoring of SAP 3D Visual Enterprise structure manager ............................................................16

4.2.1 Trace Files .............................................................................................................................16 4.2.2 Diagnostic Archives ............................................................................................................. 17

4.3 VSM Tool ............................................................................................................................................... 17

5 Security Information ................................................................................................................... 18 5.1 Temporary Files ....................................................................................................................................18 5.2 Trace Files .............................................................................................................................................18 5.3 URL Redirect Protection ......................................................................................................................18

5.3.1 URL Redirect Protection Configuration .............................................................................18 5.3.2 URL Redirect Protection Whitelist ......................................................................................19 5.3.3 MaxDownloadRedirectionCount.........................................................................................19 5.3.4 URL Redirect Protection Whitelist Entry Wildcards ......................................................... 20 5.3.5 Default Ports ........................................................................................................................ 20 5.3.6 Whitelist Entry Examples ................................................................................................... 20 5.3.7 XML Configuration ............................................................................................................... 21

6 Technical System Landscape .................................................................................................... 23 6.1 Supported Operating Systems........................................................................................................... 23 6.2 Hardware Configuration...................................................................................................................... 23

7 Upgrade Information...................................................................................................................24 7.1 User Administration and Authentication ........................................................................................... 24

Visual Structure Manager Administration Guide

Getting Started

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 5

1 Getting Started

1.1 About this Document

This Administration Guide is the central source of information for the technical implementation of SAP 3D Visual

Enterprise structure manager. It provides cross-scenario implementation information.

You can use the Administrator’s Guide to get an overview of SAP 3D Visual Enterprise structure manager and its

software units from a technical perspective. The Administration Guide is a planning tool that helps you to design

your system landscape and it refers you to the detailed documentation that is required, mainly:

Installation guides for single software units

SAP Notes

Configuration documentation

SAP Library documentation

This Administration Guide is a single source of information for the documentation that is available to support the

installation and operation of SAP 3D Visual Enterprise structure manager. Therefore, this Guide contains all of the

following:

o Installation Information

This chapter gives you an overview of the installation components and the sequence in which they are

installed.

o Security Information

This chapter provides you with the information that you require to operate SAP 3D Visual Enterprise

structure manager securely.

Upgrade Information

This chapter provides you with the latest upgrade information.

Note

You can find the most current version of this document on SAP Service Marketplace at

http://service.sap.com/instguides

We strongly recommend that you use the document available there. The guide will be updated according

to updates of the software.

6

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Getting Started

1.2 SAP Notes for the Installation

You must read the following SAP Note before you start the installation. These SAP Notes contain the most recent

information on the installation, as well as corrections to the installation documentation.

Make sure that you have the up-to-date version of each SAP Note, which you can find in the SAP Service

Marketplace at the Internet address: service.sap.com/notes.

SAP Note Number Title Description

1787261 SAP 3D Visual Enterprise:

Corrections to Online Documents

Applicable changes to online

documents post release

Visual Structure Manager Administration Guide

Getting Started

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 7

1.3 Information Available in SAP Service Marketplace

You can find Information on the following areas in the SAP Service Marketplace.

Documentation

Description Internet Address Title

Application Help for SAP Visual

Manufacturing Planner

http://help.sap.com/ SAP Business

Suite – SAP ERP – SAP ERP Central

Component – Logistics –

Production Planning and Control

(PP) – Visual Manufacturing

Planner

Application Help for SAP Visual

Manufacturing Planner

Application Help for SAP Visual

Manufacturing Planner

http://help.sap.com/ SAP Business

Suite – SAP Product Lifecycle

Management – SAP PLM as Part of

SAP ERP Central Component –

Product Life Cycle Management

(PLM – Visual Manufacturing

Planner

Application Help for SAP Visual

Manufacturing Planner

SAP 3D Visual Enterprise Viewer http://service.sap.com//instguides

SAP Business Suite Applications –>

SAP 3D Visual Enterprise

SAP 3D Visual Enterprise Viewer

Administrator’s Guide

SAP 3D Visual Enterprise

Generator

http://service.sap.com//instguides

SAP Business Suite Applications –>

SAP 3D Visual Enterprise

Application Operations Guide for

SAP 3D Visual Enterprise

Generator

SAP 3D Visual Enterprise

Generator

http://service.sap.com//instguides

SAP Business Suite Applications –>

SAP 3D Visual Enterprise

Installation Guide for SAP 3D

Visual Enterprise Generator

SAP 3D Visual Enterprise

Generator

http://service.sap.com//instguides

SAP Business Suite Applications –>

SAP 3D Visual Enterprise

Security Guide for SAP 3D Visual

Enterprise Generator

General Quick Links

Description Internet Address Title

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

Released platforms http://service.sap.com/platforms -

System sizing http://service.sap.com/sizing Quick Sizer tool

Front-end installation http://service.sap.com/instguides Front End Installation

Security http://service.sap.com/security -

Information about creating error

messages

https://service.sap.com/messages -

8

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Getting Started

Description Internet Address Title

SAP Software Distribution Center

(software download and ordering

of software)

service.sap.com/swdc -

SAP Product Availability Matrix service.sap.com/PAM _

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 9

2 SAP 3D Visual Enterprise structure manager

SAP 3D Visual Enterprise structure manager provides an ActiveX control that may be embedded in SAP GUI or

HTML applications.

SAP 3D Visual Enterprise structure manager is used for manipulating hierarchies of 3D geometry created using

SAP 3D Visual Enterprise tools.

2.1 System Landscape

SAP 3D Visual Enterprise structure manager is a client side component that needs to be installed onto client

computers.

Applications built using SAP 3D Visual Enterprise structure manager may have a server side component. Refer to

the Administration Guide for each application for application specific instructions.

Applications communicate with SAP 3D Visual Enterprise structure manager via JSON messages passed over

COM interfaces exposed by the SAP 3D Visual Enterprise structure manager ActiveX control.

2.2 Refer to section URL Redirect Protection

SAP 3D Visual Enterprise structure manager uses the File Transfer Component to handle downloading of files.

The File Transfer Component has a security feature which prevents files from being downloaded from an unknown

and untrusted domain following an HTTP redirect.

This feature is referred to as URL Redirect Protection and it is enabled by default.

There are many valid situations in which HTTP redirects can occur so the File Transfer Component has whitelist

functionality that allows an administator to specify domains to which HTTP redirects are allowed. The URL

Redirect Protection feature can also be disabled altogether.

One common scenario where HTTP redirection occurs is when HTTP URLs are used, but the server enforces a

policy of only allowing HTTPS connections and redirects to a corresponding HTTPS URL.

2.2.1 URL Redirect Protection Configuration

The configuration for the URL Redirect Protection feature can come from registry keys that can be controlled by

Windows Group Policy or from a local XML file.

Configuration via Windows Group Policy takes precedence over configuration specified in the local XML file (if it

exists).

10

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

If a registry value called URLRedirectProtection exists in the

HKEY_CURRENT_USER\SOFTWARE\Policies\SAP\SAP 3D Visual Enterprise registry key, then URL

Redirect Protection settings are read from the group policy registry keys otherwise they are read from

%APPDATA%\SAP\SAP 3D Visual Enterprise\URLRedirection.xml.

SAP 3D Visual Enterprise Viewer also uses the File Transfer Component. SAP 3D Visual Enterprise Viewer

includes functionality in its user interface to allow the user to see the configuration that is in effect for the URL

Redirect Protection feature and modify it (when Group Policy is not being used).

SAP 3D Visual Enterprise Viewer also includes an Administrative Template file for configuring the URL Redirect

Protection feature via Group Policy. Refer to the Administration Guide for SAP 3D Visual Enterprise Viewer 9.0 for

more information.

2.2.2 URL Redirect Protection Whitelist

The URL Redirect Protection whitelist is used to determine whether the File Transfer Component will allow a

download from a URL supplied by a web server in an HTTP redirect response. The URL Redirect Protection

whitelist can contain zero, one or multiple entries.

A URL Redirect Protection whitelist entry is matched against the part of the URL returned by the web server in an

HTTP redirect that identifies the server, protocol and port (explicit or implied) to retrieve the resource from.

The HTTP redirect is allowed when any whitelist entry matches the server, protocol and port in the redirect URL.

An HTTP redirect is also allowed when:

The server, protocol and port (explicit or implied) of the redirect URL are all the same as the server, protocol

and port (explicit or implied) of the initial request

URL rediect protection is disabled

2.2.3 MaxDownloadRedirectionCount

There is a configurable maximum number of chained HTTP redirects allowed.

The number of allowed chained redirects is specified by the value of the MaxDownloadRedirectionCount

element in %APPDATA%\SAP\SAP 3D Visual Enterprise FileTransfer 1.0\Settings.xml.

When this upper limit is exceeded the File Transfer Component will not follow the HTTP redirect, regardless of

whether the URL Redirect Protection configuration would allow the HTTP redirect to occur.

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 11

2.2.4 URL Redirect Protection Whitelist Entry Wildcards

URL Redirect Protection whitelist entries can contain wildcards that can match any character or contiguous group

of characters in the redirect URL string returned by the web server.

Wildcards can appear at any point in the whitelist entry and can match any kind of character in the URL string.

Two types of wildcards are supported. They differ in the number of characters that they match.

Wildcard Character Meaning

* Match 0 or more characters

? Match 1 character

Groups of wildcards can be combined. For instance, ?* will match one or more characters.

2.2.5 Default Ports

You can specify a whitelist entry without an explicitly specified port.

This is equivalent to specifying the whitelist entry with the default port for the given protocol explicitly specified.

So:

http://www.mycompany.com is equivalent to http://www.mycompany.com:80

https://www.mycompany.com is equivalent to https://www.mycompany.com:443

In order to specify a match against any port, it is necessary to use the notation for an explicitly specified port with

a wildcard:

https://www.mycompany.com:*

2.2.6 Whitelist Entry Examples

The table below gives some whitelist entry examples:

Whitelist Entry Result

*://www.mycompany.com:8080 Allow redirects to www.mycompany.com on port

8080 using any protocol

*://www.mycompany.com:* Allow redirects to www.mycompany.com on any port

using any protocol

*://www.mycompany.com Allows redirects to www.mycompany.com using any

protocol on the default port for the given protocol.

This would match:

http://www.mycompany.com

http://www.mycompany.com:80

https://mycompany.com

12

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

Whitelist Entry Result

https://mycompany.com:443

https://*.mycompany.com:443 Allow redirects to any subdomain of

mycompany.com on HTTPS using port 443

*.mycompany.com:* Allow redirects on any protocol and any port to any

subdomain of mycompany.com

* Allows any redirect.

https://subdomain.mycompany.com:80?? Allows redirects to subdomain.mycompany.com on

HTTPS on ports 8000 to 8099

2.2.7 XML Configuration

The XML schema for the local XML configuration file (%APPDATA%\SAP\SAP 3D Visual

Enterprise\URLRedirection.xml) for URL Redirect Protection is below:

The URL Redirect Protection feature is enabled (URL redirects are prevented unless the target domain matches a

whitelist entry) when the value of the UrlProtection attribute defined in the WhitelistType is “true”.

The string value of each Domain element contains a whitelist entry.

Below are the contents of an example file in which URL redirect protection is enabled and two whitelist entry

patterns are defined for a hypothetical company with a public domain mycompany.com and an intranet domain

mycompany.corp.

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 13

Example

Technical System Landscape for supported operating systems and hardware.

Components

The SAP 3D Visual Enterprise structure manager installer includes:

Component Functional Description

32-bit Visual Enterprise structure manager ActiveX

control

Installed on both 32-bit and 64-bit operating systems

32-bit Visual Enterprise structure manager COM

server

Installed on 32-bit operating systems

64-bit Visual Enterprise structure manager COM

server

Installed on 64-bit operating systems.

32-bit File Transfer Component COM server Installed on 32-bit operating systems

64-bit File Transfer Component COM server Installed on 64-bit operating systems

2.3 Software Units

SAP 3D Visual Enterprise structure manager is supported in the following EHP versions and service packs:

EHP Version Service Pack

EHP 7 (617) SP06

EHP 6 (606) SP13

EHP 6H (616) SP08

Below are the service packs for which notes are valid and the service packs from which the corrections in the

notes are delivered.

Note

Number

Enhancement Pack Note Validity Support Pack Delivery

2059322 EHP 7 Not required SP 06

14

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

EHP 6 SP 13 SP 14

EHP 6H SP 08 SP 09

2066124 EHP 7 Not required SP 06

EHP 6 SP 13 SP 14

EHP 6H SP 08 SP 09

2099007 EHP 7 SP06 SP 07

EHP 6 SP 13 – SP14 SP 15

EHP 6H SP 08 SP 09

Visual Structure Manager Administration Guide

SAP 3D Visual Enterprise structure manager

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 15

2.4 Processes

The following graphic shows the SAP 3D Visual Enterprise structure manager components and communication

mechanisms:

VSM ActiveX Control

(hosted in saplogon.exe or iexplore.exe)

VSM COM Server

(VEStructureManager.exe)

IVsmEventsIVsm

File Transfer Component

COM Server

(SAP.VE.FileTransfer.exe)

IDownloadManager

Application

IVsmServerWrapper IVsmServerWrapperEvents

SAP 3D Visual Enterprise structure manager

Each COM server runs in its own process. The image names of the processes are shown in the above graphic.

The SAP 3D Visual Enterprise structure manager ActiveX control is hosted in another process, (which depends on

the application).

In the case of an SAP GUI application, SAP GUI hosts the SAP 3D Visual Enterprise structure manager ActiveX

control on the client machine and SAP GUI facilitates communication between the SAP 3D Visual Enterprise

structure manager ActiveX control and application code running on an ERP server system.

In the case of an HTML application, the application could be implemented in client side JavaScript.

16

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Installation Information

3 Installation Information

3.1 Installing the Software

Use

This section describes the process for installing SAP 3D Visual Enterprise structure manager.

SAP 3D Visual Enterprise structure manager is a front end component that must be installed on each client

machine that will be used with an application that uses SAP 3D Visual Enterprise structure manager.

Prerequisites

To install the SAP 3D Visual Enterprise structure manager on a client computer, the following must be

preinstalled:

.NET framework 4.6.1

Standalone Installation Procedure

1. Log onto the client computer as a user with administrative privileges.

2. Close all applications on the computer.

3. Navigate to, and double-click the SAPVEStructureManager-xxxx.exe file in Windows Explorer.

Note

'xxxx is the version number.

4. Choose Next when the installer starts. The Front-End Installer screen is displayed.

5. Select the SAP 3D Visual Enterprise structure manager 1.0 checkbox to install the application.

6. Choose Next to start the installation, and then Close when the installation is complete.

Standalone Uninstallation Procedure

7. Log onto the client computer as an user with Administrative privileges

8. Close all applications on the computer.

9. Do one of the following to launch the SAP Front End installer:

o Navigate to, and double-click the SAPVEStructureManager-xxxx.exe (where 'xxxx' is the version

number), file in Windows Explorer. When a screen that contains component checkboxes is shown, ensure

that the SAP 3D Visual Enterprise structure manager 1.0 checkbox is unchecked, then click Next to start

the uninstallation and Close when the uninstallation has completed, or:

Visual Structure Manager Administration Guide

Installation Information

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 17

o Open the Programs and Features (or Add and Remove Programs) control panel, locate the SAP 3D Visual

Enterprise structure manager 1.0 entry and double-click it. Click Next to start the uninstallation and Close

when the uninstallation has completed.

3.2 SAP GUI Installation Server Installation

Part of the SAP 3D Visual Enterprise structure manager installation process involves registration of the ActiveX

control and COM servers. As these registrations require administrative privileges, the user performing the

installation must have administrative privileges on the client machine when performing a standalone installation.

The SAP Front End installer technology allows for the use of an installation server. This can be used to perform

installations on client machines in the context of a Windows service that has Administrative privileges. If SAP 3D

Visual Enterprise structure manager is deployed to an SAP GUI Installation Server and client machines are

configured to use the SAP GUI Installation Server, end users without administrative privileges are able to install

SAP 3D Visual Enterprise structure manager on their client machines.

Refer to the following document for information regarding SAP GUI Installation Server deployment:

http://scn.sap.com/docs/DOC-43075.

Install Locations

The install locations on a 64 bit operating system are listed in the following table:

Component Location Description

Visual Enterprise structure manager ActiveX control %ProgramFiles%\SAP\SAP 3D Visual

Enterprise structure manager

Visual Enterprise structure manager COM server %ProgramFiles%\SAP\SAP 3D Visual

Enterprise structure manager

File Transfer Component COM server %ProgramFiles%\Common Files\SAP\SAP 3D

Visual Enterprise File Transfer 1.0

The install locations on a 32 bit operating system are listed in the following table:

Component Location Description

Visual Enterprise structure manager ActiveX control %ProgramFiles(x86)%\SAP\SAP 3D Visual

Enterprise structure manager

Visual Enterprise structure manager COM server %ProgramFiles(x86)%\SAP\SAP 3D Visual

Enterprise structure manager

File Transfer Component COM server %ProgramFiles(x86)%\Common Files\SAP\SAP

3D Visual Enterprise File Transfer 1.0

18

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Installation Information

HTML Applications

SAP 3D Visual Enterprise structure manager 1.0 has a 32-bit ActiveX control, and can only be used in 32-bit

processes. The SAP 3D Visual Enterprise structure manager COM server runs in a separate process from the

ActiveX control, so it is possible for SAP 3D Visual Enterprise structure manager to utilize a 64-bit address space

on a 64-bit operating system.

Refer to the following knowledgebase article regarding a scenario in which ActiveX controls may be loaded in a 64-

bit process in Internet Explorer 10:

http://support.microsoft.com/kb/2716529

The SAP 3D Visual Enterprise structure manager ActiveX control must be allowed to run in Internet Explorer for

HTML applications that use SAP 3D Visual Enterprise structure manager to be usable.

The following page relates to ActiveX security in Internet Explorer:

http://technet.microsoft.com/en-us/library/dd346862.aspx

The SAP 3D Visual Enterprise structure manager ActiveX control is signed and marked as safe for scripting.

Visual Structure Manager Administration Guide

Operation Information

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 19

4 Operation Information

Within the management of SAP Technology, monitoring is an essential task. A section has therefore been devoted

solely to this subject.

4.1 Configuration of SAP 3D Visual Enterprise structure manager

SAP 3D Visual Enterprise structure manager uses some registry based settings.

Because SAP 3D Visual Enterprise structure manager can be used by multiple applications, some of these

settings are stored on a per application basis.

Each application that uses SAP 3D Visual Enterprise structure manager specifies an application name that is used

to designate an area in which application specific settings are stored.

The base key for SAP 3D Visual Enterprise structure manager registry settings is:

[HKEY_CURRENT_USER\Software\SAP\SAP 3D Visual Enterprise structure manager 1.0]

MaxUndoRecords

SAP 3D Visual Enterprise structure manager creates snapshots of application state in order to implement

undo/redo functionality. When large trees or large numbers of metadata fields are used, the storage of these

snapshots can result in a large amount of memory usage.

It is possible to limit the number of undo snapshots that can be stored, or to disable undo functionality altogether,

by setting the MaxUndoRecords setting for a given application.

The MaxUndoRecords setting is a REG_DWORD value under the following registry key (where ApplicationName

should be substituted with the ApplicationName value specified by the application when it calls the SAP 3D

Visual Enterprise structure manager SetModelData method):

[HKEY_CURRENT_USER\Software\SAP\SAP 3D Visual Enterprise structure manager

1.0\ApplicationName]

If MaxUndoRecords is not specified, the default value is 10.

The MaxUndoRecords is set to a value less than or equal to zero, undo functionality is disabled.

Renderer

SAP 3D Visual Enterprise structure manager supports hardware accelerated rendering using either DirectX 9 or

OpenGL. Hardware accelerated rendering provides better performance than software rendering and should be

used where available. The DirectX 9 renderer is enabled by default. Some client machines may have hardware or

driver issues that mean that the DirectX 9 and/or OpenGL renderer cannot be used. If an error due to a hardware

20

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Operation Information

or driver error occurs when SAP 3D Visual Enterprise structure manager is attempting to instantiate the DirectX 9

renderer, the system will automatically fall back to using the software renderer.

The renderer that SAP 3D Visual Enterprise structure manager will use for graphics rendering can be controlled

using the Renderer setting.

The Renderer setting is a REG_SZ value under the following registry key:

[HKEY_CURRENT_USER\Software\SAP\SAP 3D Visual Enterprise structure manager

1.0\ApplicationName\DisplaySettings]

Note

ApplicationName should be substituted with the ApplicationName value specified by the application

when it calls the SAP 3D Visual Enterprise structure manager SetModelData method)

Renderer Setting Values

Renderer Value

software rendering Dimension X (Z Buffer)

DirectX 9 viewport_DX9

OpenGL viewport_OPENGL14

4.2 Monitoring of SAP 3D Visual Enterprise structure manager

Within the management of SAP Technology, monitoring is an essential task. A section has therefore been devoted

solely to this subject.

4.2.1 Trace Files

Trace files are essential tools for analyzing problems. Trace files contain details of errors that occur during a

working session. Trace files are required when reporting issues in applications built using SAP 3D Visual

Enterprise structure manager.

Important Trace files for component SAP 3D Visual Enterprise structure manager

Component Content File Path

SAP 3D Visual Enterprise

structure manager

Trace file *.trc.txt %APPDATA%\SAP\SAP

3D Visual

Enterprise

structure manager

1.0

When creating a customer support message relating to SAP 3D Visual Enterprise structure manager, always

provide the trace file that was produced when the issue occurred (or a diagnostic archive from the same session)

Visual Structure Manager Administration Guide

Operation Information

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 21

in addition to a description of the nature of the problem, steps to reproduce and any information that could be

useful to reproduce the issue such as screenshots or videos.

4.2.2 Diagnostic Archives

In many cases, a trace file on its own is not sufficient to reproduce an issue. Often it is necessary to have the

viewable files that were loaded in the original session to reproduce the issue.

A diagnostic archive contains the trace file, all the viewable files that were loaded in the session from which the

trace file was produced and some additional files extracted from the trace file.

It is possible to create a diagnostic archive from within an SAP 3D Visual Enterprise structure manager session, by

selecting Help and Support->Create Diagnostic Archive from an SAP 3D Visual Enterprise structure manager

context menu.

VSM Tool can also be used for creating a diagnostic archive from any trace file.

4.3 VSM Tool

SAP 3D Visual Enterprise structure manager includes a command line tool VsmTool.exe that can be used to

extract information from trace files for diagnostic purposes.

VSM Tool can be used for extracting method and event payloads from trace files and can be used to download

geometry files from URLs in trace files (provided the URLs have not expired and are valid).

VSM Tool can also be used for creating diagnostic archive files.

SAP support will provide information regarding the usage of this tool when it is needed to obtain information from

a customer environment to resolve a customer issue.

22

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Security Information

5 Security Information

5.1 Temporary Files

Temporary files may be written to the logged in user's %TEMP% directory.

Downloaded geometry files are deleted when a VSM session ends. If SAP 3D Visual Enterprise structure manager

crashes, it is possible that geometry files could remain in the user's %TEMP% directory.

5.2 Trace Files

Trace files are written to %APPDATA%\SAP\SAP 3D Visual Enterprise structure manager 1.0.

Trace files can contain URLs that allow access to geometry files.

The duration of validity of the URLs used for accessing geometry files should be taken into account as a data

security consideration.

5.3 URL Redirect Protection

SAP 3D Visual Enterprise structure manager uses the File Transfer Component to handle downloading of files.

The File Transfer Component has a security feature which prevents files from being downloaded from an unknown

and untrusted domain following an HTTP redirect.

This feature is referred to as URL Redirect Protection and it is enabled by default.

There are many valid situations in which HTTP redirects can occur so the File Transfer Component has whitelist

functionality that allows an administator to specify domains to which HTTP redirects are allowed. The URL

Redirect Protection feature can also be disabled altogether.

One common scenario where HTTP redirection occurs is when HTTP URLs are used, but the server enforces a

policy of only allowing HTTPS connections and redirects to a corresponding HTTPS URL.

5.3.1 URL Redirect Protection Configuration

The configuration for the URL Redirect Protection feature can come from registry keys that can be controlled by

Windows Group Policy or from a local XML file.

Configuration via Windows Group Policy takes precedence over configuration specified in the local XML file (if it

exists).

If a registry value called URLRedirectProtection exists in the

HKEY_CURRENT_USER\SOFTWARE\Policies\SAP\SAP 3D Visual Enterprise registry key, then URL

Visual Structure Manager Administration Guide

Security Information

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 23

Redirect Protection settings are read from the group policy registry keys otherwise they are read from

%APPDATA%\SAP\SAP 3D Visual Enterprise\URLRedirection.xml.

SAP 3D Visual Enterprise Viewer also uses the File Transfer Component. SAP 3D Visual Enterprise Viewer

includes functionality in its user interface to allow the user to see the configuration that is in effect for the URL

Redirect Protection feature and modify it (when Group Policy is not being used).

SAP 3D Visual Enterprise Viewer also includes an Administrative Template file for configuring the URL Redirect

Protection feature via Group Policy. Refer to the Administration Guide for SAP 3D Visual Enterprise Viewer 9.0 for

more information.

5.3.2 URL Redirect Protection Whitelist

The URL Redirect Protection whitelist is used to determine whether the File Transfer Component will allow a

download from a URL supplied by a web server in an HTTP redirect response. The URL Redirect Protection

whitelist can contain zero, one or multiple entries.

A URL Redirect Protection whitelist entry is matched against the part of the URL returned by the web server in an

HTTP redirect that identifies the server, protocol and port (explicit or implied) to retrieve the resource from.

The HTTP redirect is allowed when any whitelist entry matches the server, protocol and port in the redirect URL.

An HTTP redirect is also allowed when:

The server, protocol and port (explicit or implied) of the redirect URL are all the same as the server, protocol

and port (explicit or implied) of the initial request

URL rediect protection is disabled

5.3.3 MaxDownloadRedirectionCount

There is a configurable maximum number of chained HTTP redirects allowed.

The number of allowed chained redirects is specified by the value of the MaxDownloadRedirectionCount

element in %APPDATA%\SAP\SAP 3D Visual Enterprise FileTransfer 1.0\Settings.xml.

When this upper limit is exceeded the File Transfer Component will not follow the HTTP redirect, regardless of

whether the URL Redirect Protection configuration would allow the HTTP redirect to occur.

24

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Security Information

5.3.4 URL Redirect Protection Whitelist Entry Wildcards

URL Redirect Protection whitelist entries can contain wildcards that can match any character or contiguous group

of characters in the redirect URL string returned by the web server.

Wildcards can appear at any point in the whitelist entry and can match any kind of character in the URL string.

Two types of wildcards are supported. They differ in the number of characters that they match.

Wildcard Character Meaning

* Match 0 or more characters

? Match 1 character

Groups of wildcards can be combined. For instance, ?* will match one or more characters.

5.3.5 Default Ports

You can specify a whitelist entry without an explicitly specified port.

This is equivalent to specifying the whitelist entry with the default port for the given protocol explicitly specified.

So:

http://www.mycompany.com is equivalent to http://www.mycompany.com:80

https://www.mycompany.com is equivalent to https://www.mycompany.com:443

In order to specify a match against any port, it is necessary to use the notation for an explicitly specified port with

a wildcard:

https://www.mycompany.com:*

5.3.6 Whitelist Entry Examples

The table below gives some whitelist entry examples:

Whitelist Entry Result

*://www.mycompany.com:8080 Allow redirects to www.mycompany.com on port

8080 using any protocol

*://www.mycompany.com:* Allow redirects to www.mycompany.com on any port

using any protocol

*://www.mycompany.com Allows redirects to www.mycompany.com using any

protocol on the default port for the given protocol.

This would match:

http://www.mycompany.com

http://www.mycompany.com:80

https://mycompany.com

Visual Structure Manager Administration Guide

Security Information

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 25

Whitelist Entry Result

https://mycompany.com:443

https://*.mycompany.com:443 Allow redirects to any subdomain of

mycompany.com on HTTPS using port 443

*.mycompany.com:* Allow redirects on any protocol and any port to any

subdomain of mycompany.com

* Allows any redirect.

https://subdomain.mycompany.com:80?? Allows redirects to subdomain.mycompany.com on

HTTPS on ports 8000 to 8099

5.3.7 XML Configuration

The XML schema for the local XML configuration file (%APPDATA%\SAP\SAP 3D Visual

Enterprise\URLRedirection.xml) for URL Redirect Protection is below:

The URL Redirect Protection feature is enabled (URL redirects are prevented unless the target domain matches a

whitelist entry) when the value of the UrlProtection attribute defined in the WhitelistType is “true”.

The string value of each Domain element contains a whitelist entry.

Below are the contents of an example file in which URL redirect protection is enabled and two whitelist entry

patterns are defined for a hypothetical company with a public domain mycompany.com and an intranet domain

mycompany.corp.

26

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Security Information

Example

Visual Structure Manager Administration Guide

Technical System Landscape

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved. 27

6 Technical System Landscape

6.1 Supported Operating Systems

The SAP 3D Visual Enterprise structure manager can be installed on 32-bit (x86) and 64-bit (x64) Windows

desktop operating systems (ARM and Itanium platforms are not supported).

Installations on virtual machines are not supported.

SAP 3D Visual Enterprise structure manager can run on the following supported operating systems:

o Windows 7 SP1 (32 and 64-bit)

o Windows 8.1 (32 and 64-bit)

o Windows 10 (32 and 64-bit)

The recommended operating system is:

o Windows 10 (64-bit)

6.2 Hardware Configuration

The minimum configuration for SAP 3D Visual Enterprise structure manager is:

o Pentium 4 1Ghz processor or higher

o 512MB of RAM (more for large model and texture sizes)

o 3D hardware accelerator video card, capable of displaying 24-bit color and supporting Shader Model 3.0

o Internet Explorer 10 (when used in HTML applications)

o Microsoft DirectX 9.0c

The recommended configuration for SAP 3D Visual Enterprise structure manager is:

o Intel core i3 530 2.93 GHz or better

o 8GB or more of RAM

o 3D hardware accelerator video card with 512MB or more of RAM, supporting Shader Model 3.0

o 64-bit Operating System

o Internet Explorer 11 (when used in HTML applications)

o Microsoft DirectX 9.0c

28

PUBLIC

© 2016 SAP SE or an SAP affiliate company. All rights reserved.

Visual Structure Manager Administration Guide

Upgrade Information

7 Upgrade Information

In some cases, SAP 3D Visual Enterprise structure manager does not automatically upgrade or uninstall previous

versions.

In these cases, the installed version must be uninstalled manually before a new version is installed.

SAP 3D Visual Enterprise structure manager settings are retained after an uninstallation or upgrade.

7.1 User Administration and Authentication

User administration and authentication is not performed by SAP 3D Visual Enterprise structure manager and is

the responsibility of the application embedding SAP 3D Visual Enterprise structure manager.

www.sap.com/contactsap

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

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

www.sap.com/corporate-en/legal/copyright/index.epx for

additional trademark information and notices.

0