|
Oracle® Application Server InterConnect Adapter for Oracle Applications Installation and User's Guide
10g (9.0.4.0.2) Part No. B14114-01 |
|
 Previous |
 Next |
|
Oracle® Application Server InterConnect Adapter for Oracle Applications Installation and User's Guide
10g (9.0.4.0.2) Part No. B14114-01 |
|
|
Previous |
Next |
This chapter describes the installation and configuration of the OA adapter. This chapter contains the following topics:
The OA adapter must be installed in one of the following Oracle homes:
An existing Oracle home for OracleAS InterConnect 10g (9.0.4.0.2).
A new Oracle home. Oracle Universal Installer (OUI) creates this Oracle home.
This section contains the following topics:
Consult the following guides before installing the OA adapter:
Oracle10g Application Server Installation Guide for information about OUI startup.
Oracle Application Server InterConnect Installation Guide, for information about mounting CD-ROMs, listing software, hardware, and system requirements for OracleAS InterConnect, and installing OracleAS InterConnect.
|
Note: OracleAS InterConnect hub is installable through the OracleAS InterConnect hub installation type. You must install the OracleAS InterConnect hub before proceeding with the OA adapter installation. |
To install the OA adapter:
On the Available Product Components page of the OracleAS InterConnect installation, select OA adapter, and click Next.
The OracleAS InterConnect Database configuration page is displayed. Enter information in the following fields:
Host Name - The host name of the machine 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.
Click Next. The Oracle Applications Adapter configuration page is displayed. Enter the application name. Blank spaces are not permitted. The default value is myOAApp.
Click Next. The Oracle Applications Database - Specify Database Connection Information page is displayed. This configures the information to the spoke application database. Enter information in the following fields:
Host Name - The name of the machine where the application database is installed.
Port Number - The TNS listener port for the application database.
Database SID - The SID for the application database.
The information on this page is for Oracle Applications, from which the adapter will deliver or receive messages.
Click Next. The Oracle Applications Database - Specify APPS Schema Password page is displayed. Enter the password for the APPS schema name.
Click Next. The Summary page is displayed.
Click Install to install the OA adapter and other selected components. The OA adapter is installed in the following directory:
| Platform | Directory |
|---|---|
| Windows | ORACLE_HOME\oai\9.0.4\adapters\Application
|
| UNIX | ORACLE_HOME/oai/9.0.4/adapters/Application
|
Application is the value specified in Step 3.
Click Exit on the Installation page to exit the OA adapter installation.
After installation, a set of post-installation steps is displayed. These steps are also copied to the post-installation.txt file in the OA adapter directory.
|
Note: The defaultsys password is change_on_install unless otherwise specified during installation.
|
To create the schema used by the OA adapter, complete the following tasks:
Access the directory where the OA adapter is installed.
Execute the following for the correct database version:
| Database Version | Code to Execute |
|---|---|
| Oracle8i | oaischema -create -8i sys/[password] [tnsname]
|
| Oracle9i | oaischema -create sys/[password] [tnsname]
|
where:
password—The password for the system user.
tnsname—The tnsname for the Oracle OA instance.
Table 2-1 describes the location where the adapter is installed.
Table 2-1 OA Adapter Directory
| Platform | Directory |
|---|---|
| UNIX | ORACLE_HOME/oai/9.0.4/adapters/Application
|
| Windows | ORACLE_HOME\oai\9.0.4\adapters\Application
|
Table 2-2 describes the various executable files available for the OA adapter.
Table 2-2 OA Executable Files
Table 2-3 describes the OA adapter configuration files.
Table 2-3 OA Configuration Files
| File | Description |
|---|---|
ErrorCodes.ini (Windows and UNIX)
|
Contains one error code per line |
adapter.ini (Windows and UNIX)
|
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
The OA adapter connects to the hub database using the parameters from the hub.ini file. Table 2-5 lists the parameter name, description, and an example for each parameter.
Table 2-5 Hub.ini Parameters
| Parameter | Description | Example |
|---|---|---|
| hub_username | The name of the hub database schema (or username). The default value is oaihub904.
|
hub_username=oaihub904
|
| hub_password | The password for the hub database user. There is no default value. The value is set during installation. | hub_password=manager
|
| hub_host | The name of the machine 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
|
| repository_name | The name of the repository that communicates with the adapter. The default value is InterConnectRepository.
|
repository_name=InterConnectRepository
|
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, x can be a value between 2 and 4.
Table 2-6 Oracle Real Application Clusters Hub.ini Parameters
| Parameter | Description | Example |
|---|---|---|
| hub_num_nodes | Number of nodes in Real Application Clusters. | hub_num_nodes=4
|
| hub_hostx | The host where the Real Application Clusters database is installed. | hub_host2=dsunram13
|
| hub_instancex | The instance on the respective node. | hub_instance2=orcl2
|
| hub_portx | The port on which the TNS listener is listening. | hub_port2=1521
|
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 name, the description, and an example for each parameter.
Table 2-7 Agent Connection Parameters
| Parameter | Description | Example |
|---|---|---|
| application | Specifies the name of the application to which the adapter connects. This must match with the name specified in iStudio while creating metadata. Use any alphanumeric string. There is no default value. | application=Ebizapp
|
| partition | Specifies the partition the adapter handles as specified in iStudio. Use any alphanumeric string. There is no default value. | partition=germany
|
| instance_number | Specifies the instance number to which the adapter corresponds. Specify a value only if you want to have multiple adapter instances for the given application with the given partition. Use any integer greater than or equal to 1. There is no default value.
|
instance_number=1
|
| agent_log_level | Specifies the amount of logging necessary. Possible values are:
The default value is |
agent_log_level=2
|
| agent_subscriber_name | Specifies the subscriber name used when the adapter registers its subscription. The possible value is a valid Oracle Advanced Queue subscriber name. There is no default value. | agent_subscriber_name=Ebizapp
|
| agent_message_selector | Specifies conditions for message selection when the adapter registers its subscription with the hub. The possible value is a valid Oracle Advanced Queue message selector string (like '%,aqapp,%'). There is no default value.
|
agent_message_selector=%,Ebizapp,%
|
| 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. The possible value is the application name (parameter:application) concatenated with the instance number (parameter:instance_number). There is no default value.
|
If application=Ebizapp and instance_number=2, then agent_reply_subscriber_name=Ebizapp2
|
| agent_reply_message_selector | Specifies the application instance to which the reply must be sent. Used only if multiple adapter instances exist for the given application and given partition. The value is a string built using the application name (parameter:application) concatenated with the instance number (parameter:instance_number). There is no default value.
|
If application=Ebizapp and instance_number=2, then agent_reply_message_selector=recipient_list, like '%,Ebizapp2,%'
|
| agent_tracking_enabled | Specifies if message tracking is enabled. Set this parameter to false to turn off all tracking of messages. Set this parameter to true to track messages with tracking fields set in iStudio. The default value is true.
|
agent_tracking_enabled=true
|
| agent_throughput_measurement_enabled | Specifies if the throughput measurement is enabled. Set this parameter to false to turn off all throughput measurements. The default value is true.
|
agent_throughput_measurement_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 InterConnect DTD for all messages sent to the hub.
Set this parameter to |
agent_use_custom_hub_dtd=false
|
| agent_metadata_caching | Specifies the metadata caching algorithm. The values are:
The default value is |
agent_metadata_caching=demand
|
| agent_dvm_table_caching | Specifies the Domain Value Mapping (DVM) table caching algorithm. Possible values are:
The default value is |
agent_dvm_table_caching=demand
|
| agent_lookup_table_caching | Specifies the lookup table caching algorithm. The values are:
The default value is |
agent_lookup_table_caching=demand
|
| agent_delete_file_cache_at_startup | Specifies whether the agent should delete the file cache when it starts. With any of the agent caching methods enabled, metadata from the repository is cached locally on the file system. Set this parameter to true to delete all cached metadata on startup. The values are true or false. The default value is 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_max_ao_cache_size | Specifies the maximum number of application object metadata to cache. The value is any integer greater than or equal to 1. The default value is 200.
|
agent_max_ao_cache_size=200
|
| agent_max_co_cache_size | Specifies the maximum number of common object metadata to cache. The value is any integer greater than or equal to 1. The default value is 100.
|
agent_max_co_cache_size=100
|
| agent_max_message_metadata_cache_size | Specifies the maximum number of message metadata (publish/subscribe and invoke/implement) to cache. The value is any integer greater than or equal to 1. The default value is 200.
|
agent_max_message_metadata_cache_size=200
|
| agent_max_dvm_table_cache_size | Specifies the maximum number of DVM tables to cache. Possible value is any integer greater than or equal to 1. The default value is 200.
|
agent_max_dvm_table_cache_size=200
|
| agent_max_lookup_table_cache_size | Specifies the maximum number of lookup tables to cache. The values is any integer greater than or equal to 1. The default value is 200.
|
agent_max_lookup_table_cache_size=200
|
| agent_max_queue_size | Specifies the maximum size to which internal OracleAS InterConnect message queues can grow. The value is any integer greater than or equal to 1. The default value is 1000.
|
agent_max_queue_size=1000
|
| agent_persistence_queue_size | Specifies the maximum size of internal OracleAS InterConnect persistence queues. The value is any integer greater than or equal to 1. The default value is 1000.
|
agent_persistence_queue_size=1000
|
| agent_persistence_cleanup_interval | Specifies how often to run the persistence cleaner thread in milliseconds. The value is any integer greater than or equal to 30000 milliseconds. The default value is 60000.
|
agent_persistence_cleanup_interval=60000
|
| agent_persistence_retry_interval | Specifies how often the persistence thread retries when it fails to send an OracleAS InterConnect message. The value is any integer greater than or equal to 5000 milliseconds. The default value is 60000.
|
agent_persistence_retry_interval=60000
|
| agent_pipeline_to_hub | Specifies whether to turn on or off the pipeline for messages from the bridge to the hub. If you set the pipeline to false, the the file persistence is not used in that direction.
|
agent_pipeline_to_hub=false
|
| agent_pipeline_from_hub | Specifies whether to turn on or off 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.
|
agent_pipeline_from_hub=false
|
| service_path | Specifies the value to which the environment variable PATH is to be set. The PATH variable is set to the specified value before starting the Java VM. Typically, list all directories here that contain necessary DLLs. Possible value is the valid PATH environment variable setting. There is no default value.
This parameter is for Windows only. |
service_path=%JREHOME%\bin;D:\oracle\ora904\bin
|
| service_classpath | Specifies the class path used by the adapter Java VM. If a custom adapter is developed and, as a result, the adapter is to pick up any additional jars, add the jars to the existing set of jars being picked up. Possible values are the valid class path. There is no default value.
This parameter is for Windows only. |
service_classpath=D:\oracle\ora904\oai\904\lib\oai.jar;D:\oracle\ora904\jdbc\classes12.zip
|
| service_class | Specifies the entry class for the Windows service. A possible value is oracle/oai/agent/service/AgentService. There is no default value.
This parameter is for Windows only. |
service_class=oracle/oai/agent/ service/AgentService
|
| service_max_java_stack_size | Specifies the maximum size that the Java VM's stack can grow. The possible value is the valid Java VM maximum native stack size. The default value is same as the default value for the Java VM.
This parameter is for Windows only. |
service_max_java_stack_size=409600
|
| service_max_native_stack_size | Specifies the maximum size that the Java VM's native stack can grow. The possible value is the valid Java VM maximum native stack size. The default value is same as the default value for the Java VM.
This parameter is for Windows only. |
service_max_native_stack_size=131072
|
| service_min_heap_size | Specifies the minimum heap size for the adapter Java VM. The possible value is any valid Java VM heap sizes. The default value is 536870912.
This parameter is for Windows only. |
service_min_heap_size=536870912
|
| service_max_heap_size | Specifies the maximum heap size for the adapter Java VM. The possible value is any valid Java VM heap sizes. The default value is 536870912.
This parameter is for Windows only. |
service_max_heap_size=536870912
|
| service_num_vm_args | Specifies the number of service_vm_argnumber parameters specified in Java VM. The possible value is the number of service_vm_argnumber parameters. There is no default value.
This parameter is for Windows only. |
service_num_vm_args=1
|
| service_vm_argnumber | Specifies any additional arguments to the Java VM. For example, to retrieve line numbers in any of the stack traces, set service_vm_arg1=java.compiler=NONE. If a list of arguments exists, use multiple parameters as shown in the example, by incrementing the last digit starting with 1. Set the service_num_vm_args parameter correctly. Possible value is any valid Java VM arguments. There is no default value.
This parameter is for Windows only. |
service_vm_arg1=java.compiler=NONE
|
| encoding | Specifies the character encoding for published messages. The adapter uses this parameter to generate encoding information in the encoding tag of transformed OracleAS InterConnect messages. OracleAS InterConnect represents messages internally as an XML document. The default encoding of the XML document is UTF-8. However, this encoding can be configured using this parameter, which is typically used when the OracleAS InterConnect message consists of characters not supported by UTF-8 and when the XMLParser is unable to handle them.
|
encoding=JA16SJIS
|
| nls_date_format | Specifies the format for date fields expressed as string. The default date format is EEE MMM dd HH:mm:ss zzz yyyy. For the meaning of this string, refer to the list of reserved characters in Table 2-8.
|
Date format pattern DD/MM/YYYY can represent 01/01/2003.
Multiple date formats can be specified as
|
| nls_country | This parameter is a valid ISO country code. These codes are defined by ISO-3166. A full list of the codes is available at a Web site, such as, http://www.chemie.fu-berlin.de/diverse/doc/ISO_3166.html
The default country code is Note: This parameter specifies the date format. It is applicable for the date format only. |
nls_country=US
|
| nls_language | This parameter is a valid ISO language code. These codes are defined by ISO-639. A full list of these codes is available at a Web site, such as, http://www.ics.uci.edu/pub/ietf/http/related/iso639.txt
The default language code is Note: This parameter specifies the date format. It is applicable for the date format only. |
nls_language=en
|
Table 2-8 shows the reserved characters used to specify the value of the nls_date_format parameter. Using these characters, you can construct a pattern 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
|
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. The default value is oracle.oai.agent.adapter.ebs.EBSBridge.
|
bridge_class=oracle.oai.agent.adapter.ebs. EBSBridge
|
| ebs_bridge_use_thin_jdbc | Specifies whether to use a thin JDBC driver when talking to the APPS database. The values are true and false. The default is true.
|
EBS_bridge_thin_jdbc=true
|
| ebs_bridge_sql_ trace | Specifies whether to turn sql tracing on for the APPS database. The values are true or false; the default value is false.
|
ebs_bridge_sql_trace =true
|
| ebs_bridge_schema_username | Specifies the username 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 are any valid database user name and there is no default value.
|
ebs_bridge_schema1_username=oai
|
| ebs_bridge_schema_password | Specifies the password for the user in the ebs_bridge_schema<schema#>_username. The value is the password for the corresponding database user. There is no default value.
|
ebs_bridge_schema1_password=oai
|
| ebs_bridge_schema_host | Specifies the name of the machine hosting the database instance. The value is the name of the machine hosting the database. There is no default value. | ebs_bridge_schema_host=dlsun4255
|
| ebs_bridge_schema_port | Specifies the port where the TNS listener is running for the database instance. The possible value is any valid TNS listener port number. There is no default value. | ebs_bridge_schema_port=1521
|
| ebs_bridge_schema_instance | Specifies the SID of the database instance. The value is any valid SID. There is no default value. | 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; each thread has its own database session. The values are any integer greater than 0. There is no default value. | 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; each thread has its own database session. The values are any integer greater than 0. There is no default value. | ebs_bridge_schema_num_writers=1
|
| ebs_bridge_schema_writer_username | Specifies the username to be used by this writer to log on to the database. There is no default value. | ebs_bridge_schema_writer_username=apps
|
| ebs_bridge_schema_writer_password | Specifies the password corresponding to the database. There is no default value. | 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.The values are true or false. The default value is false.
|
ebs_bridge_schema1_writer_use_oracle_objects=true
|
| ebs_aq_bridge_owner | Specifies application (spoke) database queue (applicable for XML Gateway, WF Queue, and Custom Queue only). | ebs_aq_bridge_owner=apps
|
| 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. The possible value is the same as the ebs_bridge_username. There is no default value. | ebs_aq_bridge_consumer_name=ebsuser
|
