SAP Enable Now Manager – Installation

[former_member422441]

1. Introduction

The SAP Enable Now Manager serves as a central content management and collaboration platform, simplifying the teamwork of authors. Additionally, it is possible to publish content for specific target groups depending on roles and users as well as measuring the success of the training.

The Manager is a Server Application to be run on the Apache Tomcat Application Server with writing data to a database server and to a server sided file storage.

Due to these dependencies, the installation of the Manager needs third-party applications to be installed in advance.

 

1.1 Software Component details

 

 

 

 1.2 System requirements

 

Note: In our Installation, we are using below

• Operating System: Windows Server 2012 R2 Datacenter (Windows Azure)


• Processor: Intel ® Xeon® CPU E5-2673 v4 @ 2.30 GHz


• Memory: 16GB RAM


• Hard disk: 110GB free

 

 

1.3 Dependencies

 Note: In our Installation, we are using below

• Operating System: Windows Server 2012 R2 Datacenter (Windows Azure)


• Oracle® Java Runtime Environment(JRE): Version 8


• Microsoft Visual C++ Redistributable: Visual C++ Redistributable 2013, Version 12.0.30501


• Apache Tomcat: Version 8.5.11


• Microsoft SQL Server: SQL server 2014

Caution Note:

• Do not use Tomcat version 8.5.12, since it contains a bug preventing the Manager to work stable.


• Use 64bit version of dependencies only to avoid lack of functionality.

 

2. Preparation

2.1 Install Oracle® Java Runtime Environment 7 Update 11(minimum) or version 8 only.

• Necessary framework for the functionalities of the Apache Tomcat Server.

http://www.oracle.com/technetwork/java/javase/downloads/index.html

 

Prerequisites

Oracle® Java Runtime Environment

The Oracle® Java Runtime Environment (JRE) is essential for the functionality of the Tomcat Application Server. Consider matching the system requirements.

You can check as follows, whether Java Runtime Environment (JRE) has been installed on your operating system before and, if so, in which version it has been installed

Version verification via Control Panel

• Go to Start - > Settings - > Control Panel


• Choose Programs and Features.


• Search in the list of installed programs for the entry Java x Update x.

If there is no such entry or an entry showing an older version, you have to install it.

 

Version verification via command line

• Press keys Windows + R


• Type cmd into the Run dialog and press Enter


• Type java -version into command line and press Enter

 

 

2.2 Installation of the Tomcat Application Server

The Apache Tomcat Application Server provides a server environment which enables Web applications to be run by Java code using the server sided Java Runtime Environment. The Manager uses Java technology for database management and application functionality.

 

Download the Tomcat Installer file

1. Visit Apache Tomcat download site.

Direct Link for Tomcat 8.5.11: https://archive.apache.org/dist/tomcat/tomcat-8/v8.5.11/bin/

 

2. Select the apache-tomcat-8.5.11.exe

 

 

 

Installation Procedure

1. Start the installation of the Tomcat server by a double-click on the file apache-tomcat-8.0.xx.exe.

 

2. Read Welcome message and click Next to continue.


3. Accept the license agreement dialog by a click on the button I Agree.


4. In the Choose Components dialog use installation type Normal. Check that Tomcat Core and the component Manager have been selected at least and click the button Next.

 

5. In the Configuration dialog specify individual credentials for the administrative user and note them down. You will need this later to access the Tomcat Application Manager interface. HTTP Connector Port number 8080 should not be customized, unless you have other needs and the experience to do so.


6. In the Java Virtual Machine dialog, the path to the designated java installation is set as it has been recognized automatically. If there is no path recognized or you want to use another java installation, choose the path by your own. By default, a standard java installation should be installed in C:\Program Files\java\.


7. In the next dialog, you may customize the target directory for your installation.


8. Afterwards click the button Install.


9. Installation will now start. This will need a short while.


10. Click the button Finish. This will finalize the installation process.

 

 

Configuration

Set Tomcat service startup to Automatic from default

 

 

Increase upload size for Tomcat Application Manager

Using the default settings, the browser-based Tomcat Application Manager, available by subdomain /manager, will not be able to deploy the Manager installation file due to low file-size restrictions.

Procedure

Proceed as follows to increase the file-size restrictions:

1. Go to the webapps folder in the Tomcat installation directory.


2. Open directory manager.


3. Open directory WEB-INF.


4. Open the file web.xml in your favorite text editor application. (Note: you may require administration privileges to make changes to this file.)


5. Search for parameter <max-file-size>.


6. Change the value for <max-file-size> and following parameter <max-request-size> from current 52428800 (50MB in Byte) to a higher value fitting the installer size at minimum, e.g. 167772160 (160MB).


7. Save the file and close it.

Note: This change does not require any restart and will take effect accordingly.

 

Configure a secure connection (SSL)

Apache Tomcat provides the creation of self-signed certificates as even as the import of TTP certificates (Trusted Third Party, for example by VeriSign, TC TrustCenter, Signtrust, TeleSec, Thawte Consulting). By using an SSL certificate, you are able to encrypt all communication with the server, thus the communication with Manager. Using an SSL connection, you will have to call the Manager with https:// as prefix of address.

Please read the Manager Security Guide for details on setting up SSL encrypted communication. Find additional information at distributor's product documentation:

http://tomcat.apache.org/tomcat-8.0-doc/ssl-howto.html

Note: In our installation, no SSL configuration done.

Change of the Connector port

The connector port the server applications will be available by can be changed according to your needs / security specifications.

Procedure

1. Go to the installation directory of your Tomcat instance.


2. Open folder conf.


3. Open file server.xml.


4. Search for entry starting like this:

 Syntax: 

<Connector port="8080" protocol="HTTP/1.1"... 

5. Change the parameter port as desired.

Note: In our installation, we changed the default parameter to custom port 1080 during tomcat   installation.

6. Save and close the file.


7. Restart the Tomcat Server.

 

 

Performance optimizations

The performance of Apache Tomcat depends mostly on the parameters set for the Java Virtual Machine (JVM). Unfortunately, Apache Tomcat by default runs with very low defaults for these parameters, hence it we strongly recommend changing these to gain best performance.

In Tomcat Monitor

Apache Tomcat provides the Windows Application Monitor Tomcat, which allows you to change the most common configuration settings for the Java Virtual Machine.

How to start the Configuration Interface

Start the Tomcat Monitor as following:

1. Go to Start -> Programs -> Apache Tomcat x.0 -> Configure Tomcat.

Alternatively, you may start it by using the file Tomcat8w.exe, which is located inside the bin folder in Tomcat installation directory.

2. Select the tab Java

 

How to optimize settings

In the tab Java, you can specify the environment settings for the Java Virtual Machine (JVM). Settings which are not specified here use the Tomcat defaults. These are set to run in small test environments but not in productive usage.

 

Set memory heap space

By default, Tomcat uses an overall memory allocation (memory heap space) with a size of ~64 MB. Insert a higher value accordant to your machines memory into the fields Initial memory pool and Maximum memory pool (1).

To avoid Tomcat slowing down by constant recalculation of floating memory you should define the same value for both fields.

Consider leaving enough memory for the database engine (if on the same machine) and the operating system:

1-tier system: use not more than 50% of available physical memory

2-tier system: use not more than 75% of available physical memory

Note: Microsoft Windows restricts the memory allocation of java within a 32bit environment. Insert 1380 as maximum value. Otherwise the Tomcat service won’t work. This restriction does not apply within a 64bit environment. If Service Status shows Stopped after trying to start the service, the value for the memory pool might be overvalued. Enter a lower value and try again.

 

Set thread stack size

By default, Tomcat uses a thread stack size of 64 KB. Running a productive scenario with a high number of objects this size might be to less e.g. on running the synchronization between the Producer and the Manager. To avoid thread aborts and resulting problems in synchronization behavior it is highly recommended to enter a higher value into field Thread stack size (2).

A thread stack size of 128 KB or 256 KB should be sufficient.

Consider that increasing the thread stack size results in a more rapid fill of the memory pool. Having a high number of authors creating content you should think about to provide more memory to the memory pool (or the server itself).

 

Set PermGen cache size

On startup Tomcat loads all Java classes of each web application into the so called PermGen pool which is allocated at 64 MB by default. Deploying multiple web applications/Manager instances on one Tomcat application server, it may happen that the server stops suddenly with an Out-of-memory error message (in the log file). Increase the PermGen allocation by adding the following new line to the field Java options (3) - replace <size> with an accordant value:

-XX:MaxPermSize=<size>m

A value of 128 up to 256 should be sufficient. Consider having enough memory heap space specified.

 

Set survivor cache ratio and memory pool sizes

The memory heap space of Tomcat is divided into different pools containing objects of different ages. The purpose of this splitting is to improve the performance of garbage collection (cleaning up unused memory), hence briefly used objects are cleaned up quickly. To speed up the cleaning of recent objects with no long-term usage (young generation pool) it is recommended to change Tomcats default values as following.

1. Specify the same fixed initial and maximum size for the young generation pool by adding the following new lines to the field Java options (4) - replace <size> with an accordant value:

 

-XX:NewSize=<size>m (default 2m)

-XX:MaxNewSize=<size>m (unlimited, if not specified)

The correct size depends on your overall memory heap size (1). It should not be more than 50% of it.

2. Change the ratio the so-called survivor cache (to copy collection from young to older cache pool) uses to determine its size (based on the size of the young pool) by adding the following line to the field Java options (5):

 

-XX:SurvivorRatio=6 (default: 32)

 

This means each survivor space will be 1/8 the young generation. A value of 6 - 8 in most cases is the best.

 

How to apply optimized settings

To apply your changed settings, you will have to restart the Tomcat service. Proceed as following:

1. Choose tab General.


2. Stop the service by clicking on Stop.


3. Start the service by clicking on Start.

Note that it might take a while until the button Start gets active, since the server needs a while to shut down and unload all data.

 

In Server configuration files

Additionally, to the improvements on JVM parameters you can improve performance and robustness by changing xml configuration parameters the Tomcat server uses itself.

Where to find the configuration files

Proceed as following:

1. Go to the Tomcat installation directory.


2. Open the directory conf.


3. Open the file server.xml in your favorite text editor application.

Note you may require administration privileges to make changes to this file.

 

How to optimize parameters

Within the file server.xml you can specify all server parameters according to connectivity and accessibility. Consider making a backup of that file before editing.

Increase maximum number of threads

The maximum number of simultaneous request processing threads to be created by a connector is set to 200. If this number is reached the connector will block any other incoming request. In a larger content creation and learning scenario this limit might be reached quickly. Hence it is highly recommended to increase the maximum value for thread handles to a value accordant to your scenario. It should be at least one and a half times of the number of simultaneous end users you expect.

Example Your planned scenario: 100.000 end user/5.000 active (concurrent) user = 7500 maximum threads

 

Proceed as following to add the maximum thread definition:

1. Scroll to the part of the Connector definitions.


2. Add the parameter maxThreads to each definition of an active connector. In box below you see an example of an adapted connector element. The added parameter is marked red.

Syntax

<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" keystoreFile="/.keystore" keystorePass="changeit" maxThreads="2000" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" maxHttpHeaderSize="65536" />

 

Increase http header size

In some cases, e.g. of users which are assigned to a big number of groups it may happen, that the length of the http header exceeds the maximum size as permitted by Tomcat server. This happens because of the need to send all group dependencies inside the header. In this case the Tomcat server unfortunately discards the authentication, resulting in a server error message which is display to the user after calling the Manager. To solve this issue, an adaption of the default value (8Kb) will be necessary. Proceed as following:

1. Scroll to the part of the Connector definitions.


2. Add the parameter maxHttpHeader to each definition of an active connector. In box below you see an example of an adapted connector element. The added parameter is marked red.

Syntax 

<Connector port="8443" protocol="HTTP/1.1" SSLEnabled="true" keystoreFile="/.keystore" keystorePass="changeit" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" maxHttpHeaderSize="65536" />

 

 

How to apply optimized settings

To apply the changed server settings, proceed as follows:

1. Save and close the file.


2. Restart the Tomcat server service.

 

2.3 Installation of the Visual C++ Redistributable Packages

The Manager requires an existing installation of the Microsoft™ Visual C++ Redistributable Packages for Visual Studio 2013.

Please download and install the package from the Manufacturers Download Center: https://www.microsoft.com/en-US/download/details.aspx?id=40784   

 

Note: For correct functionality, the usage of the upper mentioned version is mandatory. o Use the 64bit version (vcredist_x64.exe).

Installation Procedure

1. Double click on the installation file.


2. Agree the agreement and click Next.


3. Installation begins, after that click Close

2.4 Installation of the Microsoft SQL Server

The Microsoft SQL Server provides a managed database to store object, task and user relevant data. The database environment can be available as local installation on the same machine hosting the Tomcat Server or on another machine in the network (dedicated server). Observe that the use of a dedicated database might need a high-performance network connection between both server machines.

 

Installation Procedure

1. Insert Microsoft SQL Server Install Medium or double click installation file.


2. The dialog SQL Server Installation Center appears providing you several options to proceed. Select left-sided menu item Installation.


3. Click New installation or add features to an existing installation.


4. Agree to the License Terms in appearing Setup window and click Next > to proceed. The Setup Assistant will now setup necessary support files what might take a while.


5. In Setup Step Feature Selection select at least the instance feature Database Engine Services. Click Next > to proceed.


6. In Setup Step Instance Configuration select Default instance unless you have the experience to do else. Click Next > to proceed.


7. In Setup step Server Configuration change account settings only if you have the experience to do so. Otherwise use the default values and click Next > to proceed.


8. In Setup Step Database Engine Configuration select the option Mixed Mode. Enter a password for the system administrator account sa. You may now add other user accounts as SQL administrators. To do so, click .. below list Specify SQL Server administrators and select according user accounts. In case your own account is not displayed in the list, click Add Current User. Click Next > to proceed.


9. Setup step Installation Progress will now start to install the application features. This might take a while.


10. When installation is finished the last setup step Complete will display information about operations taken. Click Close to finish installation.


11. Proceed with the service configuration now.

 

Configuration

Start the SQL Server Configuration Manager from Start -> Programs -> Microsoft SQL Server XXXX -> Configuration Tools.

1. Expand the item SQL Server Network Configuration in the left frame of the SQL Server Configuration Manager. Select the sub node Protocols for SQLSERVER.

2. Enable the protocols for Named Pipes and TCP/IP by selecting the context menu entry


3. Enable of each item.


4. Right-click the item TCP/IP and select Properties in the context menu.


5. Select the tab IP Addresses and insert the port number 1433 in every line where a TCP-Port is requested. Click on the button Apply and close the window with the Ok


6. Now select the node SQL Server Services inside the left frame.


7. Select entry SQL Server (SQLSERVER). Consider that the name in brackets might vary in case you entered an individual instance name in installation process.


8. Restart the server instance by context menu entry Restart. Alternatively, you can use the control menu icons below the menu bar.


9. Close the SQL Server Configuration Manager.

 

Note: These settings won’t work until you have restarted the server.

 

 

3. Installation

Files

 

Shortcuts

No shortcuts will appear on the desktop or in the programs menu.

 

Pre-parameterization of the installer

Use

By pre-parameterizing the Installer file, you can roll-out the Manager to several installation scenarios in your company with a set of installation settings already given. This might be useful for global parameters like the companies’ mail server or the address of a dedicated MS SQL Server machine.

You may even include the credentials of a special SQL service user which shall be common for all Manager instances. But observe that these credentials will be accessible for everyone getting this specially modified Installer file.

Note: For security reasons, you should not forward or share the installation file after modification since it might contain the credentials for the user database access.

Prerequisites

The following prerequisites will be needed:

Recommendation: To use the Windows built-in ZIP-function you can rename the Installer file by changing the file extension from "war" to "zip". Just switch back file extension to "war" after having modified and saved the file.

 

Procedure

To ensure the web application installer file (*.war) is correctly configured you must edit the according files before deploying the file on the Tomcat server.

Note: You may also edit the files after deployment, but this will require you to restart the Tomcat service affecting other already running web applications.

Modify application properties

It is highly recommended to edit the config.properties file for security and performance reasons:

1. In the file structure of the installer file double-click directory WEB-INF.


2. Now double-click directory classes.


3. Double-click the file config.properties. Select a text editor when asked for how to open the file.


4. Modify the parameters in the file according to your needs. See descriptions in table below.


5. Save and close the file.


6. Save your changes to the Installer file with the File Archiving Application.

 

Procedure

As following the instance/file name <Manager name>(.war) will be used.  Consequentially the instance would be available by entering this address:

http(s)://<tomcat-server>:<port>/<Manager name>

 

1. For the installation of the Manager application open your favorite browser and type in the following address to access the Tomcat Application Manager:

http(s)://<tomcat-server>:<port>/<Manager name>/html

 

2. An authentication window appears. Please insert login data as following. Note that these credentials might have been changed within a pre-parameterized Installer file - in this case use credentials as separately delivered by your responsible contact.

 

 

SQL Server Connection

Server Address*: 

Specify the address of the server, which is allocating the Microsoft SQL Server. If the SQL Server is located on your own workstation, you may enter localhost as server address. Specify the port number by an appendix to the IP address, if your default SQL port is set to something else than the default port 1433.

Schematic Example: 192.168.100.132:1433

Authentication User*: 

As if you are not owning another individual account insert username sa. This username is used for the system administrator of the SQL-Server. Any individual user account must have permission to create and manage databases. Read the instructions in chapter Installation with restricted SQL login permissions to learn how to handle missing SQL user permissions.

Authentication Password*:  

Insert password according to your SQL user account.

 

 

Database Initialization

You can choose between selecting an existing database, for example one from a previous installation, or creating a new one.  Choose your option by selecting one of the radio buttons shown for every opportunity. Note that a database connection is mandatory to proceed with the installation.

Select existing database: 

Within this option you will get a list of all existing databases in a dropdown menu. Choose the database of your choice and click the button Next Step.

Create new database: 

Insert a name for the database, which will be created, and define a database path, where the created database files will be stored.  Take care for the correct permission rights of the defined folder.  After entering the data click the button Next Step.

 

Various settings

File storage:

In the field, base directory* enter the path to the directory, where the objects and contents of the Manager will be stored. Ensure that this directory has the correct access permissions.

Mail server:

Specify the address of the mail server to use in field SMTP Server. Usually this address is composed of server name and domain name, like servername.domainname.de. Enter a sender address*. This address is used for the mails which were generated by Manager and will be shown as sender of every automatic generated email. To catch returns and response mails the mail address must be registered on the mail server.

 

 

 

Manager Initialization

Super Admin:

Specify login data for the first user profile in Manager by entering the fields User Name* and Password*. This user profile will get administrator permissions by default.

 Initial Workarea:

Specify the display name* which will be shown in initial arranged Workarea. You should define a clear allocable short variant of that name, without spaces, in the field Workarea ID*, for example wa for Workarea.

 

Install content packages

In step Install Content you get the opportunity to upload predefined sceneries to the Manager. This functionality is for development and testing purposes only. Please click Next step to proceed with the installation process.

 

Finish of installation process

The window Finished informs you about completion of the install process.

Clicking the button Close Wizard will lead you directly to logon area of the newly installed Manager.

 

4. Result

SAP Enable Now Manger Installed

 

 

 

Thanks,
Santhosh Kumar R G