SOAP Sample Application using TPF XML APIs for z/TPF Enterprise Edition V1 R1

Copyright International Business Machines Corporation, 2006. All Rights Reserved.

Note to US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

NOTE: Before using this information and the product it supports, read the general information under "NOTICES" in this document.

CONTENTS

This file includes the following information:

1.0 ABOUT THIS README
2.0 SYSTEM REQUIREMENTS
3.0 DOWNLOADING
4.0 COMPILING, LINKING, AND LOADING
5.0 RUNNING
6.0 NOTICES
6.1 Trademarks

1.0 ABOUT THIS README

This readme file will guide you through the process of downloading, installing, and using a SOAP sample application on your z/TPF system. This sample application demonstrates how to use the z/TPF XML APIs (APAR PJ30866).

The SOAP sample application package provides you with a complete sample that can be run on your z/TPF system. You can use it as a starting point for your own SOAP application, use it for training purposes, or use it as-is. Go to the IBM TPF Product Information Center for more details about SOAP support.

Note: The TPF development lab does not maintain this application and will not accept APARs on this code.

2.0 SYSTEM REQUIREMENTS

To install and use this SOAP sample application on your z/TPF system, you must have Apache with the mod_tpf_soap module applied to your system because this application uses the Apache HTTP server as its communications binding.
The code and information for installing and using mod_tpf_soap is available as a downloadable tool at www.ibm.com/tpf/download/ztpfsoap.htm

3.0 DOWNLOADING

To download this module, do the following:

1. Click the Download now button to download the compressed sample application code package (the “tarball”) to your PC. The name of this package is soap_sample_xmlapi_zTPF.tar.Z.



2. Decompress the tarball on your PC using WinZip or some other PC file decompression tool.

   Tip: If you are using WinZip, verify that the "TAR File Smart CR/LF Conversion" option (under Options, Configuration, Miscellaneous) is not selected.

   After you have completed this step, you will have the following files on your PC:

   1. In the directory: C:/your_workdir/local_mod/base/rt
      • Modified version of the tpf_soap_appl_handler user exit (cso4.c)
      • MakeTPF sample makefile (cso4.mak)
   2. In the directory: C:/your_workdir/soap
      • Sample z/TPF XML API application code (cso7.c)
      • MakeTPF sample makefile (cso7.mak)
   3. In the directory: C:/your_workdir
      • Sample client html file (soap_sample_client_xmlapi.html). This file will not be used on your Linux system.


3. FTP the tarball to your home directory on your Linux system using binary mode:
   • Open an MS-DOS window and activate FTP by using the following command:
     ftp your.linux.build.machine.com
   • Sign in using your user name and password.
   • Set the mode to binary by entering the following command:
     binary
   • Send the file to your Linux system by using the following command:
     send c:\your_path\soap_sample_xmlapi_zTPF.tar.Z soap_sample_xmlapi_zTPF.tar.Z
   • Exit FTP by entering the following command:
     bye
   
   
4. On your Linux system, create a working directory in your root directory by entering the following command:

   mkdir ~/your_workdir

5. Change to the working directory and extract the program files from the SOAP sample application package by entering the following command:

   cd ~/your_workdir
   tar -xzkf ../soap_sample_xmlapi_zTPF.tar.Z

   After you have completed this step, you will have the following files on your Linux system:

   1. In the directory: ~/your_workdir/local_mod/base/rt
      • Modified version of the tpf_soap_appl_handler user exit (cso4.c)
      • MakeTPF sample makefile (cso4.mak)
   2. In the directory: ~/your_workdir/soap
      • Sample z/TPF XML API application code (cso7.c)
      • MakeTPF sample makefile (cso7.mak)
   3. In the directory: ~/your_workdir
      • Sample client html file (soap_sample_client_xmlapi.html). This file will not be used on your Linux system.

4.0 COMPILING, LINKING, AND LOADING

1. Change to the 'rt' directory:

   cd ~/your_workdir/local_mod/base/rt

2. Create a maketpf configuration file named maketpf.cfg.
   
   • Ensure that the first assignment of TPF_ROOT in maketpf.cfg is the absolute path to your "/your_workdir" directory.
     
   • Update other fields (TPF_BSS_NAME, TPF_SS_NAME, USER_VERSION_CODE) if necessary.
     
     
3. Edit the sample maketpf .mak file for tpf_soap_appl_handler user exit (cso4.mak). Verify that the maketpf_env assignments in cso4.mak are correct for your build environment.
    
4. Compile and link the modified tpf_soap_appl_handler user exit sample program.

   maketpf cso4.mak -f 

5. Change to the 'soap' directory:

   cd ~/your_workdir/soap 

6. Create a maketpf configuration file named maketpf.cfg.
   
   • Ensure that the first assignment of TPF_ROOT in maketpf.cfg is the absolute path to your "~/your_workdir" directory.
     
   • Ensure that the first assignment of APPL_ROOT in maketpf.cfg is the absolute path to your "~/your_workdir" directory.
     
   • Update other fields (TPF_BSS_NAME, TPF_SS_NAME, USER_VERSION_CODE) if necessary.
     
     
7. Edit the sample maketpf .mak file for the SOAP sample z/TPF XML API application (cso7.mak). Verify that the maketpf_env assignments in cso7.mak are correct for your build environment.
    
8. Compile and link the SOAP sample z/TPF XML API application program.

   maketpf cso7.mak -f 

9. Use the standard load procedure to transfer and load the SOAP sample programs (cso4 and cso7) to your test system.

5.0 RUNNING

To run the SOAP sample z/TPF XML API application, you must have the Apache HTTP server running on your z/TPF system (with the mod_tpf_soap module applied). Open the soap_sample_client_xmlapi.html file on your PC in Microsoft Internet Explorer Version 5 or later. Follow the instructions on the page.

6.0 NOTICES

IBM may not offer the products, services, or features discussed in this information in other countries. Consult your local IBM representative for information on the products and services currently available in your area. Any reference to an IBM product, program, or service is not intended to state or imply that only that IBM product, program, or service may be used. Any functionally equivalent product, program, or service that does not infringe any IBM intellectual property right may be used instead. However, it is the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or service. IBM may have patents or pending patent applications covering subject matter described in this information. The furnishing of this information does not give you any license to these patents. You can send license inquiries, in writing, to:

Licensees of this program who wish to have information about it for the purpose of enabling: (i) the exchange of information between independently created programs and other programs (including this one) and (ii) the mutual use of the information which has been exchanged, should contact:

Such information may be available, subject to appropriate terms and conditions, including in some cases, payment of a fee. Any references in this information to non-IBM Web sites are provided for convenience only and do not in any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of the materials for this IBM product and use of those Web sites is at your own risk.

6.1 Trademarks