Preface


This guide explains the basics of the Connector concepts, the Management Console, and Data Mining,. It also contains examples of how to program servlet and EJBs. This preface contains the following sections:

This preface contains the following sections:

• What's in This Guide

• What You Should Already Know

• Documentation Conventions

• User Roles

What's in This Guide

---

The following table provides a quick overview of what is in this guide.

See this chapter	If you want to do this
Chapter 1 "Basic Connector Concepts	Describes concepts you should be familiar with before you set up iPlanet Application Server Enterprise Connector for CICS or use the API in servlets or EJBs.
Chapter 2, "CICS Repository "	Describes how to use the repository browser to view and modify iPlanet Application Server Enterprise Connector for CICS information.
Chapter 3 "Programming Examples"	Describes the procedure for acquiring BSP objects and executing function objects. Describes how to use the management console to view and change your iPlanet Application Server Enterprise Connector for CICS configuration, convert Cobol definitions to XML files, load files into the repository, and edit files. Describes how to install the TELCO sample application.
Chapter 4 "Server-Side API Communication	Describes the server-side API that you may need to use to modify a CICS program.

What You Should Already Know

---

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

Documentation Conventions

---

File and directory paths are given in Windows format (with backslashes separating directory names). For Unix versions, the directory paths are the same, except slashes are used instead of backslashes to separate directories.

This guide uses URLs of the form:

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

In these URLs, server is the name of server on which you run your application; domain is your Internet domain name; path is the directory structure 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, pathnames, directory names, and HTML tags.

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

User Roles

---

People with different skill sets are typically involved with the set up of iPlanet Application Server Enterprise Connector for CICS:

System Administrator	Installs iPlanet Application Server Enterprise Connector for CICS.
Systems or Business Analyst	Uses the CICS Data-Mining tool to define the CICS transactions that are available through iPlanet Application Server Enterprise Connector for CICS. Uses the Management Console to specify levels of security, the end users that have access to specific kinds of data, and performance characteristics, such as pooling.
Applications Programmer	Writes servlets and EJBs that call the BSP APIs. Uses the Repository Browser to determine the available data types and access methods.
CICS Programmer	Writes new CICS programs that perform advanced communications with iPlanet Application Server Enterprise Connector for CICS, or modifies existing programs.