The e-Adapter Development Kit (e-ADK®) provides components for creating interface adapters with minimum duplication and maintenance. The e-ADK is a set of tools and libraries designed to simplify the development of adapters that interface with web-based, packaged, and legacy applications. This provides a standard approach and framework for developing custom adapters. The e-ADK provides consistent functionality and a common user interface across platforms.
Adapter developers are targeted as the primary users of this book. The adapter developer who uses this book to develop an adapter must also be familiar with the contents of the e-ADK Programmer’s Reference and the e-ADK Installation Guide.
The e-ADK Developer’s Guide provides an overview of the e-ADK. This guide also defines the e-ADK files and functions that the developer can modify.
The guide is organized into the following chapters:
“About this book” provides a brief introduction to e-ADK 3.9, a list of available documentation, and technical support information.
Chapter 1, “Architectural Overview,” provides an overview of the e-ADK adapter architecture, tools, transport layer, and the development process.
Chapter 2, “Modes,” provides an in-depth presentation of the modes used for adapters.
Chapter 3, “Adapter Development Process,” provides the steps for developing an adapter using e-ADK 3.9.
Chapter 4, “Adapter Runtime Environment,” provides information about configuring the environment; registering an NT service; testing, deploying, and executing the adapter; and exception handling.
Chapter 5, “Troubleshooting,” provides additional information to help with the development of adapters.
This section describes the documentation available for the e-Adapter Development Kit, release 3.9.
Cross-Platform Documentation The e-ADK documentation set for developers consists of the following documents:
Installation Guide
Developer’s Guide
Programmer’s Reference
Feature Guide
Related Documentation The following Open Transport Version 2.6 documents are referenced in this document set to supply you with specific information that supports this product:
EMQ Driver Configuration Guide
File Driver Configuration Guide
MQ Series Driver Configuration Guide
MSMQ Driver Configuration Guide
Other related documentation is available from New Era of Networks, Sybase, and IBM. Refer to other documentation from each of these companies for more detail about use of applications relevant to this product.
To access the Technical Library Product Manuals Web site, go to Product Manuals at http://www.sybase.com/support/manuals.
Use the Sybase Getting Started CD, the SyBooks Bookshelf CD, and the Sybase Product Manuals web site to learn more about your product:
The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the SyBooks Bookshelf CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks Bookshelf CD is included with your software. It contains product manuals in a platform-independent bookshelf that contains fully searchable, HTML-based documentation.
Some documentation is provided in PDF format, which you can access through the PDF directory on the SyBooks Bookshelf CD. To view the PDF files, you need Adobe Acrobat Reader.
Refer to the README.txt file on the SyBooks Bookshelf CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is the online version of the SyBooks Bookshelf CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.
To access the Product Manuals Web site, go to Product Manuals.
Finding the latest information on EBFs and software
maintenance
Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBF/Maintenance releases is displayed.
Padlock icons indicate that you do not have download authorization for certain EBF/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.
The following formatting conventions are used in this manual:
Formatting example |
To indicate |
|---|---|
command names and method names |
When used in descriptive text, this font indicates keywords such as:
|
myCounter variable
myfile.txt User Guide |
Italic font indicates:
|
sybase/bin |
Directory names appearing in text display in lowercase unless the system is case sensitive. A forward slash (“/”) indicates generic directory information. A backslash (“\”) applies to Windows users only. |
“About This Book” |
Chapter titles have initial caps and are enclosed within quotation marks. |
File > Save |
Menu names and menu items are displayed in plain text. The angle bracket indicates how to navigate menu selections, such as from the File menu to the Save option. |
|
The vertical bar indicates you may select only one of the options shown in the code. |
|
Monospace font indicates:
|
Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.
