Corporate Info | News | Solutions | Products | Partners | Services | Events | Download | How To Buy
eLink Adapter Development Kit Doc Home | Previous Topic | Next Topic | Contents |

Installing the eLink ADK and Sample Adapters

This chapter discusses the following topics:

- What is Included in the eLink ADK

  - Include Files and Libraries

  - The Sample Application to eLink Adapter

  - The Sample eLink to Application Adapter

  - The Sample E-Mail Adapter

- Installing the eLink Adapter Development Kit

  - Installing on the Windows NT Platform

  - Installing on the HP-UX, AIX, Solaris, and Compaq TRU64 UNIX Platforms

What is Included in the eLink ADK

Your eLink Adapter Development Kit is shipped with include files, shared libraries, and sample application to eLink and eLink to application adapters.

Note: In order to use the ADK you need a license for both the eLink Platform and the ADK. The license files are delivered on a floppy disk and should have accompanied your order of the eLink Platform and ADK. Refer to "Preparing the License File" on page 2-11 for more information about the license file.

Include Files and Libraries

In addition to the required include files (.H); the development kit includes shared libraries, (.sl) for HP-UX 10.20 and 11.0, (.so) for Solaris 2.6 and AIX 4.3.x; and a dynamic link library (.dll) and import library (.lib) for Windows NT. The .dll is compiled with Microsoft VC++ v5.x. While the .dll may be used with any Windows development platform, the import library is specific to the Microsoft compiler.

Note: The HP 10.20 operating system is not supported for this release of the Sample E-Mail Adapter because the SMTP library does not support HP 10.20.

####

Table 4-1 Shipping List for ADK Include Files and Libraries

File | Description
--- | ---
adkdemo\adkdemo.text | Sample message catalogue
include\adkfns.h | Include file for both NT and Unix
include\adklog.h | Include file for both NT and Unix
include\adktypes.h | Include file for both NT and Unix
include\fmlfns.h | Include file for both NT and Unix
bin\libadk.dll | Dynamic link library for Windows NT
lib\libadk.lib | Import library for Windows NT
lib\libadk.sl | Shared library for HP 10.20 or 11.00
lib\libadk.so | Shared library for Solaris 2.6 or 7 or Compaq Tru64 UNIX 5.0
lib\libadk.a | Shared library for AIX 4.3
lib\libsmtp.sl | Shared SMTP library for HP 11.00
lib\libsmtp.so | Shared SMTP library for Solaris 2.6. or 7 or Compaq Tru64 UNIX 5.0
lib\libsmtp_shr.a | Shared SMTP library for AIX 4.3
lib\libcomm.so | Communication protocol library for Solaris 2.6. or 7 or Compaq Tru64 UNIX 5.0
lib\libcomm_shr.a | Communication protocol library for AIX 4.3
lib\libcomm.sl | Communication protocol library for HP 11.00
lib\libcomm.dll | Communication protocol dynamic link library for Windows NT
lib\libcomm.lib | Communication protocol library for Windows NT

The Sample Application to eLink Adapter

The sample application to eLink adapter contains code to generate the application to eLink adapter program, which is a Tuxedo server. The sample application to eLink adapter also contains a demo server program that can be used to test the adapter. The application to eLink adapter also includes a sample UBB file, as well as .bat and .SCR files to set up the environment. Since the .lib files included with Tuxedo are specific to the MS VC++ compiler, and BUILDSERVER and BUILDCLIENT default to calling the command line version of the MS compiler (CL), the .bat files were created for use with the MS compiler.

####

Table 4-2 Shipping List for Sample Application to eLink Adapter Components

File | Description
--- | ---
adkdemo\inbound\elinkdi.mak | .MAK file for Unix
adkdemo\inbound\inbound.c | Source code for the demo application to eLink server program for Unix
adkdemo\inbound\input.txt | File containing requests
adkdemo\inbound\README | README file for Sample Application to eLink Adapter
adkdemo\inbound\SETENV.BAT | Sets the various environment variables required by Tuxedo for NT
adkdemo\inbound\setenv.sh | Sets the various environment variables required by Tuxedo for Unix
adkdemo\inbound\simpserv.c | Source code for the Tuxedo server program
adkdemo\inbound\table.fml | FML32 table
adkdemo\inbound\ubb.inbound | UBBCONFIG file

The Sample eLink to Application Adapter

The sample eLink to application adapter contains code to generate demo server and client programs, sample .UBB and .CFG files, as well as .bat and .SCR files to set up the environment and automate the build process. Since the .lib files included with Tuxedo are specific to the MS VC++ compiler, and BUILDSERVER and BUILDCLIENT default to calling the command line version of the MS compiler (CL), the .bat files were created for use with the MS compiler.

####

Table 4-3 Shipping List for Sample eLink to Application Adapter Components

File | Description
--- | ---
adkdemo\outbound\ADKDEMO.C | Source code for the demo server program
adkdemo\outbound\ADKDEMO.CFG | CFG file
adkdemo\outbound\ADKDEMO.H | Source code for the demo server program
adkdemo\outbound\ADKDEMO.UBB | UBB file for NT
adkdemo\outbound\ADKDEMOX.UBB | UBB file for Unix
adkdemo\outbound\CONFIG.C | Routines to verify and load CFG file
adkdemo\outbound\CONFIG.H | Routines to verify and load CFG file
adkdemo\outbound\democlient.C | Source code for the demo client program
adkdemo\outbound\elinkdo.mak | .MAK file for Unix
adkdemo\outbound\FOOFNS.C | String handling functions to simulate the calling of an outside API
adkdemo\outbound\FOOFNS.H | String handling functions to simulate the calling of an outside API
adkdemo\outbound\makeclient.BAT | Makes the demo client program
adkdemo\outbound\makeclient.SCR | Makes the demo client program
adkdemo\outbound\makeserver.BAT | Makes the demo server program
adkdemo\outbound\makeserver.SCR | Makes the demo server program
adkdemo\outbound\README | README file for Sample eLink to Application Adapter
adkdemo\outbound\SETADK.BAT | Sets the various environment variables required by Tuxedo
adkdemo\outbound\SETADK.SCR | Sets the various environment variables required by Tuxedo

The Sample E-Mail Adapter

The sample E-Mail Adapter contains code to generate demo E-Mail server and client programs. This adapter is an eLink to Application adapter.

####

Table 4-4 Shipping List for Sample E-Mail Adapter

File | Description
--- | ---
adkdemo\email\config.c | Routines to verify and load CFG file
adkdemo\email\config.h | Routines to verify and load CFG file
adkdemo\email\emailclient.c | Source code for the email client program
adkdemo\email\emailserver.c | Source code for the email server program
adkdemo\email\emailserver.cfg | Configuration file for the server
adkdemo\email\emailserver.h | Header file for the email server program
adkdemo\email\emaildemo.ubb | UBB file for NT
adkdemo\email\emaildemox.ubb | UBB file for UNIX
adkdemo\email\emaildemo.mak | .MAK file for UNIX
adkdemo\email\emailtools.c | Source code used to configure and send email
adkdemo\email\emailtools.h | Header file for emailtools
adkdemo\email\email.cfg | Email configuration file (used with -f option)
adkdemo\email\emailmessage.txt | Sample email message to send
adkdemo\email\makeclient.bat | Makes the email client program (NT)
adkdemo\email\makeclient.scr | Makes the email client program (UNIX)
adkdemo\email\makeserver.bat | Makes the email server program (NT)
adkdemo\email\makeserver.bat | Makes the email server program (UNIX)
adkdemo\email\README.DEMO | README file for Sample Email Adapter
adkdemo\email\setadk.bat | Sets the various environment variables required by Tuxedo (NT)
adkdemo\email\setadk.scr | Sets the various environment variables required by Tuxedo (UNIX)

Installing the eLink Adapter Development Kit

BEA-branded adapters must be buildable on all supported eLink Platform operating systems. HP-UX 11.00 platforms use the standard HP C compiler and NT platforms use the MS VC++ v5.x command line compiler.

Complete the following tasks prior to installing the eLink Adapter Development Kit:

- Read the eLink Adapter Development Kit Release Notes.

- Install and verify the operation of the BEA Tuxedo product. Refer to the Special Instructions for Installing the Tuxedo Core section of this guide for installation tips and the BEA Tuxedo Installation Guide at http://edocs.beasys.com/tuxedo/tux65/index.htm for more information.

Installing on the Windows NT Platform

The eLink Adapter Development Kit software is available only for Version 4.0 of the Windows NT platform.

Perform the following steps to install the eLink ADK software on a Windows NT system:

1. Insert the product CD-ROM and click the Run option from the Start menu. The Run window displays. Click the Browse button to select the CD-ROM drive. Select the winnt directory and select the Setup.exe program. Click OK to run the executable and begin the installation. The Welcome window displays as shown in Figure 4-1. Click Next to continue with the installation.

   Figure 4-1 Welcome Window

2. The License Agreement window displays as shown in Figure 4-2. Read the license agreement information, and click Yes to continue with the installation.

   Figure 4-2 License Agreement Window

3. The User Information window displays as shown in Figure 4-3. Enter your name in the Name field. Enter the name of your company in the Company field. Click Next to continue with the installation.

   Figure 4-3 User Information Window

4. After you click Next, the Select License File Source Directory window displays as shown in Figure 4-4.

   1. Enter the Directory and Path or click the Browse button to display the Choose Folder pop-up window as shown in Figure 4-5

      Figure 4-4 Select License File Source Directory Window

   2. If you clicked Browse, locate the License file and click OK to return to the Select License File Source Directory window. Then click Next to continue with the installation process.

      Figure 4-5 Choose Folder Pop-up Window

5. If,

   Tuxedo is already installed on your system,
   The installation begins and a progress bar displays the status. The eLink ADK components install into the Tuxedo directory. You may abort the installation process anytime prior to completion by clicking the Cancel button.

   When the installation completes, the Setup Complete window shown in Figure 4-7 notifies you that the eLink ADK software is installed on your system.

   Warning: If Windows NT is your execution environment, BEA TUXEDO should be installed first and the eLink ADK should be installed within the same directory. If you install the eLink ADK outside of the Tuxedo directory, you will need to copy the files into the Tuxedo directory for processing of data mapping service requests.Click Yes to continue the installation or No to quit.

   Tuxedo is NOT already installed on your system,
   The Error pop-up window displays as shown in Figure 4-6. Click OK on the pop-up window to terminate the installation process. Install Tuxedo 6.5 on your system (see warning above). Reinitiate the installation process starting with step one of these installation instructions.

   Figure 4-6 Tuxedo 6.5 Installation Error Pop-Up Window

6. The Setup Complete window notifies you that the eLink ADK software is installed on your system. Click Finish to complete the setup process.

   Figure 4-7 Setup Complete

Installing on the HP-UX, AIX, Solaris, and Compaq TRU64 UNIX Platforms

This section explains how to install the eLink Adapter Development Kit software on the following execution platforms.

- HP-UX 10.20 or 11.00

- AIX v4.3.x

- SUN Solaris 2.6 or 7

- Compaq Tru64 UNIX 5.0

  Warning: You must install the eLink ADK execution components within the eLink Platform directory.

To install the eLink ADK software, you run the install.sh script. This script installs all the necessary software components.

Perform the following steps to install the eLink ADK software on a supported Unix platform:

1. Log on as root to install the eLink ADK software.

   >     $ su -
   >     Password:

2. Access the CD-ROM device.

   >     # ls -1 /dev/cdrom

   >     total 0

   >     brw-rw-rw-     1 root     sys     22,   0 January 5 10:55 c1b0t010

3. Mount the CD-ROM.

   >     # mount -r -F cdfs /dev/cdrom/c1b0t0l0 /mnt

4. Change the directory to your CD-ROM device.

   >     # cd /mnt

5. List the CD-ROM contents.

   >     # ls

   >     install.sh  hp

6. Execute the installation script.

   >     # sh ./install.sh

7. The installation script runs and prompts you for responses.

   Listing 4-1 Install.sh Script Prompts

   >     cmadm@dalhpw1:/cmhome/dist/balkan-1> ls
   >     alpha/       hp/          ibm/         install.sh*  sun5x/       winnt/
   >     cmadm@dalhpw1:/cmhome/dist/balkan-1> sh install.sh

   >     01) alpha/tru64      02) hp/hpux1020      03) hp/hpux11
   >     04) ibm/aix43        05) sun5x/sol26      06) sun5x/sol7

   >     Install which platform's files? [01-6, q to quit, l for list]: 2

   >     ** You have chosen to install from hp/hpux1020 **

   >     BEA eLink Adapter Development Kit Release 1.1

   >     This directory contains the BEA eLink Adapter Development Kit System for
   >     HP-UX 10.20 on 9000/800 series.

   >     Is this correct? [y,n,q]: y

   >     To terminate the installation at any time
   >     press the interrupt key,
   >     typically <del>, <break>, or <ctrl+c>.

   >     The following packages are available:

   >       1     adk             BEA eLink Adapter Development Kit

   >     Select the package(s) you wish to install (or 'all' to install
   >     all packages) (default: all) [?,??,q]:

   >     BEA eLink Adapter Development Kit
   >     (9000) Release 1.1
   >     Copyright (c) 2000 BEA Systems, Inc.
   >     All Rights Reserved.
   >     Distributed under license by BEA Systems, Inc.
   >     BEA eLink is a trademark of BEA Systems, Inc.

   >     Directory where ADK Adapter files are to be installed
   >     (Enter your Tuxedo directory path) [?,q]: /work/cmadm/tux65

   >     Using /work/cmadm/tux65 as the ADK Adapter base directory

   >     Determining if sufficient space is available ...
   >     528 blocks are required
   >     3783706 blocks are available to /work/cmadm/tux65

   >     Unloading /cmhome/dist/balkan-1/hp/hpux1020/adk/ADKT65.Z ...
   >     adkdemo/adkdemo.text
   >     adkdemo/email/README.DEMO
   >     adkdemo/email/adkdemo.text
   >     adkdemo/email/config.c
   >     adkdemo/email/config.h
   >     adkdemo/email/email.cfg
   >     adkdemo/email/emailclient.c
   >     adkdemo/email/emaildemo.mak
   >     adkdemo/email/emaildemox.ubb
   >     adkdemo/email/emailmessage.txt
   >     adkdemo/email/emailserver.c
   >     adkdemo/email/emailserver.cfg
   >     adkdemo/email/emailserver.h
   >     adkdemo/email/emailtools.h
   >     adkdemo/email/makeclient.scr
   >     adkdemo/email/makeserver.scr
   >     adkdemo/email/setadk.scr
   >     adkdemo/inbound/elinkdi.mak
   >     adkdemo/inbound/inbound.c
   >     adkdemo/inbound/input.txt
   >     adkdemo/inbound/readme
   >     adkdemo/inbound/setenv.sh
   >     adkdemo/inbound/simpserv.c
   >     adkdemo/inbound/table.fml
   >     adkdemo/inbound/ubb.inbound
   >     adkdemo/outbound/adkdemo.c
   >     adkdemo/outbound/adkdemo.cfg
   >     adkdemo/outbound/adkdemo.h
   >     adkdemo/outbound/adkdemox.ubb
   >     adkdemo/outbound/config.c
   >     adkdemo/outbound/config.h
   >     adkdemo/outbound/democlient.c
   >     adkdemo/outbound/elinkdo.mak
   >     adkdemo/outbound/foofns.c
   >     adkdemo/outbound/foofns.h
   >     adkdemo/outbound/makeclient.scr
   >     adkdemo/outbound/makeserver.scr
   >     adkdemo/outbound/readme.demo
   >     adkdemo/outbound/setadk.scr
   >     bin/lic.sh
   >     include/adkfns.h
   >     include/adklog.h
   >     include/adktypes.h
   >     include/fmlfns.h
   >     lib/libadk.sl.1.10
   >     lib/libcomm.sl
   >     lib/libsmtp.sl
   >     490 blocks
   >     ... finished

   >     Changing file permissions...
   >     ... finished

   >     If your license file is accessible, you may install it now.
   >     Install license file? [y/n]: n

   >     Please don't forget to use lic.sh located in your product bin directory
   >     to install the license file from the enclosed floppy.
   >     Refer to your product Release Notes for details on how to do this.

   >     Installation of BEA eLink Adapter Development Kit was successful

   >     Please don't forget to fill out and send in your registration card
   >     cmadm@dalhpw1:/cmhome/dist/balkan-1>

Copyright © 2000 BEA Systems, Inc. All rights reserved. Required browser: Netscape 4.0 or higher, or Microsoft Internet Explorer 4.0 or higher.