|
Oracle® Application Server Integration InterConnect Adapter for DB Installation and User's Guide
10g Release 2 (10.1.2) Part No. B14076-01 |
|
 Previous |
 Next |
|
Oracle® Application Server Integration InterConnect Adapter for DB Installation and User's Guide
10g Release 2 (10.1.2) Part No. B14076-01 |
|
|
Previous |
Next |
This chapter describes how to install and configure the Database adapter. It contains the following topics:
The Database adapter must be installed in an existing Oracle home Middle Tier for OracleAS Integration InterConnect 10g Release 2 (10.1.2).
This section describes the following topics:
Consult the following guides before installing the Database adapter:
Oracle Application Server Installation Guide for information about Oracle Universal Installer startup.
Oracle Application Server InterConnect Installation Guide for information on mounting CD-ROMs, software, hardware, and system requirements for OracleAS Integration InterConnect.
To install the Database adapter, start the installer and complete the following steps:
In the Available Product Components page of the OracleAS Integration InterConnect installation, select Database adapter, and click Next.
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 Database 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 Database 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.
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 password for the hub database user.
Click Next. The Specify Database Adapter Name page is displayed.
Enter the application name. Blank spaces are not permitted. The default value is myDBApp.
Click Next. The Specify Spoke Database Connection Information page is displayed. Enter information in the following fields:
Host Name: The name of the computer where the application database is installed.
Port Number: The database TNS listener port.
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 the database on the application side from which the adapter will deliver or receive messages. This is not the information for the hub database.
Click Next. The Spoke Application Database Username page is displayed. Enter information in the following fields:
Schema Name: The user name of the user in the Spoke Database.
Password: The password for the user name.
Click Next. The Set Bridge Schema Password page is displayed.
Enter and confirm the password for the bridge schema on the screen.
Click Next. The Summary page is displayed.
Click Install to install the Database adapter and other selected components. The Database 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 you specified in Step 5.
When completing the post-installation steps, no errors should occur. If there are errors, then verify that in the specified database the application using the oai schema is the only occurrence. Errors can occur if a Database adapter from previous version installation is talking to this same database.
After an Database 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 Oracle9i Database Server 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 Database adapter.
Table 2-2 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 2-3 describes the Database adapter configuration files.
Table 2-3 Configuration Files
| File | Description |
|---|---|
adapter.ini (UNIX
|
Consists of all the initialization parameters, which the adapter reads at startup. |
adapter.ini (Windows)
|
Consists of all the initialization parameters, which the adapter reads at startup. |
Table 2-4 describes the directories used by the Database adapter.
Table 2-4 Directories
Adapters do not have integration logic. The Database adapter has a generic transformation engine that uses 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 name 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.
The following are the .ini files used to configure the Database adapter:
The Database adapter connects to the hub database using 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
Oracle Real Application Clusters hub.ini Parameters
When a hub is installed on an Oracle Real Application Clusters database, the parameters listed in Table 2-6 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 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
The Database adapter connects to the spoke application using parameters in the adapter.ini file. 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: Default Value: 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:
Default Value: |
agent_dvm_table_caching=demand
|
| agent_log_level | Specifies the amount of logging necessary.
Possible values:
Default Value: 1. |
agent_log_level=2
|
| agent_lookup_table_caching | Specifies the lookup table caching algorithm.
Possible values:
Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: None. |
agent_message_selector=%,aqapp,%
|
| agent_metadata_caching | Specifies the metadata caching algorithm.
Possible values:
Default Value: |
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 Default Value: |
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 Default Value: |
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 Default Value: |
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: Default Value: |
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: Default Value: |
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=dbapp and instance_number=2, then agent_reply_subscriber_name=dbapp2
|
| 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=dbapp
|
| agent_throughput_measurement_enabled | Specifies if the throughput measurement is enabled. Set this parameter to true to turn on throughput measurements.
Default Value: |
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: |
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 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=dbapp
|
| 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: 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 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 Default Value: 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: |
Date format pattern dd/MMM/yyyy can represent 01/01/2003.
Multiple date formats can be specified as
|
| 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 Default Value: 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: 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 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 Default Value: 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: 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: A 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: A valid JVM heap size. Default Value: 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 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 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
|
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 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
|
Database Adapter-specific Parameters
Table 2-9 lists parameters specific to the Database adapter.
Table 2-9 Database Adapter-specific Parameters
| Parameter | Description | Example |
|---|---|---|
| bridge_class | Indicates the entry class for the Database adapter. Do not modify this value.
Default Value: |
bridge_class=oracle.oai.agent.adapter.db. DBBridge
|
| db_bridge_instance | The SID of the database instance.
Default Value: None. |
db_bridge_instance=orcl
|
| db_bridge_num_schemas | The number of alternate schemas that this database adapter will fail over to.
Possible Values: An integer greater than 0. Default Value: 1. |
db_bridge_num_schemas =1
|
| db_bridge_schema#_host | The name of the computer hosting the database instance specified by the db_bridge_schema#_instance.
Default Value: None. |
db_bridge_schema1_host=ssuravar-sun
|
| db_bridge_schema#_instance | The SID of the database instance.
Possible Value: A valid SID. Default Value: None. |
db_bridge_schema1_instance=oiddb1
|
| db_bridge_schema#_num_readers | 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.
Possible Value: An integer greater than 0. Default Value: None. |
db_bridge_schema1_num_readers=1
|
| db_bridge_schema#_num_writers | 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.
Possible Values: An integer greater than 0. Default Value: None. |
db_bridge_schema1_num_writers=1
|
| db_bridge_schema#_password | The password for the user specified in the db_bridge_schemaschema#_username.
Possible value: The password for the corresponding database user. Default Value: None. |
db_bridge_schema1_password=oai
|
| db_bridge_schema#_port | The port where the TNS listener is running for the database instance specified by db_bridge_schema#_instance parameter.
Possible Value: A valid TNS listener port number. Default Value: None. |
db_bridge_schema1_port=1521
|
| db_bridge_schema#_username | The user name for the schema number schema#. The possible values for the schema number are 1 through db_bridge_num_schemas. This value should not be modified.
Possible value: A valid database user name Default Value: None. |
db_bridge_schema1_username=oai
|
| db_bridge_schema#_writer_password | The password corresponding to the database user specified in Oracle Wallet by the db_bridge_schema#_writer_username parameter.
Possible Values: A valid password. 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. |
db_bridge_schema1_writer_password=welcome
|
| db_bridge_schema#_writer_use_oracle_objects | Specifies whether to use Oracle Objects, available in Oracle8 and later releases. Set this to true unless talking to an Oracle 7.x database.
Possible Values: Default Value: |
db_bridge_schema1_writer_use_oracle_objects=true
|
| db_bridge_schema#_writer_username | The user name to be used by this writer to log on to the database as specified by the db_bridge_schema#_instance parameter.
Possible Values: A valid database user. Default Value: None. |
db_bridge_schema1_writer_username=mydbapp
|
| db_bridge_sql_ trace | Used to enable or disable the SQL trace facility for all reader and writer database sessions. Setting this to true results in the SQL query ALTER SESSION SET SQL_TRACE = TRUE being run in the session, thus enabling the SQL trace facility. For more information on the SQL trace facility, including how to format and interpret the output, refer to the Oracle Tuning Guide.
Possible Values: Default Value: |
db_bridge_sql_trace= true
|
| db_bridge_use_thin_jdbc | Indicates whether to use a thin JDBC driver when talking to the database.
Possible Values: Default Value: |
db_bridge_thin_jdbc=true
|
Real Application Clusters adapter.ini Parameters for the DB Adapter When the Database adapter is servicing a Real Application Clusters database as the spoke database, parameters listed in Table 2-10 represent information on connection and configuration.
Table 2-10 Real Application Clusters adapter.ini Parameters
| Parameter | Description | Example |
|---|---|---|
| db_bridge_num_nodes | Indicates the number of nodes in RAC cluster. | db_bridge_num_nodes=4
|
| db_bridge_schema1_hostx | Indicates host for the node x. | db_bridge_schema1_host2=dsunram13
|
| db_bridge_schema1_instancex | Indicates instance on node x. | db_bridge_schema1_instance2=orcl2
|
| db_bridge_schema1_portx | Indicates port for node x. | db_bridge_schema1_port2=1421
|
