Previous Topic: Install the Web Interface on z/OS 2.1 and Earlier ReleasesNext Topic: Customize the Web Interface

Customization › Menu System and Web Interface › Install the Web Interface on z/OS 2.2

Install the Web Interface on z/OS 2.2

Under z/OS 2.2, the CA Spool web interface runs as a native CGI gateway program under the z/OS Apache HTTP server. This server is part of the z/OS 2.2 base product.

Note: For information to configure the z/OS HTTP server, see the IBM Redpaper IBM HTTP Server on z/OS: Migrating from Domino-powered to Apache-powered.

To install the CA Spool web interface on z/OS 2.2, follow this process:

  1. Review and verify the assumptions.
  2. Install the Apache HTTP server.
  3. Confirm that the Apache HTTP server is installed correctly.
  4. Configure the Apache server to work with CA Spool Web Interface.
  5. Create a started task to run the z/OS HTTP Apache server.
  6. Start and stop the z/OS HTTP Apache server.
  7. (Optional) Customize the web interface for your environment.

Step 1: Review and Verify the Assumptions

  1. Review and verify the following assumptions:

    If your environment uses a different value, specify that value instead as you perform the steps that follow.

Step 2: Install the Apache HTTP Server

  1. Create an installation directory for the server configuration files, for example: 
    cd /cai/caspool

    mkdir websrv
  2. Change the directory to the HTTP Server product directory: 
    cd /usr/lpp/IHSA/V8R5/.31bit
  3. Run the installer program, bin/install_ihs, to perform these tasks:

    Use these parameters to run the installer program:

    For example:

    ./bin/install_ihs /cai/caspool/websrv 8081

Step 3: Confirm That the Apache HTTP Server Is Installed Correctly

  1. Change to the server's installation directory: 
    cd /cai/caspool/websrv
  2. Run these commands to verify that the Apache HTTP Server was successfully installed: 
    apachectl -v

    apachectl configtest
  3. Review the output. For a successful installation, the output appears similar to the following example: 
    # bin/apachectl -v
Server version: IBM_HTTP_Server/8.5.5.2 (Unix)
Server built: Jul 11 2014 18:07:04
# bin/apachectl configtest
Syntax OK

Step 4: Configure the Apache Server to Work with CA Spool Web Interface

  1. Customize your web server configuration file for the Apache server. To enable CA Spool Web interface on the new server, customize the following example for your environment, and add it to the end of your /cai/caspool/websrv/conf/httpd.conf file: 
    	# SAF (RACF) authorization
	# ------------------------
	# SAF authentication is provided by the mod_authnz_saf
	# module. The mod_authz_default and mod_auth_basic modules
	# provide basic authentication and authorization support
	# which is needed in mod_authnz_saf configurations.
	LoadModule authnz_saf_module modules/mod_authnz_saf.so
	
	# ============================================================
	# CA Spool Web Interface                                                              
	# ------------------------------------------------------------
	<Location /caspool/>                                                           
	  AuthName "CA Spool"                                                            
	  AuthType Basic                                                                 
	  AuthBasicProvider saf                                                          
	# CA Spool requires an authorized user                                         
	  Require valid-user                                                             
	  SAFRunAs %%CLIENT%%                                                            
	# No translation by default for location /caspool/                             
	  CharsetSourceEnc IBM-1047                                                      
	  CharsetDefault ISO8859-1                                                       
	</Location>                                                                    
	# CA Spool help is in EBCDIC                                                   
	<Location /caspool/help/EN_US/>                                                
	  CharsetSourceEnc IBM-1047                                                      
	  CharsetDefault ISO8859-1                                                       
	</Location>                                                                    
	#                                                                              
	# Map URIs to directories                                                      
	ScriptAlias /caspool/esfhweb         /cai/caspool/esfhweb     
	ScriptAliasMatch /caspool/ESF*       /cai/esfhweb     
	Alias       /caspool/castyles.css     /cai/caspool/castyles.css
	Alias      /caspool/images           /cai/caspool/images      
	Alias      /caspool/swap             /cai/caspool/swap        
	# ============================================================

Step 5: Create a Started Task to Run the z/OS HTTP Apache Server

  1. Customize the CBQ4PROC(CAIQWEBA) JCL procedure member as needed and copy it to an active PROCLIB library.
  2. Define the user ID for CAIQWEBA.
  3. Define a RACF (or other SAF) STARTED rule to map the CAIQWEBA started task to the user ID.

Step 6: Start and Stop the z/OS HTTP Apache Server

  1. Use an MVS 'S CAIQWEBA' command to start the z/OS HTTP Apache Web Server.
  2. Go to SYSLOG and search for messages issued by the CAIQWEBA STC until you find the following message:

    STC51452 00000094 IHS is active. Use jobname CAIQWEBx for MVS commands.

    Remember the assigned jobname CAIQWEBx.

  3. Verify that the Apache HTTP Server is running successfully by loading the default CA Spool Web Interface web page with the host name or IP address of your z/OS system and the defined port number.

    For example:

    http://**HostName**:**port**/caspool/esfhweb

  4. Use an MVS ‘P CAIQWEBx’ command to stop the Web Server.