Skip Headers
Oracle® Application Server Adapter Installation Guide
10g Release 2 (10.1.2)
B14063-04
  Go To Documentation Library
Home
Go To Product List
Solution Area
Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
Next
Next
 

A EIS Adapter Plugin

This appendix provides an overview of how to use OracleAS Integration InterConnect Enterprise Information Systems (EIS) Adapter Plugin. It contains the following topics:

EIS Adapter Plugin Overview

In conjunction with Oracle adapters, EIS Adapter Plugin enables you to integrate any EIS application with other applications that use OracleAS Integration InterConnect. EIS Adapter Plugin is useful in all Enterprise Application Integration (EAI) scenarios involving packaged applications such as SAP and PeopleSoft. EAI is the integration of applications and business processes within the same company.

This appendix explains all the necessary installation-related concepts of EIS Adapter Plugin.

EIS Adapter Plugin System Requirements

The following sections describe EIS Adapter Plugin system requirements:

Hardware Requirements

Table A-1 lists the hardware requirements for the computer where EIS Adapter Plugin will be installed.

Table A-1 Hardware Requirements

Hardware Windows 2000 UNIX

Disk Space

500 MB

500 MB

Memory

128 MB

128 MB


Software Requirements

The following sections describe EIS Adapter Plugin software requirements:

Operating System Requirements

Table A-2 lists the operating system requirements for the computer where EIS Adapter Plugin will be installed.

Table A-2 Operating System Requirements

Operating System Version

HP Tru64

HP Tru64 UNIX (Alpha) 5.1b

HP-UX

HP-UX (PA-RISC) 11.11, 11.23

IBM AIX

AIX (POWER) version 5.2

Linux (x86)

Red Hat Enterprise Linux 2.1, 3.0

SuSE SLES8, SLES9

Sun SPARC Solaris

Sun SPARC Solaris 2.8 and 2.9

Microsoft Windows

Windows XP Professional, Windows 2000( SP3 or higher)


JRE Requirements

OracleAS Integration InterConnect uses Java Runtime Environment (JRE) 1.4, which is installed with its components.

EIS Adapter Plugin Installation

EIS Adapter Plugin must be installed in an existing Oracle home Middle Tier for OracleAS Integration InterConnect 10g Release 2 (10.1.2).

This section contains the following topics:

Preinstallation Tasks

Refer to the following guides before installing EIS Adapter Plugin:

  • Oracle Application Server Installation Guide for information about OUI startup

  • Oracle Application Server InterConnect Installation Guide for information about mounting CD-ROMs, software, hardware, and system requirements for OracleAS Integration InterConnect

Installation Tasks

To install EIS Adapter Plugin:

  1. Select EIS Adapter Plugin on the Available Product Components page of the OracleAS Integration InterConnect installation, and click Next. If the Oracle home does not have an existing InterConnect component installation, the Set Oracle Wallet Password screen is displayed. If the Oracle home has an existing InterConnect component installation, the Specify Oracle Wallet Password screen is displayed.

  2. Enter and confirm the password on the screen, which will be used to administer OracleAS Integration InterConnect installation. Click Next.

    • Go to step 3, if installing EIS Adapter Plugin in an OracleAS Middle Tier Oracle home that does not have an InterConnect component already installed. Ensure that the OracleAS Integration InterConnect hub has been installed.

    • Go to step 4, if installing EIS Adapter Plugin in an OracleAS Middle Tier Oracle home that has an existing InterConnect component. Ensure that it is a home directory to an OracleAS Integration InterConnect component.

  3. The Specify Hub Database Connection screen is displayed. Enter information in the following fields:

    • Host Name: The host name of the computer where the hub database is installed.

    • Port Number: The TNS listener port for the hub database.

    • Database SID: The System Identifier (SID) for the hub database.

    • Password: The user password for the hub database user.

  4. Click Next. The Specify EIS Adapter Plugin Name page is displayed.

  5. Enter the application name. Blank spaces are not permitted. The default value is myEISApp.

  6. Click Next. The Configure URL page is displayed. Enter the complete URL used to connect to the OracleAS Integration Adapters's Business Services Engine.

  7. Click Next. The Summary page is displayed.

  8. Click Install to install EIS Adapter Plugin and other selected components. EIS Adapter Plugin is installed in the following directory:

    Platform Directory
    Windows ORACLE_HOME\integration\interconnect\adapters\Application
    UNIX ORACLE_HOME/integration/interconnect/adapters/Application

    Application is the value specified in Step 5.

  9. Click Exit on the Installation page to exit EIS Adapter Plugin installation.

EIS Adapter Plugin Configuration

After an EIS Adapter Plugin installation, you can configure it according to your requirements. The following tables describe the location and details of the configuration files.

Table A-3 describes the location where the adapter is installed:

Table A-3 EIS Adapter Plugin Adapter Directory

Platform Directory

UNIX

ORACLE_HOME/integration/interconnect/adapters/Application

Windows

ORACLE_HOME\integration\interconnect\adapters\Application


Table A-4 describes the various executable files of EIS Adapter Plugin.

Table A-4 Executable Files

File Description

start (UNIX)

Does not use parameters, starts the adapter.

start.bat (Windows)

Does not use parameters, starts the adapter.

stop (UNIX)

Does not use parameters, stops the adapter.

stop.bat (Windows)

Does not use parameters, stops the adapter.


Table A-5 describes EIS Adapter Plugin configuration files.

Table A-5 Configuration Files

File Description

adapter.ini (UNIX)

Contains all the initialization parameters, which the adapter reads at startup.

adapter.ini (Windows)

Contains all the initialization parameters, which the adapter reads at startup.


Table A-6 describes the directories used by EIS Adapter Plugin.

Table A-6 Directories

File Description

logs

The adapter activity is logged in subdirectories of the logs directory. Each time the adapter is run, a new subdirectory is created for the oailog.txt log file.

persistence

The messages are persisted in this directory. Do not edit this directory or its files.


Using the Application Parameter

Adapters do not have integration logic. EIS Adapter Plugin has a generic transformation engine that processes metadata from the repository as runtime instructions to perform transformations. The application parameter defines the capabilities of an adapter, such as the messages to be published and subscribed, and the transformations to be performed. The application parameter allows the adapter to retrieve only the relevant metadata from the repository. The application parameter must match the corresponding application that will be defined in iStudio, under the Applications folder.

If you use prepackaged metadata, then import it into the repository and start iStudio to find the corresponding application under the Applications folder. You can use this as the application name for the adapter you are installing.


See Also:

Step 4

Ini File Settings

The following are the .ini files used to configure EIS Adapter Plugin:

hub.ini File

EIS Adapter Plugin connects to the hub database using parameters in the hub.ini file located in the hub directory. Table A-7 lists the parameters, their description, and an example for each parameter.

Table A-7 hub.ini Parameters

Parameters Description Example

hub_host

The name of the computer hosting the hub database. There is no default value. The value is set during installation.

hub_host=mpscottpc

hub_instance

The SID of the hub database. There is no default value. The value is set during installation.

hub_instance=orcl

hub_port

The TNS listener port number for the hub database instance. There is no default value. The value is set during installation.

hub_port=1521

hub_username

The name of the hub database schema (or user name). There is no default value.

hub_username=myhub

repository_name

The name of the repository that communicates with the adapter. The default value is InterConnectRepository.

repository_name=InterConnectRepository


Oracle Real Application Clusters hub.ini Parameters

For a hub installed on an Oracle Real Application Clusters database, the parameters listed in Table A-8 represent information on additional nodes used for connection and configuration. These parameters are in addition to the default parameters for the primary node. In Table A-8, x represents the node number, which can take a value between 2 and the number of nodes. For example, if the cluster contains 4 nodes, x can be a value between 2 and 4.

Table A-8 Real Application Clusters hub.ini Parameters

Parameter Description Example

hub_hostx

The host where the Real Application Clusters database is installed.

hub_host2=dscott13

hub_instancex

The instance on the respective node

hub_instance2=orcl2

hub_num_nodes

The number of nodes in a cluster.

hub_num_nodes=4

hub_portx

The port where the TNS listener is listening.

hub_port2=1521


adapter.ini File

EIS Adapter Plugin connects to the spoke application using parameters from the adapter.ini file. Table A-9 lists the parameters, their description, and an example for each parameter.

Table A-9 adapter.ini Parameters

Parameter Description Example

agent_admin_port

Specifies the port through which the adapter can be accessed through firewalls.

Possible Value: A valid port number.

Default Value: None.

agent_admin_port=1059

agent_delete_file_cache_at_startup

Specifies whether to delete the cached metadata during startup. If any agent caching method is enabled, then metadata from the repository is cached locally on the file system. Set the parameter to true to delete all cached metadata on startup.

Possible Values: true or false.

Default Value: false.

Note: After changing metadata or DVM tables for the adapter in iStudio, you must delete the cache to guarantee access to new metadata or table information.

agent_delete_file_cache_at_startup=false

agent_dvm_table_caching

Specifies the Domain Value Mapping (DVM) table caching algorithm.

Possible values:

  • startup: Cache all DVM tables at startup. This may be time-consuming if there are many tables in the repository.

  • demand: Cache tables as they are used.

  • none: No caching. This slows down performance.

Default Value: demand.

agent_dvm_table_caching=demand

agent_log_level

Specifies the amount of logging necessary.

Possible values:

0=errors only

1=status and errors

2=trace, status, and errors

Default Value: 1

agent_log_level=2

agent_lookup_table_caching

Specifies the lookup table caching algorithm.

Possible values:

  • startup: Cache all lookup tables at startup. This may be time-consuming if there are many tables in the repository.

  • demand: Cache tables as they are used.

  • none: No caching. This slows down performance.

Default Value: demand.

agent_lookup_table_caching=demand

agent_max_ao_cache_size

Specifies the maximum number of application object metadata to cache.

Possible Value: An integer greater than or equal to 1.

Default Value: 200.

agent_max_ao_cache_size=200

agent_max_co_cache_size

Specifies the maximum number of common object metadata to cache.

Possible Value: An integer greater than or equal to 1.

Default Value: 100.

agent_max_co_cache_size=100

agent_max_dvm_table_cache_size

Specifies the maximum number of DVM tables to cache.

Possible Value: An integer greater than or equal to 1.

Default Value: 200.

agent_max_dvm_table_cache_size=200

agent_max_lookup_table_cache_size

Specifies the maximum number of lookup tables to cache.

Possible Value: Any integer greater than or equal to 1.

Default Value: 200.

agent_max_lookup_table_cache_size=200

agent_max_message_metadata_cache_size

Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache.

Possible Value: An integer greater than or equal to 1.

Default Value: 200.

agent_max_message_metadata_cache_size=200

agent_max_queue_size

Specifies the maximum size that the internal OracleAS Integration InterConnect message queues can grow.

Possible Value: An integer greater than or equal to 1.

Default Value: 1000.

agent_max_queue_size=1000

agent_message_selector

Specifies conditions for message selection when the adapter registers its subscription with the hub.

Possible Value: A valid Oracle Advanced Queue message selector string (such as %,aqapp,and %).

Default Value: None.

agent_message_selector=%,aqapp,%

agent_metadata_caching

Specifies the metadata caching algorithm.

Possible values:

  • startup: Cache everything at startup. This may be time-consuming if there are many tables in the repository.

  • demand: Cache metadata as it is used.

  • none: No caching. This slows down performance.

Default Value: demand.

agent_metadata_caching=demand

agent_persistence_cleanup_interval

Specifies how often to run the persistence cleaner thread, in milliseconds.

Possible Value: An integer greater than or equal to 30000 milliseconds.

Default Value: 60000.

agent_persistence_cleanup_interval=60000

agent_persistence_queue_size

Specifies the maximum size of internal OracleAS Integration InterConnect persistence queues.

Possible Value: An integer greater than or equal to 1.

Default Value: 1000.

agent_persistence_queue_size=1000

agent_persistence_retry_interval

Specifies how often the persistence thread retries when it fails to send an OracleAS Integration InterConnect message.

Possible Value: An integer greater than or equal to 5000 milliseconds.

Default Value: 60000.

agent_persistence_retry_interval=60000

agent_pipeline_from_hub

Specifies whether to turn on the pipeline for messages from the hub to the bridge. If you set the pipeline to false, then file persistence is not used in that direction.

Possible Value: true, false.

Default Value: false.

agent_pipeline_from_hub=false

agent_pipeline_to_hub

Specifies whether to turn on the pipeline for messages from the bridge to the hub. If you set the pipeline to false, then file persistence is not used in that direction.

Possible Value: true, false.

Default Value: false.

agent_pipeline_to_hub=false

agent_reply_message_selector

Specifies the application instance to which the reply must be sent. This parameter is used if multiple adapter instances exist for the given application and given partition.

Possible Value: A string built using the application name (parameter:application) concatenated with the instance number (parameter:instance_number).

Default Value: None.

If application=aqapp, instance_number=2, then agent_reply_message_selector=recipient_list like '%,aqapp2,%'

agent_reply_subscriber_name

Specifies the subscriber name used when multiple adapter instances are used for the given application and given partition. This parameter is optional if only one instance is running.

Possible Value: The application name (parameter:application) concatenated with the instance number (parameter:instance_number).

Default Value: None.

If application=aqapp and instance_number=2, then agent_reply_subscriber_name=aqapp2

agent_subscriber_name

Specifies the subscriber name used when this adapter registers its subscription.

Possible Value: A valid Oracle Advanced Queue subscriber name.

Default Value: None.

agent_subscriber_name=aqapp

agent_throughput_measurement_enabled

Specifies if the throughput measurement is enabled. Set this parameter to true to turn on throughput measurements.

Possible Value: true or false.

Default Value: true.

agent_throughput_measurement_enabled=true

agent_tracking_enabled

Specifies if message tracking is enabled. Set this parameter to false to turn off tracking of messages. Set this parameter to true to track messages with tracking fields set in iStudio.

Possible Value: true or false.

Default Value: true.

agent_tracking_enabled=true

agent_use_custom_hub_dtd

Specifies whether to use a custom DTD for the common view message when handing it to the hub. By default, adapters use a specific OracleAS Integration InterConnect DTD for all messages sent to the hub.

Set this parameter to true to have the adapter use the DTD imported for the message of the common view instead of the OracleAS Integration InterConnect DTD.

Default Value: None.

agent_use_custom_hub_dtd=false

application

Specifies the name of the application to which this adapter connects. This must match the name specified in iStudio while creating metadata.

Possible Value: An alphanumeric string.

Default Value: None.

application=aqapp

encoding

Specifies the character encoding for published messages. The adapter uses this parameter to generate encoding information for the encoding tag of transformed OracleAS Integration InterConnect messages. OracleAS Integration InterConnect represents messages internally as XML documents.

Possible Value: A valid character encoding.

Default Value: UTF-8.

When there is no existing encoding in the subscribed message, this parameter will be used to explicitly specify the encoding of the published message. This parameter will be ignored when the encoding already exists in the subscribed message.

encoding=Shift_JIS

external_dtd_base_url

Specifies the base URL for loading external enitites and DTDs.This instructs the XML parser to resolve the external entities in the instance document using the given URL.

Possible Value: A URL.

Default Value: The URL of the current user directory.

external_dtd_base_url=file://C:\InterConnect10_1_2\adapters\AQApp\

instance_number

Specifies the instance number to which this adapter corresponds. Specify a value only if you have multiple adapter instances for the given application with the given partition.

Possible Value: An integer greater than or equal to 1.

Default Value: None.

instance_number=1

nls_country

Specifies the ISO country code. The codes are defined by ISO-3166.

Possible Value: A valid code. A full list of the codes is available at http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html

Default Value: US.

Note: This parameter specifies date format and is applicable for the date format only.

nls_country=US

nls_date_format

Specifies the format for a date field expressed as a string.

Possible Value: A valid date format pattern as shown in Table A-10 for the definitions of the format characters.

Default Value: EEE MMM dd HHmmss zzz yyyy.

Date format pattern dd/MMM/yyyy can represent 01/01/2003.

nls_date_format=dd-MMM-yy

Multiple date formats can be specified as num_nls_formats=2

nls_date_format1=dd-MMM-yy

nls_date_format2=dd/MMM/yy

nls_language

Specifies the ISO language code. The codes are defined by ISO-639.

Possible Value: A valid code. A full list of these codes is available at http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt

Default Value: en.

Note: This parameter specifies the date format and is applicable for the date format only.

nls_language=en

partition

Specifies the partition this adapter handles in iStudio.

Possible Value: An alphanumeric string.

Default Value: None.

partition=germany

service_class

Specifies the entry class for the Windows service.

Possible Value: oracle/oai/agent/service/AgentService.

Default Value: None.

service_class=oracle/oai/agent/service/AgentService

service_classpath

Specifies the class path used by the adapter Java Virtual Machine (JVM). If a custom adapter is developed and the adapter is to pick up any additional jar files, then add the files to the existing set of jar files.

Possible Value: A valid PATH setting.

Default Value: None.

This parameter is for Microsoft Windows only.

service_classpath=D:\oracle\oraic\integration\interconnect\lib\oai.jar; D:\oracle\oraic\jdbc\classes12.zip

service_jdk_dll

Specifies the Dynamic Link Library(DLL) that the adapter JVM should use.

Possible Value: A valid jvm.dll.

Default Value: jvm.dll.

This parameter is for Microsoft Windows only.

service_jdk_dll=jvm.dll

service_jdk_version

Specifies the JDK version that the adapter JVM should use.

Possible Value: A valid JDK version number.

Default Value: 1.4

This parameter is for Microsoft Windows only.

service_jdk_version=1.4

service_max_heap_size

Specifies the maximum heap size for the adapter JVM.

Possible Value: A valid JVM heap size.

Default Value: 536870912.

This parameter is for Microsoft Windows only.

service_max_heap_size=536870912

service_max_java_stack_size

Specifies the maximum size the JVM stack can grow.

Possible Value: A valid JVM maximum stack size.

Default Value: Default value for the JVM.

This parameter is for Microsoft Windows only.

service_max_java_stack_size=409600

service_max_native_stack_size

Specifies the maximum size the JVM native stack can grow.

Possible Value: The valid JVM maximum native stack size.

Default Value: Default value for the JVM.

This parameter is for Microsoft Windows only.

service_max_native_size=131072

service_min_heap_size

Specifies the minimum heap size for the adapter JVM.

Possible Value: The valid JVM heap size.

Default Value: 536870912.

This parameter is for Microsoft Windows only.

service_min_heap_size=536870912

service_num_vm_args

Specifies the number of service_vm_argnumber parameters specified in JVM.

Possible Value: The number of service_vm_argnumber parameters.

Default Value: None.

This parameter is for Microsoft Windows only.

service_num_vm_args=1

service_path

Specifies the environment variable PATH. The PATH variable is set before starting the JVM. Typically, list all directories that contain necessary DLLs.

Possible Value: The valid PATH environment variable setting.

Default Value: None.

This parameter is for Microsoft Windows only.

service_path=%JREHOME%\bin;D:\oracle\oraic\bin

service_vm_argnumber

Specifies any additional arguments to the JVM. For example, to retrieve line numbers in any stack traces, set service_vm_arg1=java.compiler=NONE. If a list of arguments exists, then use multiple parameters, by incrementing the last digit by 1.

Possible Value: A valid JVM argument.

Default Value: None.

This parameter is for Microsoft Windows only.

service_vm_arg1=java.compiler= NONE

service_vm_arg2=oai.adapter=.aq


Table A-10 shows the reserved characters used to specify the value of the nls_date_format parameter. Use these reserved characters, to define date formats.

Table A-10 Reserved Characters for the Value of the nls_date_format Parameter

Letter Description Example

G

Era designator

AD

y

Year

1996 or 96

M

Month in year

July or Jul or 07

w

Week in year

27

W

Week in month

2

D

Day in year

189

d

Day in month

10

F

Day of week in month

Number 2

E

Day in week

Tuesday or Tue

a

a.m./p.m. marker

P.M.

H

Hour in day (0-23)

0

k

Hour in day (1-24)

24

K

Hour in a.m./p.m. (0-11)

0

h

Hour in a.m./p.m. (1-12)

12

m

Minute in hour

30

s

Second in minute

55

S

Millisecond

978


EIS Adapter Plugin-Specific Parameters

Table A-11 lists the parameters specific to EIS Adapter Plugin.

Table A-11 EIS Adapter Plugin-Specific Parameters

Parameter Description Example

bridge_class

Specifies the entry class for the OA Adapter. The value cannot be modified later.

Default Value: com.iwaysoftware.iwbridge.IWBridge.

bridge_class=com.iwaysoftware.iwbridge.IWBridge

bridge_rmi_port

Specifies the RMI port the EIS Plugin Bridge is listening on.

Default Value: None.

bridge_rmi_port=2000

ibse_url

Specifies the Business Servlet Engine URL that the EIS Plugin Bridge will make the SOAP request to.

Default Value: None.

ibse_url=http://mpscott-pc:7878/ibse/IBSEServlet