Installing the Web Services API

Note

Installation steps are illustrated here using Microsoft Windows XP as the client operating system and Apache Tomcat for the Web Services application server. You can use other client operating systems and Web Services application servers, as described in "Installation Prerequisites".

Uninstall Prior API Versions

Remove any previous installation of the ChangeMan ZMF Web Services API before upgrading to a new version. In particular, delete any previous ZMF Web Services WAR file and expansions of the WAR file from the webapps directory of your Web Services application server.

Caution

If you have previously installed the ZMF for Eclipse or WD4ZMF plug-ins on your Web application server, some version of the ChangeMan ZMF Web Services API resides on this system. Verify the compatibility of your installed plugin with the version of the Web Services API you plan to install before deleting the existing WAR file.

Apache Tomcat Example

If you are using Apache Tomcat on the Windows XP platform as your Web Services application server, perform the following steps:

1. Stop the Tomcat service:

   1. Go to Start | Settings | Control Panel | Administrative Tools | Services.

   2. Select the Apache Tomcat entry and then click Stop to stop the service.

2. Go to the Tomcat webapps directory at:

   Program Files\Apache Software Foundation\Tomcat x.x\webapps
   

3. Delete the following if they exist in the webapps directory:

   zmfws folder (and all its contents, which are expansions of the WAR file) zmfws.war file

Download the WAR File

WAR File Download

Download the ChangeMan ZMF Web Services API WAR file from the Serena Support Web site:

1. Under My Downloads, select ChangeMan ZMF Client Pack from the Product drop-down list.

2. Locate the desired version and click on Z/OS under Available Operating Systems.

3. Download the ChangeMan ZMF Web Services file (zmfws.zip) and save it to an appropriate directory. This zip file contains the WAR file, zmfws.war.

Install the Web Application Server Plug-in

WAR File Installation

To install the Web Services application server software plugin, do the following:

1. Stop the Web Services application server software.

2. Copy zmfws.war (from the directory where it was saved) to the webapps directory for the Web Services application server that will serve ChangeMan ZMF requests on behalf of Web Services clients.

3. Restart the Web Services application server software. |

Apache Tomcat Example

If you are using Apache Tomcat installed as a service on the Windows XP platform as your Web Services application server, perform the following steps:

1. Stop the Tomcat service:

   1. Go to Start | Settings | Control Panel | Administrative Tools | Services.

   2. Select the Apache Tomcat entry and then click Stop to stop the service.

2. Copy zmfws.war (from the directory where it was saved) to the Tomcat webapps directory at:

   Program Files\Apache Software Foundation\Tomcat x.x\webapps
   

3. Restart the Tomcat service:

   1. Go to Start | Settings | Control Panel | Administrative Tools | Services.

   2. Select the Apache Tomcat entry and then click Start or Restart to restart the service.

   3. Tomcat automatically expands the ZMF Web Services WAR file on restart. This creates the zmfws directory and all its contexts.

   Tip

   If the zmfws.jar file is not expanded into the zmfws directory automatically when you start Tomcat, use Tomcat’s Activate administrator function to expand the archive and start the ZMF Connector servlet.

Verifying the Install

To verify the API installation, use the Web application server’s manager app to verify that the zmfws application is running.