bea.com | products | dev2dev | support | askBEA |
|
e-docs > WebLogic Platform > WebLogic Integration > AI Topics > Developing Adapters > Creating a Custom Development Environment |
Developing Adapters |
Creating a Custom Development Environment
Warning: We strongly recommend that you do not alter the sample adapter directly. Instead, use the GenerateAdapterTemplate utility described in this chapter to make a copy of the adapter, and then make any changes you want to your copy. Modifying the sample adapter itself (or trying to create a copy of it without using GenerateAdapterTemplate) might result in unexpected and unsupported behavior.
To facilitate the use of the sample adapter (see Sample Adapter), the ADK provides GenerateAdapterTemplate, a command-line utility you can use to create a new adapter development tree by cloning the sample tree.
This section provides information about the following subjects:
Adapter Setup Worksheet
The adapter setup worksheet is a questionnaire designed to help you identify and collect critical information about the adapter you are developing. You can find this questionnaire in Adapter Setup Worksheet.
This worksheet is a set of 20 questions that can help you identify critical adapter information, such as EIS type, vendor, and version, locale and national language of the deployment, the adapter logical name, and whether or not the adapter supports services. When you run GenerateAdapterTemplate, you are prompted to enter this information. When the information is processed, a custom development tree for your adapter is created.
Using GenerateAdapterTemplate
This section explains how to use GenerateAdapterTemplate. You must perform the following steps:
Step 1. Execute GenerateAdapterTemplate
To use this tool, do the following:
The system responds:
WLI_HOME/adapters/utils>generateadaptertemplate
***************************************************************
Welcome! This program helps you generate a new adapter
development tree by cloning the ADK's sample adapter development
tree.
Do you wish to continue? (yes or no); default='yes':
The system responds:
The following information will be used to generate your new
adapter development environment:
EIS Type = 'SAP R/3'
Description = 'description'
Major Version = '1'
Minor Version = '0'
Vendor = 'vendor_name'
Adapter Logical Name = 'adapter_logical_name'
Java Package Base = 'com.java.package.base'
Are you satisfied with these values? (enter yes or no or q to quit);
default='yes':
Step 1a. Specify the Console Codepage (Windows Only)
For Windows systems only, select your console's codepage value from the following codepage list:
437 - United States
850 - Multilingual (Latin I)
852 - Slavic (Latin II)
855 - Cyrillic (Russian)
857 - Turkish
860 - Portuguese
861 - Icelandic
863 - Canadian-French
865 - Nordic
866 - Russian
869 - Modern Greek
Enter your console's codepage; default='437':
If you do not know your codepage, entert chcp at your console prompt. Depending on the Windows version, this command displays your console's codepage value.
Step 2. Rebuild the Tree
After completing the clone process, go to the new directory and use Ant, the ADK's build tool, to rebuild the entire tree. For more information about Ant, see Ant-Based Build Process.
To rebuild the tree by using Ant, do the following:
When you execute ant release, Javadoc is generated for the adapter. You can view the Javadoc by going to:
WLI_HOME/adapters/ADAPTER/docs/
This file provides environment-specific instructions for deploying your adapter in a WebLogic Integration environment. Specifically, it provides config.xml entries and replacements for the path already created. In addition, the file provides mapping information.
To facilitate adapter deployment, as described in Step 3. Deploy the Adapter to WebLogic Integration, you can copy the contents of overview.html directly into config.xml.
Step 3. Deploy the Adapter to WebLogic Integration
You can deploy the adapter either manually or from the WebLogic Server Administration Console. See Deploying Adapters, for complete information.