Preface


The iPlanet Application Server Enterprise Connector for CICS Developer's Guide gives a brief overview of the CICS connector and explains how to write the servlet or Enterprise Java Bean (EJB) applications. The iPlanet Application Server Enterprise Connector for CICS Developer's Guide is written for application programmers who develop internet or intranet applications for the CICS Enterprise Information System (EIS).

This preface contains information about the following topics:

• Prerequisites

• What's in This Guide

• Documentation Conventions

• Guide Online

• Related Information

Prerequisites

---

This guide assumes that you are familiar with the following topics:

• iPlanet Application Server programming concepts

• The Internet and World Wide Web

• CICS Programming Concepts

• Java Programming Language and Java servlets

• Enterprise JavaBeans

• Java Programming Language

What's in This Guide

---

The iPlanet Application Server Enterprise Connector for CICS Developer's Guide covers the information you need to know to write servlets or EJBs that utilize UIF and the iPlanet Application Server Enterprise Connector for CICS to connect to your CICS EIS.

The following table lists a short summary of what each chapter covers.

See this chapter	If you want to do this
Chapter 1 "Overview"	Familiarize yourself with conceptual information before writing UIF APIs servlets or EJBs.
Chapter 2 "Viewing the Repository Contents"	View all contents of the Repository Browser.
Chapter 3 "Working With Data Objects"	Acquire UIF objects and execute function objects. The chapter also describes how to use the UIF API to develop a servlet or EJB which communicates with the EIS.
Chapter 4 "Programming Examples"	View a simple sample application and view examples of code that can be used to set up the CICS Enterprise Connector.
Appendix A "Error Messages and Codes"	Display error messages for CICS Enterprise Connector and their codes. This appendix also includes a sample of the error handling code that can be used by the servlet developer.
Appendix B "Communication Failure Codes"	Display a list of the most common causes for communication failure, and the recommended action to be taken.

Documentation Conventions

---

This guide uses URLs of the form:

http://server.port/path/file.html

In these URLs, server is the name of server on which you run your application; port is your Internet domain number; path is the directory name on the server; and file is an individual filename. Italic items in URLs are placeholders.

This guide uses the following font conventions:

• The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, path names, directory names, and HTML tags.

• Italic type is used for book titles, emphasis, variables and placeholders, and words used in the literal sense.

Guide Online

---

You can find the iPlanet Application Server Enterprise Connector for CICS Developer's Guide online in PDF and HTML formats. To locate these files, use the following URL:

http://docs.iplanet.com/docs/manuals/

Related Information

---

In addition to this guide, there is additional information for administrators, end users and developers. Use the following URL to view the related documentation:

http://docs.iplanet.com/docs/manuals/ias.html

The following lists the documents that are available:

• iPlanet Application Server Enterprise Connector for CICS Administrator's Guide

• iPlanet Web Server Developer's Guide

• iPlanet Application Server Administrator's Guide

• iPlanet Application Server Installation Guide

• iPlanet Application Server Overview Guide

• iPlanet Application Server Release Notes

• iPlanet Application Server Administrator's Guide

• iPlanet Application Builder User's Guide

• iPlanet Application Builder Installation Guide

• iPlanet Application Builder Release Notes

• iPlanet Unified Integration Framework Release Notes

• iPlanet Unified Integration Framework Developer's Guide