Deploy the web tier

This example describes the steps to deploy the webtier-9.52.war file on Tomcat 7.x and 8.x.

1. Log in to the server as a user with local administrator privileges.
2. Stop the Tomcat Web application server.

3. From sm9.51.xxxx_Web_Tier.zip, copy or save the webtier-9.52.war file onto your Tomcat webapps directory. For example, C:\Program Files\Apache Software Foundation\Tomcat 7.0\webapps.

4. If you use Tomcat 8.x, make sure that you change the "protocol" attribute as the following in the conf\server.xml file on Tomcat:

   <Connector port="8080" protocol="org.apache.coyote.http11.Http11NioProtocol" connectionTimeout="20000" redirectPort="8443" />

   Note You do not need to do this if you use Tomcat 7.x.

5. Start the Tomcat server. Tomcat automatically opens the webtier-9.52.war file and creates a webtier-9.52 virtual directory.

   If Tomcat does not create a webtier-9.52 directory when started, check the log files and contact support with the information found in the log files.

6. Edit the web.xml file located in the virtual directory to add your server connection information. The settings you define in this file determine the client preferences for all web clients. View the Service Manager online help for a complete list and more detailed explanation of each parameter.
   1. Open the web.xml file in a text editor.

   2. Set the secureLogin, sslPort, serverHost, and serverPort parameters.

      Parameter	Default value	Description
      secureLogin	true	Controls the encryption of network communication between the web application server and the web browser. Set it to false if you do not use Secure Sockets Layer (SSL) connections to the web server. Note: To use secure login, you must enable SSL on your web application server. For details, refer to your web application server documentation.
      sslPort	8443	This parameter is needed only when secureLogin is set to true. Set it to the SSL port of the web application server.
      serverHost	localhost	Specifies the name of the Service Manager host server.
      serverPort	13080	Specifies the communications port number to which the Service Manager server listens.

   3. Set other common parameters as desired. The table below lists the commonly set parameters and their default values.

      Parameter	Default value	Description
      cacerts	WEB-INF/cacerts	Lists the path to the CA certificates required for SSL support.
      compress_soap	true	Specifies if you want to use data compression between web clients and the web tier.
      helpServerHost		Specifies the name of the Help Server.
      helpServerPort		Specifies the communications port number to which the Help Server listens.
      helpServerContext	help	Defines the context path when deploying the Service Manager help on a web server (for example, Apache). The context path refers to the virtual directory name where the Service Manager help is installed. It excludes the web server’s document directory path. For example, if the help is deployed in C:/Apache/2.2/htdocs/sm_help, the document directory path is C:/Apache/2.2/htdocs/ and the virtual directory name is sm_help. Therefore, the context path is sm_help.
      showHelp	false	Enabling this parameter causes Web clients to display the Online Help and Shortcut List options after users click the Help (question mark) button. The Online Help option allows users to access the Help Server you define in the web.xml file. If this parameter is set to false, clicking the Help button will directly bring up the web client keyboard shortcut list.
      refreshMessages	true	Determines whether the browser checks for new messages from the application server.
      refreshMessagesInterval	15000	Determines how often (in milliseconds) the browser checks for new messages from the application server.
      ssl	false	Enables the web client to encrypt communications using the server’s demonstration certificate.
      viewactivenotes	false	Determines whether you see a pop-up message when the server sends a message.

7. Save and close web.xml.
8. Endorsed JAR files are no longer required. If you installed them in previous installations, remove them.

9. Restart the Tomcat server.

10. Set the web application server heap size. The web application server heap size determines how many connections each web application server can handle. Most application servers require a heap size of at least 256 MB for optimal performance. If you experience poor performance from your web client connections, increase the web application server heap size. See your web application server documentation for instructions.

This example describes deploying the webtier-ear-9.52.ear file on WebSphere Application Server versions 8.5.

1. Log in to the server as a user with local administrator privileges.
2. From the sm9.52.xxxx_Web_Tier.zip file, copy or save the webtier-ear-9.52.ear file onto your local system.
3. Start the WebSphere application server.

4. Set the web application server heap size. The web application server heap size determines how many connections each web application server can handle. Most application servers require a heap size of at least 256 MB for optimal performance. If you experience poor performance from your web client connections, increase the web application server heap size. See your web application server documentation for instructions.

5. Log on to the WebSphere administrative console with system administrator privileges.

6. Install the webtier-ear-9.52.ear file.

   1. Go to Applications > New Application > New Enterprise Application.

   2. Select Local file system, and browse to the webtier-ear-9.52.ear file.

   3. Click Next. WebSphere starts uploading the web tier application. This may take a while.

7. Click Next to accept the default settings in the next screens until you reach "Step 4: Summary", and then click Finish. The installation of the web tier ear file begins.
8. When the installation is complete, click Save to save your local configuration changes to the master configuration.

9. The webtier-ear-9.52.ear file contains webtier-9.52.war. Inside of that is the web tier configuration file (web.xml). Edit it to add your server connection information. The settings you define in this file determine the client preferences for all web clients. View the Service Manager online help for a complete list and more detailed explanation of each parameter.

   1. Open the web.xml file in a text editor. The web.xml file is deployed in the following folder: <WebSphere installation path>\AppServer\profiles\<Profile Name>\config\cells\<Node name>Cell\applications\HPE Service Manager 9.52 Web.ear\deployments\HPE Service Manager 9.52 Web\webtier-9.52.war\WEB-INF.

      For example: C:\Program Files (x86)\IBM\WebSphere\AppServer\profiles\AppSrv02\config\cells\IWFVM01268Node02Cell\applications\HPE Service Manager 9.52 Web.ear\deployments\HPE Service Manager 9.52 Web\webtier-9.52.war\WEB-INF.

   2. Set the secureLogin, sslPort, serverHost, and serverPort parameters.

      Parameter	Default value	Description
      secureLogin	true	Controls the encryption of network communication between the web application server and the web browser. Set it to false if you do not use Secure Sockets Layer (SSL) connections to the web server. Note To use secure login, you must enable SSL on your web application server. For details, refer to your web application server documentation.
      sslPort	8443	This parameter is needed only when secureLogin is set to true. Set it to the SSL port of the web application server.
      serverHost	localhost	Specifies the name of the Service Manager host server.
      serverPort	13080	Specifies the communications port number to which the Service Manager server listens.

   3. Set other common parameters as desired. The table below lists the commonly set parameters and their default values.

   Parameter	Default value	Description
   cacerts	WEB-INF	Lists the path to the CA certificates required for SSL support.
   compress_soap	true	Specifies if you want to use data compression between web clients and the web tier.
   helpServerHost	localhost	Specifies the name of the Help Server.
   helpServerPort	80	Specifies the communications port number to which the Help Server listens.
   helpServerContext	help	Defines the context path when deploying the Service Manager help on a web server (for example, Apache). The context path refers to the virtual directory name where the Service Manager help is installed. It excludes the web server’s document directory path. For example, if the help is deployed in C:/Apache/2.2/htdocs/sm_help, the document directory path is C:/Apache/2.2/htdocs/ and the virtual directory name is sm_help. Therefore, the context path is sm_help.
   showHelp	false	Enabling this parameter causes Web clients to display the help server option after users click the Help (question mark) icon, which allows users to access the Help Server you define in the web.xml file.
   refreshMessages	true	Determines whether the browser checks for new messages from the application server.
   refreshMessagesInterval	15000	Determines how often (in milliseconds) the browser checks for new messages from the application server.
   ssl	false	Enables the web client to encrypt communications using the server’s demonstration certificate.
   viewactivenotes	false	Determines whether you see a pop-up message when the server sends a message.

   4. Save, close and re-archive the files.
10. Configure the application properties.
    1. Go to Applications > Application Types > WebSphere enterprise applications.

    2. Click HPE Service Manager9.52 Web to open the Configuration tab, and under Detail Properties click Class loading and update detection, and make sure the default settings are selected.

       Setting	Value (default)
       Class load order	Classes loaded with parent class loader first
       WAR class loader policy	Class loader for each WAR file in application

    3. Click Apply.
11. Configure the HPE Service Manager module.
    1. Go to Applications > Application Types > WebSphere enterprise applications > HPE Service Manager 9.52 Web > Manage Modules.

    2. Click the HPE Service Manager module, and select the following setting.

       Setting	Value
       Class load order	Classes loaded with local class loader first (parent last) Note Keep the other settings on the page as default.

    3. Click Apply.

12. Configure the default http transport port of the WebSphere application server.

    Note You will use this port when launching the Service Manager web client.

    1. Go to Servers > Server Types > WebSphere application servers > server 1.

    2. In the Communications > Ports section, make note of the WC_defaulthost port number (for example, 9082).

    3. You can change this port number to one that is not in use (for example, 9085). This port number is automatically synchronized to the port number in Application Servers > Server 1 > Web container transport chains > HttpQueueInboundDefault.
    4. Click Environment > Virtual hosts > default_host > Host Aliases, and make sure that the port number is in the Host Aliases list. If it is not, do the following to add the WC_defaulthost port number to the list.
       1. Click New.
       2. Type the following port information:
          • Host Name: *
          • Port: xxxx (for example, 9085)
       3. Click Apply and then click OK. The port number is added to the Host Aliases list of default_host.
    5. Click Save to save the changes to the master configuration.
    6. Restart the WebSphere Application Server.

       Now the server will start binding to the new port.

       Note If you did not change the port number, you do not need to restart the server.

13. Add a Web container custom property setting. This step is required for particular error pages that match the error exception types defined in the web tier configuration file (web.xml) to display in the user's web browser.

    1. In the administrative console, click Servers > Server Types > WebSphere application servers.

    2. Click the server to which the custom property is to be applied.

    3. Under Configuration > Container settings, click Web Container Settings > Web container.

    4. Under Configuration > Additional Properties, click Custom Properties.

    5. On the Custom Properties page, click New.

    6. On the settings page, enter the following values in the Name and Value fields: 

       Name:com.ibm.ws.webcontainer.enableErrorExceptionTypeFirst

       Value: true

    7. Click Apply or OK.

    8. In the "Messages" box that appears, click Save.

    9. Restart the server for the custom property to take effect.

14. Go to Applications > Applications Type > WebSphere enterprise applications, select HPE Service Manager 9.52 Web, and click Start.

    When the application is successfully started, its state changes to green.

15. Launch the Service Manager web client using a URL like the following:
    http://<WAS application server name>:<Port>/webtier-9.52/index.do
    where: <Port> is the WC_defaulthost port number.
    
    For example: http://abc.def.hp.net:9085/webtier-9.52/index.do