SAPERION ECM SAP Web Viewer & Fast Viewer - Kofax · 5.2 ZUL-based SAP Web Viewer ..... 3 5.3 JSP-based SAP Web Viewer ... these terms are internal system variables

SAPERION ECM SAP Web Viewer & Fast Viewer - Administration

Copyright © 2016 Lexmark. All rights reserved.

Lexmark is a trademark of Lexmark International, Inc., registered in the U.S. and/or other countries. All other trademarksare the property of their respective owners. No part of this publication may be reproduced, stored, or transmitted in anyform without the prior written permission of Lexmark.

Table of Contents

1 Introduction ......................................................................................................... 2

1.1 Fast Viewer ....................................................................................................... 2

2 Release Notes ...................................................................................................... 2

3 Prerequisites ....................................................................................................... 3

4 Important Notes .................................................................................................. 3

5 Installation ........................................................................................................... 3

5.1 Java Core Server .............................................................................................. 3

5.2 ZUL-based SAP Web Viewer ........................................................................... 3

5.3 JSP-based SAP Web Viewer ............................................................................ 4

5.4 Fast Viewer ....................................................................................................... 4

5.5 Update .............................................................................................................. 4

6 General Configuration ......................................................................................... 4

6.1 Technical User ................................................................................................. 5

6.2 SAP System ...................................................................................................... 5

6.2.1 General Availability .......................................................................................... 5

6.2.2 SAP Transports ................................................................................................ 5

6.2.3 Settings ............................................................................................................ 6

6.2.4 Configuration Fast Viewer ............................................................................... 7

6.2.5 Advanced Settings ........................................................................................... 8

6.3 SAP Web Viewer Applet .................................................................................. 8

6.4 Configuring Shortcuts ..................................................................................... 9

6.5 Memorizing the Position and Dimension of the Browser Window .............. 10

6.6 SAML (Security Assertion Markup Language) ............................................... 10

6.6.1 Configuration File "sapviewermail.zul" .......................................................... 10

6.6.2 Java Keystore "truststore.jks" ......................................................................... 11

6.6.3 "web.xml" ......................................................................................................... 11

7 Configuration of JSP-based Viewer (SP4) .......................................................... 12

7.1 Toolbar Functions ............................................................................................ 12

7.2 Mailing Function ............................................................................................. 12

7.3 Automatic Re-Logon ....................................................................................... 13

7.4 Activate Debug Window ................................................................................. 13

7.5 Configure the "Welcome Page" ...................................................................... 14

2

SAPERION ECM SAP Web Viewer & Fast Viewer -

Administration

1 Introduction

For SAP-based installations users may use the SAPERION SAP Web Viewer in order to access documents

that are archived in SAPERION. A login to SAPERION is not necessary. In the following all essential steps

for the installation and configuration is described.

Alternatively you can install the Fast Viewer for displaying SAP documents. This viewer is based on the

local Rich Client viewer.

1.1 Fast Viewer

The Fast Viewer represents an alternative viewer to the SAP Web Viewer and is characterized basically

by its independency from Java. For the Fast Viewer no Java plug-in is needed so that no compatibility

problems of the respective Java VM arise.

Natively, the Fast Viewer is able to view image files, PDF and text files. Further document formats (e.g.

Word) need a local installed application which is embedded in the viewer.

i This is only possible for applications that support the ActiveDocument protocol.

The display of PDF files is achieved by an embedded Acrobat Reader, hereby the Internet Explorer (as

wrapper) and Acrobat Reader must be loaded additionally. Furthermore, annotations cannot be modified

and applied, but SAP notes are possible.

2 Release Notes

Starting with SAPERION version 7.1. SP4 a new developed SAP Web version is available which is based

on JSP (JavaServer Pages) - hereinafter referred to as JSP-based SAP Web Viewer. While paying particular

attention to usability so that the user is not confronted with differences to the former version (which is

based on ZUL), some deviating configuration facilities have been arisen (described in chapter entitled

"Configuration").

i Due to compability reason the ZUL-based version is still delivered, but will not be effected

by changes of the new JSP-based version so that configuration is as before. In case of a new

installation of SAP Web Viewer you should use the JSP-based version.

3 Prerequisites 3

Unless we are not pointing out explicitly the procedure for installation and configuration of both versions

are identical.

3 Prerequisites

Following prerequisites have to be met using the SAPERION SAP Web Viewer:

+ SAPERION version 7.1 SP1

+ SAP ERP 6.0 and higher (former SAP versions only on demand)

+ Internet Explorer 8 and higher

4 Important Notes

Please keep in mind that SAP notes cannot be added to documents when your database defintion (DDC)

is containing the fields SAPCOMPONENTID and SAPCONTENTTYPE. The background to this is that

these terms are internal system variables.

5 Installation

The installation is based on the existing installation of the Java Core Server, the Web Client on an

application server and an existing SAP installation.

Please refer to the information according to the used SAP Web Viewer version:

+ ZUL-based or

+ JSP-based (from SP4 on).

i Please note that using firewall, the port 12208 between Core Server and R/ Link Server must be

open.

5.1 Java Core Server

The installation of Java Core Server is executed according to the description of the SAPERION installation

manual.

5.2 ZUL-based SAP Web Viewer

i Using Web Client and SAP Web Viewer, you have to execute the installation as additional web

application because SAP Web Viewer is needing an own access.

4

1. Copy the "scr-webclient.war" file from the "...\Program Files (x86)\SAPERION\scr\scr-webclient"

directory.

2. Rename this file, e.g., "scr-sapviewer.war", and then copy it into the "...\Program Files\Apache

Software Foundation\Tomcat <Version>\webapps" directory.

3. Restart the Application (Tomcat) Server. The "scr-sapviewer" directory containing files for the SAP

Web Viewer will be created automatically.

4. Copy the "sapviewer.zul" file from this directory and rename it to "index.zul" (the original index.zul"

file will be overwritten).

! HTTP Script in the SAP system must also be adapted accordingly (see next chapter "SAP

System").

5. In order to enable this also in the Internet Explorer add the URL of SAPERION SAP Web Viewer to

your "Trusted sites" otherwise the user will be asked for login data each time the viewer is called.

6. Furthermore, you have to make a configuration in the "web.xml" in order to enable a filter which is

reading out name and domain of the logged in user.

For this, remove the out-comments of the following section of "web.xml":



5.3 JSP-based SAP Web Viewer

The installation of SAP Web Viewer is carried out by means of the delivered "scr-webclient.war" file and

is equivalent to the installation of the Web Client. This file must be copied into the "webapps" directory

of the application server (Apache Tomcat) and then unpacked via a restart of the server.

5.4 Fast Viewer

The installation of the Fast Viewer is analogue to the installation of a SAPERION Rich Client: You have

to ensure that the correct license key is entered during the setup so that the Fast Viewer is available.

5.5 Update

Please always backup the "scr-sapviewer" folder in the "...Program Files (x86)\SAPERION\scr" directory

before doing a SAPERION update.

6 General Configuration

The configuration described in the following chapters are valid for both versions (ZUL-based and

JSP-based) of SAP Web Viewer.

6 General Configuration 5

6.1 Technical User

After the installation of the Java Core Server you have to make the settings for the technical user.

! The technical user must have been marked as "Technical user" in the SAPERION user

management before. Furthermore, he must have been equipped with sufficient rights for

displaying and editing documents.

Add the following lines in the ARCHIEF.INI:

[ApplicationServer]

techuser=<Name of the technical user>

techpass=<Password>

Technical user

Parameter Description

techuser Enter the technical user's name.

techpass Enter the password of the technical user.

i For a multi-client system use, add the Technical user in all systems.

6.2 SAP System

To allow the utilization of the SAP Web Viewers from the SAP system you have to execute the provided

transports. With this assignment the necessary ABAP code is transmitted to the SAP system.

General Availability

For the general availability of the SAP Web Viewer you have to maintain the exit for the display of

documents in the TOAEX table. Create the following entries:

TOAEX table

Entry Value

EXIT_ID OA_OBJECTDISPLAY_01

ACTIVE X

EXIT_FUB /SAAG/EXT_RLINK_MAIN_VIEW_O

SAP Transports

The provision of the SAP component is acquired by menas of the transport that is delivered on the

installation DVD.

6

You will find the ZIP-file "Transport SAP Web Viewer SAP ERP 600.zip" containing the transports with

appropriate title in the "...x86\components\SAPWebViewer" directory.

Settings

1. The transaction for the table customizing is "/saag/ext_cust". You have to indicate all content

repositories for which the SAP Web Viewer is used for.

2. Maintain also the Web Viewer logs for the above mentioned content repositories.

Following entries need to be stated (Fix values are marked by (*)):

Web Viewer Log

Entry Value

Protocol Name of the log

Document class By means of * in the "Document class" column the display of all document types is enab-

led for the SAPERION Web Client.

Exceptions can be configured. Enter the appropriate document class and use "ArchiveLink"

as viewing app.

Note: For the document type ALF (print lists) the viewing app "ArchiveLink" must be defi-

ned.

Viewing App WebView: Display via SAPERION SAP Web Viewer

ArchiveLink: normal ArchiveLink display

HTTP server HTTP server of the SAPERION Web Clients

Port Port


Entry Value

HTTP script ZUL-based version:

<sap-viewer-app>/sapviewer.zul (*)

If you have installed SAP Viewer in parallel to the Web Client as described above make the

following entry:

<sap-viewer-app>/index.zul (*)

Example

scr-sapviewer/index.zul

JSP-based version:

<sap-viewer-app>/sapviewer.jsp (*)

Description WebView (*)

This specification is case sensitive - please mind the correct spelling.

Test empty

! Log settings in the transactions OAA4 and OAA3 are not considered when selecting the SAP Web

Viewer.

Configuration Fast Viewer

1. The transaction for the table customizing is the "/saag/ext_cust" transaction. You have to specify

all content repositories for which the Fast Viewer is to be used.

2. Maintain also the corresponding Fast Viewer protocols of the specified content repository.

The following entires need to be defined (fixed values are marked by (*)):

Fast Viewer protocol

Term Value

Protocol Name of the protocol

8

Term Value

Document Class Entering * in the "Document class" column all document types are displayed in the Fast

Viewer.

Exceptions can be configured. For this purpose enter the required document type and use

"ArchiveLink" as viewing app.

NOTE: For the document type ALF (print lists) the viewing app "ArchiveLink" must always

be defined.

Viewing App FastViewer: Display via the SAPERION Fast Viewer

ArchiveLink: normal ArchiveLink-display

FastView DDC DDC in which documents are deposited

FastView Mode + "Edit Mode": documents are openede in "Edit" mode

+ "Viewing Mode": documents are opened in "Viewing" mode

FastView TechUser Name of the set up technical user

Test empty

! Protocol settings in transaction OAA4 and OAA3 are not considered when using the Fast Viewer.

Advanced Settings

Make the advanced settings in the table "/SAAG/EXT_CUST".

Fig. 6–1: "/SAAG/EXT_CUST" table

Maintain the following entries:

"/SAAG/EXT_CUST" table

CustProp Custvalue Cust_ADD_VALUE Description

LOCATIONNAME x <empty> Modification of the check whe-

ther a SAP Web Viewer is alrea-

dy opened. From LOCATIONURL

(default) to LOCATIONNAME

USESAPUSER x- <empty> SAP user name that is stated when

creating annotations

TESTMODE x- <empty> Explorer Tool- and status bar is dis-

played - only for testing

6.3 SAP Web Viewer Applet

You will find the "SAPViewerApplet.properties" file in the directory "...\Apache Software

Foundation\Tomcat 6.0\webapps\scr-webclient\WEB-INF\classes\config\virtualviewer". Here, you can

configure the user interface and the cache as required.


i This configuration is delivered containing the default values. If you need to modify parameters,

it is recommended to consult SAPERION previously. The following example contains parameters

which can be changed unassistedly by your own.

Example

# Specifies the number of bytes to save in the viewed pages cache.

maxCacheBytes=0

# help resources

helpURL=http://portal.saperion.com/docsxml/en/saperion-71-sp3/components/e-sap-webviewer_user.html

helpURL_german=http://portal.saperion.com/docsxml/de/saperion-71-sp3/components/d-sap-webviewer_user.html

Parameters for the Adaptation of SAP Viewer


maxCacheBytes Maximum cache size in bytes.

helpURL Define a link where the Web Client user is led to as soon as he clicks the menu entry

"Help".

6.4 Configuring Shortcuts

The SAP Web Viewer is delivered with activated shortcuts by default. With this the user can execute

quickly and conveniently tasks by means of two or more keys.

The appropriate section for configuration of shortcuts is as follows:

# shortcuts

shortcutZoomIn=CTRL +

shortcutZoomOut=CTRL -

shortcutFirstPage=HOME

shortcutLastPage=END

shortcutScrollUp=UP

shortcutScrollDown=DOWN

shortcutNextPage=RIGHT

shortcutPreviousPage=LEFT

shortcutGotoPageFocus=CTRL G

shortcutDefaultSize=CTRL D

shortcutSelectArea=CTRL K

shortcutPictureControls=CTRL P

The SAP Web Viewer supports the following common keyboard shortcuts:

Supported shortcuts

Function Key/ key combination

Zoom in Strg + + (numeric keypad)

10

Function Key/ key combination

Zoom out Strg + - (numeric keypad)

First page Home

Last page End

Scroll up PgUp

Scroll down PgDn

Next page #

Previous page #

Go to specific page Strg + G

Default size Strg + D

! The shortcuts "Strg + P" (print) and "Strg + S" (Save) are not supported in the SAP Web Viewer.

6.5 Memorizing the Position and Dimension of the Browser Window

By means of javascript you can write information into a cookie which have the effect that the SAP Web

Viewer memorizes the position and dimension of the browser window at a shutdown. Restarting the SAP

Web Viewer the information are read out of the cookies so that position and dimension can be rebuilt.

For this purpose the browser has to grant the right to execute javascript.

! This feature is only supported with the Internet Explorer because other browsers do not allow to

modify size and dimension of the main window.

6.6 SAML (Security Assertion Markup Language)

The SAP WEB Viewer supports from SP3 on the Security Assertion Markup Language (SAML) for a

secured transfer of document links out of the viewer.

The structuring of the link refers to the SAML system which calls up the SAP Web Viewer after

authentication is successfully carried out. Also the user name is given. If the user is registered at the

SAML system he will be forwarded directly, otherwise a registration is mandatory.

Configuration File "sapviewermail.zul"

To activate an authentication with SAML make the following settings in the configuration file

"sapviewermail.zul" which can be found in the "...\Program Files\Apache Software Foundation\Tomcat

<version>\webapps\scr-webclient"-directory.

Example

-<toolbarbutton image="mail/icon/429_e-mail_only_sent_24.png"

tooltiptext="Send URL"

onClick='mailer.mailDocument(main.getUrlMailingURL("Mail URL to send: ", "<SAML URL>", "30") + "||Sent from

SAPERION")'/>


SAML configuration


image Specify the image file displayed in the SAP Web Viewer for calling the "Send e-mail" functi-

on.

tooltiptext Enter a short concisely function description text.

onClick For <SAML URL > specify the den URL part according to your infrastructure.

Example

https://<entitlement server name>/GetAccess/Saml/Portal/Transfer?TARGET=

If no link is required then remove the complete part.

Java Keystore "truststore.jks"

Furthermore you have to create a keystore (Java keystore)

which must be copied into the "...\Program Files\Apache Software

Foundation\Tomcat<version>\webapps\scr-webclient\WEB-INF\classes\config" directory. Here, all

certificates of the SAML system is stored.

! This keystore file must be named "truststore.jks ".

Please use "saperion.com" as certificate alias with the password "opensaml".

"web.xml"

Now some parameters in the "web.xml" file have to be adapted according to your system configuration

in the following section:

Example

<filter>

<filter-name>SAMLFilter</filter-name>

<filter-class>com.saperion.ngc.filter.SAMLAuthFilter</filter-class>

<init-param>

<param-name>tenant</param-name>

<param-value>MyTenant</param-value>

</init-param>

<init-param>

<param-name>license</param-name>

<param-value>MyLicense</param-value>

</init-param>

<init-param>

<param-name>entitlementURL</param-name>

<param-value>https://<entitlement server name>/GetAccess/Saml/Portal/Transfer?TARGET=></param-value>

</init-param>

<init-param>

<param-name>applicationURL</param-name>

<param-value>/index.zul</param-value>

</init-param>

</filter>

12

<filter-mapping>

<filter-name>SAMLFilter</filter-name>

<url-pattern>/*</url-pattern>

</filter-mapping>

7 Configuration of JSP-based Viewer (SP4)

7.1 Toolbar Functions

For the JSP-based SAP Web Viewer (from 7.1 SP4 on) you are allowed to control

toolbar functions by means of the configuration file "SAPViewerFeatures.properties". The

file can be found in the directory "...\Program Files\Apache Software Foundation\Tomcat

<version>\webapps\scr-sapviewer\WEB-INF\classes\config\virtualviewer\clientserver".

Example

# Features that can be enabled or disabled

infoButton=true

mailAttachmentButton=false

mailLinkButton=false

download=true

clock=true

sessionKeepAlive=true

"SAPViewerFeatures.properties"


infoButton TRUE = The [Information] button in the toolbar is displayed.

mailAttachmentButton TRUE = The button for sending documents as mail attachment is displayed.

Default: FALSE

mailLinkButton TRUE = The button for sending documents as a link is displayed.

Default: FALSE

download TRUE = Documents respectively elements can be downloaded.

clock TRUE = The clock is displayed in the toolbar.

sessionKeepAlive TRUE = The SAP Web Viewer makes sure that the session is not invalid after longer periods

of inactivity by sending regularly queries to the server.

7.2 Mailing Function

For the mailing function the following parameters are available in the "web.xml":

Example



<context-param>

<param-name>TimeoutMailLink</param-name>

7 Configuration of JSP-based Viewer (SP4) 13

<param-value>30</param-value>

</context-param>

<context-param>

<param-name>PrefixMailLink</param-name>

<param-value>https://Entitlement server URL/GetAccess/Saml/Portal/Transfer?TARGET=</param-value>

</context-param>

<context-param>

<param-name>TargetPageMailLink</param-name>

<param-value>/sapviewer.jsp</param-value>

</context-param>

Mailing function in the "web.xml"


TimeoutMailLink Set the period of validity (in days) for the sent link via mail.

PrefixMailLink Set the prefix of the URL for the link to be sent. The prefix serves the identification of the

user via the entitlement server.

TargetPageMailLink Set the target page for the link to be sent.

7.3 Automatic Re-Logon

In order to prevent that the user receives error messages after a long period of inactivity (timeout of

Java Core Server) because he is logged off by the system, the SAP Web Viewer contains a filter which

is checking whether the Classic Connector in the session is still active before the accessing the used

servlets. If he is not active a new login of the technical user is executed automatically.

i Please note that this filter has exclusively impact to the technical user.

Example

<filter-mapping>

<filter-name>SapViewerLogonFilter</filter-name>

<servlet-name>streamingServlet</servlet-name>

<servlet-name>zipServlet</servlet-name>

<servlet-name>viewerControlServlet</servlet-name>

<servlet-name>sapViewerNotesServlet</servlet-name>

<url-pattern>/viewer/RequestServer</url-pattern>

<url-pattern>/viewer/ResponseServer</url-pattern>

</filter-mapping>

7.4 Activate Debug Window

The SAP Web Viewer provides a function for debugging on the clients. In order to activate the debug

window open the "sapviewer.js" file that is stored under "…/scr-webclient/sapviewer" and set the variable

"showLogWindow = true".

14

// set showLogWindow to true to enable the debug-messages-window

var showLogWindow = true;

var logWindow;

i A restart is not necessary after modification.

If this function has been activated the debug window containing log entries of client-side functions and

JavaScript errors opens when calling the SAP Web Viewer.

7.5 Configure the "Welcome Page"

You can define the file that is shown by default as soon as the user is calling the URL of the SAP Web

Viewer.

The parameter "Welcome-file-list" can be modified in the "web.xml":

Example



<welcome-file-list>

<welcome-file>sapviewer.jsp</welcome-file>

<welcome-file>index.html</welcome-file>

<welcome-file>index.htm</welcome-file>

<welcome-file>index.jsp</welcome-file>

<welcome-file>default.html</welcome-file>

<welcome-file>default.htm</welcome-file>

<welcome-file>default.jsp</welcome-file>

<welcome-file>index.zul</welcome-file>

</welcome-file-list>

In the above mentioned section you are allowed to define multiple files. The first found file will always

be displayed (the correct order is from top to bottom). If you no longer want the Web Client to be called

remove the entry "index.zul" from the list.