About This Document

 

This document explains what the eLink Adapter Development Kit is and describes how to use it for designing adapters to third-party enterprise applications such as ERP, CRM, and Supply Chain Management.

This document covers the following topics:

• Understanding The BEA eLink System, a brief description of the BEA eLink system.

• Understanding the BEA eLink Platform, a brief description of the BEA eLink platform.

• Understanding Adapter Architecture and Design, a brief description of adapter architecture and design.

• Installing the eLink ADK and Sample Adapters, a description of what is included in the eLink Adapter Development Kit and how to install it.

• Configuring and Running the Sample Adapters, a description of how to configure and run the sample adapters.

• eLink Adapter Development Kit References, a description of eLink Adapter configuration processing API, hash table API, utility functions and macros, and definitions and typedefs.

• ATMI References, a description of commonly used Tuxedo ATMI functions for the eLink Adapter Development Kit.

• FML32 API, a description of commonly used Tuxedo FML32 API functions for the eLink Adapter Development Kit.

• Tuxedo Commands, a description of some of the commonly used Tuxedo commands for the eLink Adapter Development Kit.

• Servopts, a description of the Tuxedo servopts function.

• Error Messages, a description of eLink Adapter Development Kit error messages and recommended actions.

• Glossary

 

---

What You Need to Know

This document is intended mainly for Application Programmers who will configure and set up the BEA eLink Adapter Development Kit and eLink services to create software components called adapters, which are used to integrate third-party applications to the eLink system. It is assumed that the programmer has experience with the C language. Experience with BEA Tuxedo is an asset, but not necessary.

 

---

e-docs Web Site

BEA product documentation is available in both PDF and HTML format on the BEA corporate Web site. From the BEA Home page, click on Product Documentation or go directly to the "e-docs" Product Documentation page at http://www.e-docs.beasys.com.

 

---

How to Print the Document

You can print a copy of the HTML document, one file at a time, from your Web browser by selecting File|Print, or you can print the PDF document. Open the PDF file in the Adobe Acrobat Reader and print the entire document (or a portion of it) in book format. To access the PDFs, open the eLink Adapter Development Kit documentation Home page, click the PDF files button and select the document you want to print.

If you do not have the Adobe Acrobat Reader, you can get it for free from the Adobe Web site at http://www.adobe.com/. Refer to the eLink Adapter Development Kit Release Notes for more detailed information about viewing and printing the documentation.

 

---

Related Information

The following BEA Tuxedo documents contain information that is relevant to using the eLink Adapter Development Kit.

• BEA Tuxedo Administering the BEA Tuxedo System

• BEA Tuxedo Application Development Guide

• BEA Tuxedo FML Programmer's Guide

• BEA Tuxedo Programmer's Guide

• BEA Tuxedo Reference Manual

For more information about Tuxedo, refer to the BEA Tuxedo Online Documentation CD at http://edocs.beasys.com/tuxedo/tux65/index.htm.

 

---

Contact Us!

Your feedback on the eLink Adapter Development Kit documentation is important to us. Send us e-mail at [e-mail] if you have questions or comments. Your comments will be reviewed directly by the BEA professionals who create and update the eLink Adapter Development Kit documentation. In your e-mail message, please indicate that you are using the documentation for the BEA eLink Adapter Development Kit Product Version: 1.1 release.

If you have any questions about this version of BEA eLink Adapter Development Kit, or if you have problems installing and running BEA eLink Adapter Development Kit, contact BEA Customer Support through BEA WebSupport at www.beasys.com. You can also contact Customer Support by using the contact information provided on the Customer Support Card, which is included in the product package.

When contacting Customer Support, be prepared to provide the following information:

• Your name, e-mail address, phone number, and fax number

• Your company name and company address

• Your machine type and authorization codes

• The name and version of the product you are using

• A description of the problem and the content of pertinent error messages

 

---

Documentation Conventions

The following typographic conventions are used throughout this document.

Convention	Item
boldface text	Indicates terms defined in the glossary.
Ctrl+Tab	Indicates that you must press two or more keys simultaneously.
italics	Indicates emphasis or book titles.
blue text	Indicates a hyperlink to a cross-reference.
monospace text	Indicates code samples, commands and their options, data structures and their members, data types, directories, and file names and their extensions. Monospace text also indicates text that you must enter from the keyboard. Examples: #include <iostream.h> void main ( ) the pointer psz chmod u+w * \tux\data\ap .doc tux.doc BITMAP float
monospace boldface text	Identifies significant words in code. Example: void commit ( )
monospace italic text	Identifies variables in code. Example: String expr
UPPERCASE TEXT	Indicates device names, environment variables, and logical operators. Examples: LPT1 SIGNON OR
{ }	Indicates a set of choices in a syntax line. The braces themselves should never be typed.
[ ]	Indicates optional items in a syntax line. The brackets themselves should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...
|	Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed.
...	Indicates one of the following in a command line: That an argument can be repeated several times in a command line That the statement omits additional optional arguments That you can enter additional parameters, values, or other information The ellipsis itself should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...
. . .	Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed.