2 Installation and Configuration

This chapter describes how to install and configure the OA adapter. It contains the following topics:

• Installing the OA Adapter

• Configuring the OA adapter

2.1 Installing the OA Adapter

The OA adapter 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

• Installation Tasks

2.1.1 Preinstallation Tasks

Consult the following guides before installing the OA adapter:

• Oracle Application Server Installation Guide for information about OUI startup.

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

  
  

  Note: OracleAS Integration InterConnect hub is installable through the OracleAS Integration InterConnect hub installation type. You must install the OracleAS Integration InterConnect hub before proceeding with the OA adapter installation.

  
  

2.1.2 Installation Tasks

To install the OA adapter:

1. On the Available Product Components page of the OracleAS Integration InterConnect installation, select OA adapter, and click Next.

2. The Set Oracle Wallet Password screen is displayed. 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 the OA adapter 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 the OA adapter 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 page 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 SID for the hub database.

   • Password: The password for the hub database user.

4. Click Next. The Specify Oracle Applications Adapter Name page is displayed.

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

6. Click Next. The Specify Spoke Application Database Connection page is displayed. This configures the information to the spoke application database. Enter information in the following fields:

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

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

   • Database SID: The SID for the application database.

   • Sys Password: The password of the sys user in the spoke database.

   The information on this page is for Oracle Applications, from which the adapter will deliver or receive messages.

7. Click Next. The Specify APPS Schema Password page is displayed. Enter the password for the APPS schema name.

8. Click Next. The Set Bridge Schema Password page is displayed.

9. Enter and confirm the password for the bridge schema on the screen.

10. Click Next. The Summary page is displayed.

11. Click Install to install the OA adapter and other selected components. The OA adapter is installed in the following directory:

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

    
    

    Application is the value specified in Step 5.

12. Click Exit on the Installation page to exit the OA adapter installation.

2.2 Configuring the OA adapter

After an OA adapter installation, you can configure it for your needs. The following tables describe the location and details of the configuration files.

Table 2-1 describes the location where the adapter is installed.

Table 2-1 OA Adapter Directory

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

Table 2-2 describes the various executable files available for the OA adapter.

Table 2-2 OA Executable Files

File	Description
start (UNIX)	Does not take parameters, starts the adapter.
start.bat (Windows)	Does not take parameters, starts the adapter.
stop (UNIX)	Does not take parameters, stops the adapter.
stop.bat (Windows)	Does not take parameters, stops the adapter.

Table 2-3 describes the OA adapter configuration files.

Table 2-3 OA Configuration Files

File	Description
adapter.ini (UNIX)	Consists of all the initialization parameters that the adapter reads at startup.
adapter.ini (Windows)	Consists of all the initialization parameters that the adapter reads at startup.

Table 2-4 describes the directories used by the OA adapter.

Table 2-4 OA Directories

Directory	Description
logs	The logging of adapter activity is done in subdirectories of the logs directory. Each new run of the adapter creates a new subdirectory in which logging is done in an oailog.txt file.
persistence	The messages are persisted (made available) in this directory. Do not edit this directory or its files.

2.2.1 Ini File Settings

The following are the .ini files used to configure the OA adapter:

• hub.ini Parameters

• adapter.ini Parameters

2.2.1.1 hub.ini Parameters

The OA adapter connects to the hub database using the parameters in the hub.ini file located in the hub directory. Table 2-5 lists the parameter names, descriptions for each parameter, and examples.

Table 2-5 hub.ini Parameters

Parameter	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). The default value is ichub.	hub_username=ichub
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

When a hub is installed on a Oracle Real Application Cluster database, the parameters listed in Table 2-6 represent information about additional nodes used for connection and configuration. These parameters are in addition to the default parameters for the primary node. In Table 2-6, x represents the node number. The number is between 2 and the number of nodes. For example, if the cluster contains 4 nodes, then x can be a value between 2 and 4.

Table 2-6 Oracle 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

2.2.1.2 adapter.ini Parameters

The agent component of the OA adapter reads the adapter.ini file at runtime to access information on configuring the OA adapter parameter. Table 2-7 lists the parameter names, descriptions for each parameter, and examples.

Table 2-7 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 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 (like '%,aqapp,%'). 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 the 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 the 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=oaapp and instance_number=2, then agent_reply_subscriber_name=oaapp2
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=oaapp
agent_throughput_measurement_enabled	Specifies if the throughput measurement is enabled. Set this parameter to true to turn on throughput measurements. 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. 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=oaapp
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	Specify the base URL for loading external enitites and DTDs.This specifies to 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 2-8 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 date format and is applicable for the date format only.	nls_language=en
partition	Specifies the partition this adapter handles as specified 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 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 Java Virtual Machine (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 as shown in the example, by incrementing the last digit by 1. Possible Value: A valid JVM arguments. Default Value: None. This parameter is for Microsoft Windows only.	service_vm_arg1=java.compiler= NONE service_vm_arg2=oai.adapter=.aq

Table 2-8 shows the reserved characters used to specify the value of the nls_date_format parameter. Use the characters to define date formats.

Table 2-8 Reserved Characters for 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

OA Adapter-specific Parameters

Table 2-9 lists the parameters specific to the OA adapter.

Table 2-9 OA Adapter-specific Parameters

Parameter	Description	Example
bridge_class	Specifies the entry class for the OA adapter. The value cannot be modified later. Default Value: oracle.oai.agent.adapter.ebs.EBSBridge.	bridge_class=oracle.oai.agent.adapter.ebs. EBSBridge
ebs_aq_bridge_consumer_name	If all the queues that this adapter will connect to on the application database side are single consumer queues, this can be left blank. If, however, any of the queues is a multiconsumer queue, then specify a consumer name. Possible Value: ebs_bridge_username. Default Value: None.	ebs_aq_bridge_consumer_name=ebsuser
ebs_aq_bridge_owner	Specifies application (spoke) database queue (applicable for XML Gateway, WF Queue, and Custom Queue only). Default Value: None.	ebs_aq_bridge_owner=apps
ebs_bridge_schema_host	Specifies the name of the computer hosting the database instance. Possible Value: The name of the computer hosting the database. Default Value: None.	ebs_bridge_schema_host=dlsun4255
ebs_bridge_schema_instance	Specifies the SID of the database instance. Default Value: None.	ebs_bridge_schema_instance=oaimain
ebs_bridge_schema_num_readers	Specifies the number of database readers corresponding to the schema number. This is the same as the number of reader threads and each thread has its own database session. Possible Values: An integer greater than 0. Default Value: None.	ebs_bridge_schema_num_readers=1
ebs_bridge_schema_num_writers	Specifies the number of database writers corresponding to the schema number. This is same as the number of writer threads and each thread has its own database session. Possible Values: An integer greater than 0. Default Value: None.	ebs_bridge_schema_num_writers=1
ebs_bridge_schema_password	Specifies the password for the user in the ebs_bridge_schemaschema#_username. Possible Value: The password for the corresponding database user. Default Value: None. Note: All passwords are stored in Oracle Wallet. Refer to "How do I secure my passwords?" for more details on how to modify and retrieve the password using Oracle Wallet.	ebs_bridge_schema1_password=oai encrypted_ebs_bridge_schema1_password=112511011064109110871093
ebs_bridge_schema_port	Specifies the port where the TNS listener is running for the database instance. Possible Value: A valid TNS listener port number. Default Value: None.	ebs_bridge_schema_port=1521
ebs_bridge_schema_username	Specifies the user name for the schema number schema#. The values for the schema number are 1 through ebs_bridge_num_schemas. This value should not be modified. Possible Values: A valid database user name. Default Value: None.	ebs_bridge_schema1_username=oai
ebs_bridge_schema_writer_password	Specifies the password corresponding to the database. Default Value: None.	ebs_bridge_schema_writer_password=apps
ebs_bridge_schema_writer_use_oracle_objects	Specifies whether to use Oracle Objects, available in Oracle8i and later releases. Possible Values: true or false. The default value is false.	ebs_bridge_schema1_writer_use_oracle_objects=true
ebs_bridge_schema_writer_username	Specifies the user name to be used by this writer to log on to the database. Default Value: None.	ebs_bridge_schema_writer_username=apps
ebs_bridge_sql_ trace	Specifies whether to turn sql tracing on for the APPS database. Possible Values: true or false. Default Value: false.	ebs_bridge_sql_trace =true
ebs_bridge_use_thin_jdbc	Specifies whether to use a thin JDBC driver when talking to the APPS database. Possible Values: true or false. Default Value: true.	EBS_bridge_thin_jdbc=true